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);
1491 * @defgroup UI-Mirroring Selective Widget mirroring
1493 * These functions allow you to set ui-mirroring on specific
1494 * widgets or the whole interface. Widgets can be in one of two
1495 * modes, automatic and manual. Automatic means they'll be changed
1496 * according to the system mirroring mode and manual means only
1497 * explicit changes will matter. You are not supposed to change
1498 * mirroring state of a widget set to automatic, will mostly work,
1499 * but the behavior is not really defined.
1505 * Get the system mirrored mode. This determines the default mirrored mode
1508 * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1510 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1513 * Set the system mirrored mode. This determines the default mirrored mode
1516 * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1518 EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1521 * Returns the widget's mirrored mode setting.
1523 * @param obj The widget.
1524 * @return mirrored mode setting of the object.
1527 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1530 * Sets the widget's mirrored mode setting.
1531 * When widget in automatic mode, it follows the system mirrored mode set by
1532 * elm_mirrored_set().
1533 * @param obj The widget.
1534 * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1536 EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1543 * Set the style to use by a widget
1545 * Sets the style name that will define the appearance of a widget. Styles
1546 * vary from widget to widget and may also be defined by other themes
1547 * by means of extensions and overlays.
1549 * @param obj The Elementary widget to style
1550 * @param style The style name to use
1552 * @see elm_theme_extension_add()
1553 * @see elm_theme_extension_del()
1554 * @see elm_theme_overlay_add()
1555 * @see elm_theme_overlay_del()
1559 EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1561 * Get the style used by the widget
1563 * This gets the style being used for that widget. Note that the string
1564 * pointer is only valid as longas the object is valid and the style doesn't
1567 * @param obj The Elementary widget to query for its style
1568 * @return The style name used
1570 * @see elm_object_style_set()
1574 EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1577 * @defgroup Styles Styles
1579 * Widgets can have different styles of look. These generic API's
1580 * set styles of widgets, if they support them (and if the theme(s)
1583 * @ref general_functions_example_page "This" example contemplates
1584 * some of these functions.
1588 * Set the disabled state of an Elementary object.
1590 * @param obj The Elementary object to operate on
1591 * @param disabled The state to put in in: @c EINA_TRUE for
1592 * disabled, @c EINA_FALSE for enabled
1594 * Elementary objects can be @b disabled, in which state they won't
1595 * receive input and, in general, will be themed differently from
1596 * their normal state, usually greyed out. Useful for contexts
1597 * where you don't want your users to interact with some of the
1598 * parts of you interface.
1600 * This sets the state for the widget, either disabling it or
1605 EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1608 * Get the disabled state of an Elementary object.
1610 * @param obj The Elementary object to operate on
1611 * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1612 * if it's enabled (or on errors)
1614 * This gets the state of the widget, which might be enabled or disabled.
1618 EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1621 * @defgroup WidgetNavigation Widget Tree Navigation.
1623 * How to check if an Evas Object is an Elementary widget? How to
1624 * get the first elementary widget that is parent of the given
1625 * object? These are all covered in widget tree navigation.
1627 * @ref general_functions_example_page "This" example contemplates
1628 * some of these functions.
1632 * Check if the given Evas Object is an Elementary widget.
1634 * @param obj the object to query.
1635 * @return @c EINA_TRUE if it is an elementary widget variant,
1636 * @c EINA_FALSE otherwise
1637 * @ingroup WidgetNavigation
1639 EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1642 * Get the first parent of the given object that is an Elementary
1645 * @param obj the Elementary object to query parent from.
1646 * @return the parent object that is an Elementary widget, or @c
1647 * NULL, if it was not found.
1649 * Use this to query for an object's parent widget.
1651 * @note Most of Elementary users wouldn't be mixing non-Elementary
1652 * smart objects in the objects tree of an application, as this is
1653 * an advanced usage of Elementary with Evas. So, except for the
1654 * application's window, which is the root of that tree, all other
1655 * objects would have valid Elementary widget parents.
1657 * @ingroup WidgetNavigation
1659 EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1662 * Get the top level parent of an Elementary widget.
1664 * @param obj The object to query.
1665 * @return The top level Elementary widget, or @c NULL if parent cannot be
1667 * @ingroup WidgetNavigation
1669 EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1672 * Get the string that represents this Elementary widget.
1674 * @note Elementary is weird and exposes itself as a single
1675 * Evas_Object_Smart_Class of type "elm_widget", so
1676 * evas_object_type_get() always return that, making debug and
1677 * language bindings hard. This function tries to mitigate this
1678 * problem, but the solution is to change Elementary to use
1679 * proper inheritance.
1681 * @param obj the object to query.
1682 * @return Elementary widget name, or @c NULL if not a valid widget.
1683 * @ingroup WidgetNavigation
1685 EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1688 * @defgroup Config Elementary Config
1690 * Elementary configuration is formed by a set options bounded to a
1691 * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1692 * "finger size", etc. These are functions with which one syncronizes
1693 * changes made to those values to the configuration storing files, de
1694 * facto. You most probably don't want to use the functions in this
1695 * group unlees you're writing an elementary configuration manager.
1699 EAPI double elm_scale_get(void);
1700 EAPI void elm_scale_set(double scale);
1701 EAPI void elm_scale_all_set(double scale);
1704 * Save back Elementary's configuration, so that it will persist on
1707 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1710 * This function will take effect -- thus, do I/O -- immediately. Use
1711 * it when you want to apply all configuration changes at once. The
1712 * current configuration set will get saved onto the current profile
1713 * configuration file.
1716 EAPI Eina_Bool elm_mirrored_get(void);
1717 EAPI void elm_mirrored_set(Eina_Bool mirrored);
1720 * Reload Elementary's configuration, bounded to current selected
1723 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1726 * Useful when you want to force reloading of configuration values for
1727 * a profile. If one removes user custom configuration directories,
1728 * for example, it will force a reload with system values insted.
1731 EAPI Eina_Bool elm_config_save(void);
1732 EAPI void elm_config_reload(void);
1739 * @defgroup Profile Elementary Profile
1741 * Profiles are pre-set options that affect the whole look-and-feel of
1742 * Elementary-based applications. There are, for example, profiles
1743 * aimed at desktop computer applications and others aimed at mobile,
1744 * touchscreen-based ones. You most probably don't want to use the
1745 * functions in this group unlees you're writing an elementary
1746 * configuration manager.
1752 * Get Elementary's profile in use.
1754 * This gets the global profile that is applied to all Elementary
1757 * @return The profile's name
1760 EAPI const char *elm_profile_current_get(void);
1763 * Get an Elementary's profile directory path in the filesystem. One
1764 * may want to fetch a system profile's dir or an user one (fetched
1767 * @param profile The profile's name
1768 * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
1769 * or a system one (@c EINA_FALSE)
1770 * @return The profile's directory path.
1773 * @note You must free it with elm_profile_dir_free().
1775 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1778 * Free an Elementary's profile directory path, as returned by
1779 * elm_profile_dir_get().
1781 * @param p_dir The profile's path
1785 EAPI void elm_profile_dir_free(const char *p_dir);
1788 * Get Elementary's list of available profiles.
1790 * @return The profiles list. List node data are the profile name
1794 * @note One must free this list, after usage, with the function
1795 * elm_profile_list_free().
1797 EAPI Eina_List *elm_profile_list_get(void);
1800 * Free Elementary's list of available profiles.
1802 * @param l The profiles list, as returned by elm_profile_list_get().
1806 EAPI void elm_profile_list_free(Eina_List *l);
1809 * Set Elementary's profile.
1811 * This sets the global profile that is applied to Elementary
1812 * applications. Just the process the call comes from will be
1815 * @param profile The profile's name
1819 EAPI void elm_profile_set(const char *profile);
1822 * Set Elementary's profile.
1824 * This sets the global profile that is applied to all Elementary
1825 * applications. All running Elementary windows will be affected.
1827 * @param profile The profile's name
1831 EAPI void elm_profile_all_set(const char *profile);
1838 * @defgroup Engine Elementary Engine
1840 * These are functions setting and querying which rendering engine
1841 * Elementary will use for drawing its windows' pixels.
1843 * The following are the available engines:
1844 * @li "software_x11"
1847 * @li "software_16_x11"
1848 * @li "software_8_x11"
1851 * @li "software_gdi"
1852 * @li "software_16_wince_gdi"
1854 * @li "software_16_sdl"
1863 * @brief Get Elementary's rendering engine in use.
1865 * @return The rendering engine's name
1866 * @note there's no need to free the returned string, here.
1868 * This gets the global rendering engine that is applied to all Elementary
1871 * @see elm_engine_set()
1873 EAPI const char *elm_engine_current_get(void);
1876 * @brief Set Elementary's rendering engine for use.
1878 * @param engine The rendering engine's name
1880 * This sets global rendering engine that is applied to all Elementary
1881 * applications. Note that it will take effect only to Elementary windows
1882 * created after this is called.
1884 * @see elm_win_add()
1886 EAPI void elm_engine_set(const char *engine);
1893 * @defgroup Fonts Elementary Fonts
1895 * These are functions dealing with font rendering, selection and the
1896 * like for Elementary applications. One might fetch which system
1897 * fonts are there to use and set custom fonts for individual classes
1898 * of UI items containing text (text classes).
1903 typedef struct _Elm_Text_Class
1909 typedef struct _Elm_Font_Overlay
1911 const char *text_class;
1913 Evas_Font_Size size;
1916 typedef struct _Elm_Font_Properties
1920 } Elm_Font_Properties;
1923 * Get Elementary's list of supported text classes.
1925 * @return The text classes list, with @c Elm_Text_Class blobs as data.
1928 * Release the list with elm_text_classes_list_free().
1930 EAPI const Eina_List *elm_text_classes_list_get(void);
1933 * Free Elementary's list of supported text classes.
1937 * @see elm_text_classes_list_get().
1939 EAPI void elm_text_classes_list_free(const Eina_List *list);
1942 * Get Elementary's list of font overlays, set with
1943 * elm_font_overlay_set().
1945 * @return The font overlays list, with @c Elm_Font_Overlay blobs as
1950 * For each text class, one can set a <b>font overlay</b> for it,
1951 * overriding the default font properties for that class coming from
1952 * the theme in use. There is no need to free this list.
1954 * @see elm_font_overlay_set() and elm_font_overlay_unset().
1956 EAPI const Eina_List *elm_font_overlay_list_get(void);
1959 * Set a font overlay for a given Elementary text class.
1961 * @param text_class Text class name
1962 * @param font Font name and style string
1963 * @param size Font size
1967 * @p font has to be in the format returned by
1968 * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
1969 * and elm_font_overlay_unset().
1971 EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
1974 * Unset a font overlay for a given Elementary text class.
1976 * @param text_class Text class name
1980 * This will bring back text elements belonging to text class
1981 * @p text_class back to their default font settings.
1983 EAPI void elm_font_overlay_unset(const char *text_class);
1986 * Apply the changes made with elm_font_overlay_set() and
1987 * elm_font_overlay_unset() on the current Elementary window.
1991 * This applies all font overlays set to all objects in the UI.
1993 EAPI void elm_font_overlay_apply(void);
1996 * Apply the changes made with elm_font_overlay_set() and
1997 * elm_font_overlay_unset() on all Elementary application windows.
2001 * This applies all font overlays set to all objects in the UI.
2003 EAPI void elm_font_overlay_all_apply(void);
2006 * Translate a font (family) name string in fontconfig's font names
2007 * syntax into an @c Elm_Font_Properties struct.
2009 * @param font The font name and styles string
2010 * @return the font properties struct
2014 * @note The reverse translation can be achived with
2015 * elm_font_fontconfig_name_get(), for one style only (single font
2016 * instance, not family).
2018 EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
2021 * Free font properties return by elm_font_properties_get().
2023 * @param efp the font properties struct
2027 EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
2030 * Translate a font name, bound to a style, into fontconfig's font names
2033 * @param name The font (family) name
2034 * @param style The given style (may be @c NULL)
2036 * @return the font name and style string
2040 * @note The reverse translation can be achived with
2041 * elm_font_properties_get(), for one style only (single font
2042 * instance, not family).
2044 EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
2047 * Free the font string return by elm_font_fontconfig_name_get().
2049 * @param efp the font properties struct
2053 EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
2056 * Create a font hash table of available system fonts.
2058 * One must call it with @p list being the return value of
2059 * evas_font_available_list(). The hash will be indexed by font
2060 * (family) names, being its values @c Elm_Font_Properties blobs.
2062 * @param list The list of available system fonts, as returned by
2063 * evas_font_available_list().
2064 * @return the font hash.
2068 * @note The user is supposed to get it populated at least with 3
2069 * default font families (Sans, Serif, Monospace), which should be
2070 * present on most systems.
2072 EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
2075 * Free the hash return by elm_font_available_hash_add().
2077 * @param hash the hash to be freed.
2081 EAPI void elm_font_available_hash_del(Eina_Hash *hash);
2088 * @defgroup Fingers Fingers
2090 * Elementary is designed to be finger-friendly for touchscreens,
2091 * and so in addition to scaling for display resolution, it can
2092 * also scale based on finger "resolution" (or size). You can then
2093 * customize the granularity of the areas meant to receive clicks
2096 * Different profiles may have pre-set values for finger sizes.
2098 * @ref general_functions_example_page "This" example contemplates
2099 * some of these functions.
2105 * Get the configured "finger size"
2107 * @return The finger size
2109 * This gets the globally configured finger size, <b>in pixels</b>
2113 EAPI Evas_Coord elm_finger_size_get(void);
2116 * Set the configured finger size
2118 * This sets the globally configured finger size in pixels
2120 * @param size The finger size
2123 EAPI void elm_finger_size_set(Evas_Coord size);
2126 * Set the configured finger size for all applications on the display
2128 * This sets the globally configured finger size in pixels for all
2129 * applications on the display
2131 * @param size The finger size
2134 EAPI void elm_finger_size_all_set(Evas_Coord size);
2141 * @defgroup Focus Focus
2143 * An Elementary application has, at all times, one (and only one)
2144 * @b focused object. This is what determines where the input
2145 * events go to within the application's window. Also, focused
2146 * objects can be decorated differently, in order to signal to the
2147 * user where the input is, at a given moment.
2149 * Elementary applications also have the concept of <b>focus
2150 * chain</b>: one can cycle through all the windows' focusable
2151 * objects by input (tab key) or programmatically. The default
2152 * focus chain for an application is the one define by the order in
2153 * which the widgets where added in code. One will cycle through
2154 * top level widgets, and, for each one containg sub-objects, cycle
2155 * through them all, before returning to the level
2156 * above. Elementary also allows one to set @b custom focus chains
2157 * for their applications.
2159 * Besides the focused decoration a widget may exhibit, when it
2160 * gets focus, Elementary has a @b global focus highlight object
2161 * that can be enabled for a window. If one chooses to do so, this
2162 * extra highlight effect will surround the current focused object,
2165 * @note Some Elementary widgets are @b unfocusable, after
2166 * creation, by their very nature: they are not meant to be
2167 * interacted with input events, but are there just for visual
2170 * @ref general_functions_example_page "This" example contemplates
2171 * some of these functions.
2175 * Get the enable status of the focus highlight
2177 * This gets whether the highlight on focused objects is enabled or not
2180 EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
2183 * Set the enable status of the focus highlight
2185 * Set whether to show or not the highlight on focused objects
2186 * @param enable Enable highlight if EINA_TRUE, disable otherwise
2189 EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
2192 * Get the enable status of the highlight animation
2194 * Get whether the focus highlight, if enabled, will animate its switch from
2195 * one object to the next
2198 EAPI Eina_Bool elm_focus_highlight_animate_get(void);
2201 * Set the enable status of the highlight animation
2203 * Set whether the focus highlight, if enabled, will animate its switch from
2204 * one object to the next
2205 * @param animate Enable animation if EINA_TRUE, disable otherwise
2208 EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
2211 * Get the whether an Elementary object has the focus or not.
2213 * @param obj The Elementary object to get the information from
2214 * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2215 * not (and on errors).
2217 * @see elm_object_focus_set()
2221 EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2224 * Make a given Elementary object the focused one.
2226 * @param obj The Elementary object to make focused.
2228 * @note This object, if it can handle focus, will take the focus
2229 * away from the one who had it previously and will, for now on, be
2230 * the one receiving input events.
2232 * @see elm_object_focus_get()
2236 EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2239 * Remove the focus from an Elementary object
2241 * @param obj The Elementary to take focus from
2243 * This removes the focus from @p obj, passing it back to the
2244 * previous element in the focus chain list.
2246 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2250 EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2253 * Set the ability for an Element object to be focused
2255 * @param obj The Elementary object to operate on
2256 * @param enable @c EINA_TRUE if the object can be focused, @c
2257 * EINA_FALSE if not (and on errors)
2259 * This sets whether the object @p obj is able to take focus or
2260 * not. Unfocusable objects do nothing when programmatically
2261 * focused, being the nearest focusable parent object the one
2262 * really getting focus. Also, when they receive mouse input, they
2263 * will get the event, but not take away the focus from where it
2268 EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2271 * Get whether an Elementary object is focusable or not
2273 * @param obj The Elementary object to operate on
2274 * @return @c EINA_TRUE if the object is allowed to be focused, @c
2275 * EINA_FALSE if not (and on errors)
2277 * @note Objects which are meant to be interacted with by input
2278 * events are created able to be focused, by default. All the
2283 EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2286 * Set custom focus chain.
2288 * This function overwrites any previous custom focus chain within
2289 * the list of objects. The previous list will be deleted and this list
2290 * will be managed by elementary. After it is set, don't modify it.
2292 * @note On focus cycle, only will be evaluated children of this container.
2294 * @param obj The container object
2295 * @param objs Chain of objects to pass focus
2298 EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2301 * Unset a custom focus chain on a given Elementary widget
2303 * @param obj The container object to remove focus chain from
2305 * Any focus chain previously set on @p obj (for its child objects)
2306 * is removed entirely after this call.
2310 EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2313 * Get custom focus chain
2315 * @param obj The container object
2318 EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2321 * Append object to custom focus chain.
2323 * @note If relative_child equal to NULL or not in custom chain, the object
2324 * will be added in end.
2326 * @note On focus cycle, only will be evaluated children of this container.
2328 * @param obj The container object
2329 * @param child The child to be added in custom chain
2330 * @param relative_child The relative object to position the child
2333 EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2336 * Prepend object to custom focus chain.
2338 * @note If relative_child equal to NULL or not in custom chain, the object
2339 * will be added in begin.
2341 * @note On focus cycle, only will be evaluated children of this container.
2343 * @param obj The container object
2344 * @param child The child to be added in custom chain
2345 * @param relative_child The relative object to position the child
2348 EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2351 * Give focus to next object in object tree.
2353 * Give focus to next object in focus chain of one object sub-tree.
2354 * If the last object of chain already have focus, the focus will go to the
2355 * first object of chain.
2357 * @param obj The object root of sub-tree
2358 * @param dir Direction to cycle the focus
2362 EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2365 * Give focus to near object in one direction.
2367 * Give focus to near object in direction of one object.
2368 * If none focusable object in given direction, the focus will not change.
2370 * @param obj The reference object
2371 * @param x Horizontal component of direction to focus
2372 * @param y Vertical component of direction to focus
2376 EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2379 * Make the elementary object and its children to be unfocusable
2382 * @param obj The Elementary object to operate on
2383 * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2384 * @c EINA_FALSE for focusable.
2386 * This sets whether the object @p obj and its children objects
2387 * are able to take focus or not. If the tree is set as unfocusable,
2388 * newest focused object which is not in this tree will get focus.
2389 * This API can be helpful for an object to be deleted.
2390 * When an object will be deleted soon, it and its children may not
2391 * want to get focus (by focus reverting or by other focus controls).
2392 * Then, just use this API before deleting.
2394 * @see elm_object_tree_unfocusable_get()
2398 EAPI void elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
2401 * Get whether an Elementary object and its children are unfocusable or not.
2403 * @param obj The Elementary object to get the information from
2404 * @return @c EINA_TRUE, if the tree is unfocussable,
2405 * @c EINA_FALSE if not (and on errors).
2407 * @see elm_object_tree_unfocusable_set()
2411 EAPI Eina_Bool elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
2414 * @defgroup Scrolling Scrolling
2416 * These are functions setting how scrollable views in Elementary
2417 * widgets should behave on user interaction.
2423 * Get whether scrollers should bounce when they reach their
2424 * viewport's edge during a scroll.
2426 * @return the thumb scroll bouncing state
2428 * This is the default behavior for touch screens, in general.
2429 * @ingroup Scrolling
2431 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
2434 * Set whether scrollers should bounce when they reach their
2435 * viewport's edge during a scroll.
2437 * @param enabled the thumb scroll bouncing state
2439 * @see elm_thumbscroll_bounce_enabled_get()
2440 * @ingroup Scrolling
2442 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2445 * Set whether scrollers should bounce when they reach their
2446 * viewport's edge during a scroll, for all Elementary application
2449 * @param enabled the thumb scroll bouncing state
2451 * @see elm_thumbscroll_bounce_enabled_get()
2452 * @ingroup Scrolling
2454 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2457 * Get the amount of inertia a scroller will impose at bounce
2460 * @return the thumb scroll bounce friction
2462 * @ingroup Scrolling
2464 EAPI double elm_scroll_bounce_friction_get(void);
2467 * Set the amount of inertia a scroller will impose at bounce
2470 * @param friction the thumb scroll bounce friction
2472 * @see elm_thumbscroll_bounce_friction_get()
2473 * @ingroup Scrolling
2475 EAPI void elm_scroll_bounce_friction_set(double friction);
2478 * Set the amount of inertia a scroller will impose at bounce
2479 * animations, for all Elementary application windows.
2481 * @param friction the thumb scroll bounce friction
2483 * @see elm_thumbscroll_bounce_friction_get()
2484 * @ingroup Scrolling
2486 EAPI void elm_scroll_bounce_friction_all_set(double friction);
2489 * Get the amount of inertia a <b>paged</b> scroller will impose at
2490 * page fitting animations.
2492 * @return the page scroll friction
2494 * @ingroup Scrolling
2496 EAPI double elm_scroll_page_scroll_friction_get(void);
2499 * Set the amount of inertia a <b>paged</b> scroller will impose at
2500 * page fitting animations.
2502 * @param friction the page scroll friction
2504 * @see elm_thumbscroll_page_scroll_friction_get()
2505 * @ingroup Scrolling
2507 EAPI void elm_scroll_page_scroll_friction_set(double friction);
2510 * Set the amount of inertia a <b>paged</b> scroller will impose at
2511 * page fitting animations, for all Elementary application windows.
2513 * @param friction the page scroll friction
2515 * @see elm_thumbscroll_page_scroll_friction_get()
2516 * @ingroup Scrolling
2518 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
2521 * Get the amount of inertia a scroller will impose at region bring
2524 * @return the bring in scroll friction
2526 * @ingroup Scrolling
2528 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
2531 * Set the amount of inertia a scroller will impose at region bring
2534 * @param friction the bring in scroll friction
2536 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2537 * @ingroup Scrolling
2539 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
2542 * Set the amount of inertia a scroller will impose at region bring
2543 * animations, for all Elementary application windows.
2545 * @param friction the bring in scroll friction
2547 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2548 * @ingroup Scrolling
2550 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
2553 * Get the amount of inertia scrollers will impose at animations
2554 * triggered by Elementary widgets' zooming API.
2556 * @return the zoom friction
2558 * @ingroup Scrolling
2560 EAPI double elm_scroll_zoom_friction_get(void);
2563 * Set the amount of inertia scrollers will impose at animations
2564 * triggered by Elementary widgets' zooming API.
2566 * @param friction the zoom friction
2568 * @see elm_thumbscroll_zoom_friction_get()
2569 * @ingroup Scrolling
2571 EAPI void elm_scroll_zoom_friction_set(double friction);
2574 * Set the amount of inertia scrollers will impose at animations
2575 * triggered by Elementary widgets' zooming API, for all Elementary
2576 * application windows.
2578 * @param friction the zoom friction
2580 * @see elm_thumbscroll_zoom_friction_get()
2581 * @ingroup Scrolling
2583 EAPI void elm_scroll_zoom_friction_all_set(double friction);
2586 * Get whether scrollers should be draggable from any point in their
2589 * @return the thumb scroll state
2591 * @note This is the default behavior for touch screens, in general.
2592 * @note All other functions namespaced with "thumbscroll" will only
2593 * have effect if this mode is enabled.
2595 * @ingroup Scrolling
2597 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
2600 * Set whether scrollers should be draggable from any point in their
2603 * @param enabled the thumb scroll state
2605 * @see elm_thumbscroll_enabled_get()
2606 * @ingroup Scrolling
2608 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2611 * Set whether scrollers should be draggable from any point in their
2612 * views, for all Elementary application windows.
2614 * @param enabled the thumb scroll state
2616 * @see elm_thumbscroll_enabled_get()
2617 * @ingroup Scrolling
2619 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2622 * Get the number of pixels one should travel while dragging a
2623 * scroller's view to actually trigger scrolling.
2625 * @return the thumb scroll threshould
2627 * One would use higher values for touch screens, in general, because
2628 * of their inherent imprecision.
2629 * @ingroup Scrolling
2631 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
2634 * Set the number of pixels one should travel while dragging a
2635 * scroller's view to actually trigger scrolling.
2637 * @param threshold the thumb scroll threshould
2639 * @see elm_thumbscroll_threshould_get()
2640 * @ingroup Scrolling
2642 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2645 * Set the number of pixels one should travel while dragging a
2646 * scroller's view to actually trigger scrolling, for all Elementary
2647 * application windows.
2649 * @param threshold the thumb scroll threshould
2651 * @see elm_thumbscroll_threshould_get()
2652 * @ingroup Scrolling
2654 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2657 * Get the minimum speed of mouse cursor movement which will trigger
2658 * list self scrolling animation after a mouse up event
2661 * @return the thumb scroll momentum threshould
2663 * @ingroup Scrolling
2665 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
2668 * Set the minimum speed of mouse cursor movement which will trigger
2669 * list self scrolling animation after a mouse up event
2672 * @param threshold the thumb scroll momentum threshould
2674 * @see elm_thumbscroll_momentum_threshould_get()
2675 * @ingroup Scrolling
2677 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
2680 * Set the minimum speed of mouse cursor movement which will trigger
2681 * list self scrolling animation after a mouse up event
2682 * (pixels/second), for all Elementary application windows.
2684 * @param threshold the thumb scroll momentum threshould
2686 * @see elm_thumbscroll_momentum_threshould_get()
2687 * @ingroup Scrolling
2689 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
2692 * Get the amount of inertia a scroller will impose at self scrolling
2695 * @return the thumb scroll friction
2697 * @ingroup Scrolling
2699 EAPI double elm_scroll_thumbscroll_friction_get(void);
2702 * Set the amount of inertia a scroller will impose at self scrolling
2705 * @param friction the thumb scroll friction
2707 * @see elm_thumbscroll_friction_get()
2708 * @ingroup Scrolling
2710 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
2713 * Set the amount of inertia a scroller will impose at self scrolling
2714 * animations, for all Elementary application windows.
2716 * @param friction the thumb scroll friction
2718 * @see elm_thumbscroll_friction_get()
2719 * @ingroup Scrolling
2721 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
2724 * Get the amount of lag between your actual mouse cursor dragging
2725 * movement and a scroller's view movement itself, while pushing it
2726 * into bounce state manually.
2728 * @return the thumb scroll border friction
2730 * @ingroup Scrolling
2732 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
2735 * Set the amount of lag between your actual mouse cursor dragging
2736 * movement and a scroller's view movement itself, while pushing it
2737 * into bounce state manually.
2739 * @param friction the thumb scroll border friction. @c 0.0 for
2740 * perfect synchrony between two movements, @c 1.0 for maximum
2743 * @see elm_thumbscroll_border_friction_get()
2744 * @note parameter value will get bound to 0.0 - 1.0 interval, always
2746 * @ingroup Scrolling
2748 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
2751 * Set the amount of lag between your actual mouse cursor dragging
2752 * movement and a scroller's view movement itself, while pushing it
2753 * into bounce state manually, for all Elementary application windows.
2755 * @param friction the thumb scroll border friction. @c 0.0 for
2756 * perfect synchrony between two movements, @c 1.0 for maximum
2759 * @see elm_thumbscroll_border_friction_get()
2760 * @note parameter value will get bound to 0.0 - 1.0 interval, always
2762 * @ingroup Scrolling
2764 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
2767 * Get the sensitivity amount which is be multiplied by the length of
2770 * @return the thumb scroll sensitivity friction
2772 * @ingroup Scrolling
2774 EAPI double elm_scroll_thumbscroll_sensitivity_friction_get(void);
2777 * Set the sensitivity amount which is be multiplied by the length of
2780 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
2781 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
2784 * @see elm_thumbscroll_sensitivity_friction_get()
2785 * @note parameter value will get bound to 0.1 - 1.0 interval, always
2787 * @ingroup Scrolling
2789 EAPI void elm_scroll_thumbscroll_sensitivity_friction_set(double friction);
2792 * Set the sensitivity amount which is be multiplied by the length of
2793 * mouse dragging, for all Elementary application windows.
2795 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
2796 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
2799 * @see elm_thumbscroll_sensitivity_friction_get()
2800 * @note parameter value will get bound to 0.1 - 1.0 interval, always
2802 * @ingroup Scrolling
2804 EAPI void elm_scroll_thumbscroll_sensitivity_friction_all_set(double friction);
2811 * @defgroup Scrollhints Scrollhints
2813 * Objects when inside a scroller can scroll, but this may not always be
2814 * desirable in certain situations. This allows an object to hint to itself
2815 * and parents to "not scroll" in one of 2 ways. If any child object of a
2816 * scroller has pushed a scroll freeze or hold then it affects all parent
2817 * scrollers until all children have released them.
2819 * 1. To hold on scrolling. This means just flicking and dragging may no
2820 * longer scroll, but pressing/dragging near an edge of the scroller will
2821 * still scroll. This is automatically used by the entry object when
2824 * 2. To totally freeze scrolling. This means it stops. until
2831 * Push the scroll hold by 1
2833 * This increments the scroll hold count by one. If it is more than 0 it will
2834 * take effect on the parents of the indicated object.
2836 * @param obj The object
2837 * @ingroup Scrollhints
2839 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2842 * Pop the scroll hold by 1
2844 * This decrements the scroll hold count by one. If it is more than 0 it will
2845 * take effect on the parents of the indicated object.
2847 * @param obj The object
2848 * @ingroup Scrollhints
2850 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2853 * Push the scroll freeze by 1
2855 * This increments the scroll freeze count by one. If it is more
2856 * than 0 it will take effect on the parents of the indicated
2859 * @param obj The object
2860 * @ingroup Scrollhints
2862 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2865 * Pop the scroll freeze by 1
2867 * This decrements the scroll freeze count by one. If it is more
2868 * than 0 it will take effect on the parents of the indicated
2871 * @param obj The object
2872 * @ingroup Scrollhints
2874 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2877 * Lock the scrolling of the given widget (and thus all parents)
2879 * This locks the given object from scrolling in the X axis (and implicitly
2880 * also locks all parent scrollers too from doing the same).
2882 * @param obj The object
2883 * @param lock The lock state (1 == locked, 0 == unlocked)
2884 * @ingroup Scrollhints
2886 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2889 * Lock the scrolling of the given widget (and thus all parents)
2891 * This locks the given object from scrolling in the Y axis (and implicitly
2892 * also locks all parent scrollers too from doing the same).
2894 * @param obj The object
2895 * @param lock The lock state (1 == locked, 0 == unlocked)
2896 * @ingroup Scrollhints
2898 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2901 * Get the scrolling lock of the given widget
2903 * This gets the lock for X axis scrolling.
2905 * @param obj The object
2906 * @ingroup Scrollhints
2908 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2911 * Get the scrolling lock of the given widget
2913 * This gets the lock for X axis scrolling.
2915 * @param obj The object
2916 * @ingroup Scrollhints
2918 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2925 * Send a signal to the widget edje object.
2927 * This function sends a signal to the edje object of the obj. An
2928 * edje program can respond to a signal by specifying matching
2929 * 'signal' and 'source' fields.
2931 * @param obj The object
2932 * @param emission The signal's name.
2933 * @param source The signal's source.
2936 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
2937 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);
2938 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);
2941 * Add a callback for a signal emitted by widget edje object.
2943 * This function connects a callback function to a signal emitted by the
2944 * edje object of the obj.
2945 * Globs can occur in either the emission or source name.
2947 * @param obj The object
2948 * @param emission The signal's name.
2949 * @param source The signal's source.
2950 * @param func The callback function to be executed when the signal is
2952 * @param data A pointer to data to pass in to the callback function.
2955 EAPI void elm_object_signal_callback_add(Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func, void *data) EINA_ARG_NONNULL(1, 4);
2958 * Remove a signal-triggered callback from a widget edje object.
2960 * This function removes a callback, previoulsy attached to a
2961 * signal emitted by the edje object of the obj. The parameters
2962 * emission, source and func must match exactly those passed to a
2963 * previous call to elm_object_signal_callback_add(). The data
2964 * pointer that was passed to this call will be returned.
2966 * @param obj The object
2967 * @param emission The signal's name.
2968 * @param source The signal's source.
2969 * @param func The callback function to be executed when the signal is
2971 * @return The data pointer
2974 EAPI void *elm_object_signal_callback_del(Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func) EINA_ARG_NONNULL(1, 4);
2977 * Add a callback for input events (key up, key down, mouse wheel)
2978 * on a given Elementary widget
2980 * @param obj The widget to add an event callback on
2981 * @param func The callback function to be executed when the event
2983 * @param data Data to pass in to @p func
2985 * Every widget in an Elementary interface set to receive focus,
2986 * with elm_object_focus_allow_set(), will propagate @b all of its
2987 * key up, key down and mouse wheel input events up to its parent
2988 * object, and so on. All of the focusable ones in this chain which
2989 * had an event callback set, with this call, will be able to treat
2990 * those events. There are two ways of making the propagation of
2991 * these event upwards in the tree of widgets to @b cease:
2992 * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
2993 * the event was @b not processed, so the propagation will go on.
2994 * - The @c event_info pointer passed to @p func will contain the
2995 * event's structure and, if you OR its @c event_flags inner
2996 * value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
2997 * one has already handled it, thus killing the event's
3000 * @note Your event callback will be issued on those events taking
3001 * place only if no other child widget of @obj has consumed the
3004 * @note Not to be confused with @c
3005 * evas_object_event_callback_add(), which will add event callbacks
3006 * per type on general Evas objects (no event propagation
3007 * infrastructure taken in account).
3009 * @note Not to be confused with @c
3010 * elm_object_signal_callback_add(), which will add callbacks to @b
3011 * signals coming from a widget's theme, not input events.
3013 * @note Not to be confused with @c
3014 * edje_object_signal_callback_add(), which does the same as
3015 * elm_object_signal_callback_add(), but directly on an Edje
3018 * @note Not to be confused with @c
3019 * evas_object_smart_callback_add(), which adds callbacks to smart
3020 * objects' <b>smart events</b>, and not input events.
3022 * @see elm_object_event_callback_del()
3026 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3029 * Remove an event callback from a widget.
3031 * This function removes a callback, previoulsy attached to event emission
3033 * The parameters func and data must match exactly those passed to
3034 * a previous call to elm_object_event_callback_add(). The data pointer that
3035 * was passed to this call will be returned.
3037 * @param obj The object
3038 * @param func The callback function to be executed when the event is
3040 * @param data Data to pass in to the callback function.
3041 * @return The data pointer
3044 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3047 * Adjust size of an element for finger usage.
3049 * @param times_w How many fingers should fit horizontally
3050 * @param w Pointer to the width size to adjust
3051 * @param times_h How many fingers should fit vertically
3052 * @param h Pointer to the height size to adjust
3054 * This takes width and height sizes (in pixels) as input and a
3055 * size multiple (which is how many fingers you want to place
3056 * within the area, being "finger" the size set by
3057 * elm_finger_size_set()), and adjusts the size to be large enough
3058 * to accommodate the resulting size -- if it doesn't already
3059 * accommodate it. On return the @p w and @p h sizes pointed to by
3060 * these parameters will be modified, on those conditions.
3062 * @note This is kind of a low level Elementary call, most useful
3063 * on size evaluation times for widgets. An external user wouldn't
3064 * be calling, most of the time.
3068 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
3071 * Get the duration for occuring long press event.
3073 * @return Timeout for long press event
3074 * @ingroup Longpress
3076 EAPI double elm_longpress_timeout_get(void);
3079 * Set the duration for occuring long press event.
3081 * @param lonpress_timeout Timeout for long press event
3082 * @ingroup Longpress
3084 EAPI void elm_longpress_timeout_set(double longpress_timeout);
3087 * @defgroup Debug Debug
3088 * don't use it unless you are sure
3094 * Print Tree object hierarchy in stdout
3096 * @param obj The root object
3099 EAPI void elm_object_tree_dump(const Evas_Object *top);
3100 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3102 EAPI void elm_autocapitalization_allow_all_set(Eina_Bool autocap);
3103 EAPI void elm_autoperiod_allow_all_set(Eina_Bool autoperiod);
3105 * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3107 * @param obj The root object
3108 * @param file The path of output file
3111 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3118 * @defgroup Theme Theme
3120 * Elementary uses Edje to theme its widgets, naturally. But for the most
3121 * part this is hidden behind a simpler interface that lets the user set
3122 * extensions and choose the style of widgets in a much easier way.
3124 * Instead of thinking in terms of paths to Edje files and their groups
3125 * each time you want to change the appearance of a widget, Elementary
3126 * works so you can add any theme file with extensions or replace the
3127 * main theme at one point in the application, and then just set the style
3128 * of widgets with elm_object_style_set() and related functions. Elementary
3129 * will then look in its list of themes for a matching group and apply it,
3130 * and when the theme changes midway through the application, all widgets
3131 * will be updated accordingly.
3133 * There are three concepts you need to know to understand how Elementary
3134 * theming works: default theme, extensions and overlays.
3136 * Default theme, obviously enough, is the one that provides the default
3137 * look of all widgets. End users can change the theme used by Elementary
3138 * by setting the @c ELM_THEME environment variable before running an
3139 * application, or globally for all programs using the @c elementary_config
3140 * utility. Applications can change the default theme using elm_theme_set(),
3141 * but this can go against the user wishes, so it's not an adviced practice.
3143 * Ideally, applications should find everything they need in the already
3144 * provided theme, but there may be occasions when that's not enough and
3145 * custom styles are required to correctly express the idea. For this
3146 * cases, Elementary has extensions.
3148 * Extensions allow the application developer to write styles of its own
3149 * to apply to some widgets. This requires knowledge of how each widget
3150 * is themed, as extensions will always replace the entire group used by
3151 * the widget, so important signals and parts need to be there for the
3152 * object to behave properly (see documentation of Edje for details).
3153 * Once the theme for the extension is done, the application needs to add
3154 * it to the list of themes Elementary will look into, using
3155 * elm_theme_extension_add(), and set the style of the desired widgets as
3156 * he would normally with elm_object_style_set().
3158 * Overlays, on the other hand, can replace the look of all widgets by
3159 * overriding the default style. Like extensions, it's up to the application
3160 * developer to write the theme for the widgets it wants, the difference
3161 * being that when looking for the theme, Elementary will check first the
3162 * list of overlays, then the set theme and lastly the list of extensions,
3163 * so with overlays it's possible to replace the default view and every
3164 * widget will be affected. This is very much alike to setting the whole
3165 * theme for the application and will probably clash with the end user
3166 * options, not to mention the risk of ending up with not matching styles
3167 * across the program. Unless there's a very special reason to use them,
3168 * overlays should be avoided for the resons exposed before.
3170 * All these theme lists are handled by ::Elm_Theme instances. Elementary
3171 * keeps one default internally and every function that receives one of
3172 * these can be called with NULL to refer to this default (except for
3173 * elm_theme_free()). It's possible to create a new instance of a
3174 * ::Elm_Theme to set other theme for a specific widget (and all of its
3175 * children), but this is as discouraged, if not even more so, than using
3176 * overlays. Don't use this unless you really know what you are doing.
3178 * But to be less negative about things, you can look at the following
3180 * @li @ref theme_example_01 "Using extensions"
3181 * @li @ref theme_example_02 "Using overlays"
3186 * @typedef Elm_Theme
3188 * Opaque handler for the list of themes Elementary looks for when
3189 * rendering widgets.
3191 * Stay out of this unless you really know what you are doing. For most
3192 * cases, sticking to the default is all a developer needs.
3194 typedef struct _Elm_Theme Elm_Theme;
3197 * Create a new specific theme
3199 * This creates an empty specific theme that only uses the default theme. A
3200 * specific theme has its own private set of extensions and overlays too
3201 * (which are empty by default). Specific themes do not fall back to themes
3202 * of parent objects. They are not intended for this use. Use styles, overlays
3203 * and extensions when needed, but avoid specific themes unless there is no
3204 * other way (example: you want to have a preview of a new theme you are
3205 * selecting in a "theme selector" window. The preview is inside a scroller
3206 * and should display what the theme you selected will look like, but not
3207 * actually apply it yet. The child of the scroller will have a specific
3208 * theme set to show this preview before the user decides to apply it to all
3211 EAPI Elm_Theme *elm_theme_new(void);
3213 * Free a specific theme
3215 * @param th The theme to free
3217 * This frees a theme created with elm_theme_new().
3219 EAPI void elm_theme_free(Elm_Theme *th);
3221 * Copy the theme fom the source to the destination theme
3223 * @param th The source theme to copy from
3224 * @param thdst The destination theme to copy data to
3226 * This makes a one-time static copy of all the theme config, extensions
3227 * and overlays from @p th to @p thdst. If @p th references a theme, then
3228 * @p thdst is also set to reference it, with all the theme settings,
3229 * overlays and extensions that @p th had.
3231 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3233 * Tell the source theme to reference the ref theme
3235 * @param th The theme that will do the referencing
3236 * @param thref The theme that is the reference source
3238 * This clears @p th to be empty and then sets it to refer to @p thref
3239 * so @p th acts as an override to @p thref, but where its overrides
3240 * don't apply, it will fall through to @p thref for configuration.
3242 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3244 * Return the theme referred to
3246 * @param th The theme to get the reference from
3247 * @return The referenced theme handle
3249 * This gets the theme set as the reference theme by elm_theme_ref_set().
3250 * If no theme is set as a reference, NULL is returned.
3252 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
3254 * Return the default theme
3256 * @return The default theme handle
3258 * This returns the internal default theme setup handle that all widgets
3259 * use implicitly unless a specific theme is set. This is also often use
3260 * as a shorthand of NULL.
3262 EAPI Elm_Theme *elm_theme_default_get(void);
3264 * Prepends a theme overlay to the list of overlays
3266 * @param th The theme to add to, or if NULL, the default theme
3267 * @param item The Edje file path to be used
3269 * Use this if your application needs to provide some custom overlay theme
3270 * (An Edje file that replaces some default styles of widgets) where adding
3271 * new styles, or changing system theme configuration is not possible. Do
3272 * NOT use this instead of a proper system theme configuration. Use proper
3273 * configuration files, profiles, environment variables etc. to set a theme
3274 * so that the theme can be altered by simple confiugration by a user. Using
3275 * this call to achieve that effect is abusing the API and will create lots
3278 * @see elm_theme_extension_add()
3280 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
3282 * Delete a theme overlay from the list of overlays
3284 * @param th The theme to delete from, or if NULL, the default theme
3285 * @param item The name of the theme overlay
3287 * @see elm_theme_overlay_add()
3289 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
3291 * Appends a theme extension to the list of extensions.
3293 * @param th The theme to add to, or if NULL, the default theme
3294 * @param item The Edje file path to be used
3296 * This is intended when an application needs more styles of widgets or new
3297 * widget themes that the default does not provide (or may not provide). The
3298 * application has "extended" usage by coming up with new custom style names
3299 * for widgets for specific uses, but as these are not "standard", they are
3300 * not guaranteed to be provided by a default theme. This means the
3301 * application is required to provide these extra elements itself in specific
3302 * Edje files. This call adds one of those Edje files to the theme search
3303 * path to be search after the default theme. The use of this call is
3304 * encouraged when default styles do not meet the needs of the application.
3305 * Use this call instead of elm_theme_overlay_add() for almost all cases.
3307 * @see elm_object_style_set()
3309 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
3311 * Deletes a theme extension from the list of extensions.
3313 * @param th The theme to delete from, or if NULL, the default theme
3314 * @param item The name of the theme extension
3316 * @see elm_theme_extension_add()
3318 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
3320 * Set the theme search order for the given theme
3322 * @param th The theme to set the search order, or if NULL, the default theme
3323 * @param theme Theme search string
3325 * This sets the search string for the theme in path-notation from first
3326 * theme to search, to last, delimited by the : character. Example:
3328 * "shiny:/path/to/file.edj:default"
3330 * See the ELM_THEME environment variable for more information.
3332 * @see elm_theme_get()
3333 * @see elm_theme_list_get()
3335 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
3337 * Return the theme search order
3339 * @param th The theme to get the search order, or if NULL, the default theme
3340 * @return The internal search order path
3342 * This function returns a colon separated string of theme elements as
3343 * returned by elm_theme_list_get().
3345 * @see elm_theme_set()
3346 * @see elm_theme_list_get()
3348 EAPI const char *elm_theme_get(Elm_Theme *th);
3350 * Return a list of theme elements to be used in a theme.
3352 * @param th Theme to get the list of theme elements from.
3353 * @return The internal list of theme elements
3355 * This returns the internal list of theme elements (will only be valid as
3356 * long as the theme is not modified by elm_theme_set() or theme is not
3357 * freed by elm_theme_free(). This is a list of strings which must not be
3358 * altered as they are also internal. If @p th is NULL, then the default
3359 * theme element list is returned.
3361 * A theme element can consist of a full or relative path to a .edj file,
3362 * or a name, without extension, for a theme to be searched in the known
3363 * theme paths for Elemementary.
3365 * @see elm_theme_set()
3366 * @see elm_theme_get()
3368 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3370 * Return the full patrh for a theme element
3372 * @param f The theme element name
3373 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3374 * @return The full path to the file found.
3376 * This returns a string you should free with free() on success, NULL on
3377 * failure. This will search for the given theme element, and if it is a
3378 * full or relative path element or a simple searchable name. The returned
3379 * path is the full path to the file, if searched, and the file exists, or it
3380 * is simply the full path given in the element or a resolved path if
3381 * relative to home. The @p in_search_path boolean pointed to is set to
3382 * EINA_TRUE if the file was a searchable file andis in the search path,
3383 * and EINA_FALSE otherwise.
3385 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3387 * Flush the current theme.
3389 * @param th Theme to flush
3391 * This flushes caches that let elementary know where to find theme elements
3392 * in the given theme. If @p th is NULL, then the default theme is flushed.
3393 * Call this function if source theme data has changed in such a way as to
3394 * make any caches Elementary kept invalid.
3396 EAPI void elm_theme_flush(Elm_Theme *th);
3398 * This flushes all themes (default and specific ones).
3400 * This will flush all themes in the current application context, by calling
3401 * elm_theme_flush() on each of them.
3403 EAPI void elm_theme_full_flush(void);
3405 * Set the theme for all elementary using applications on the current display
3407 * @param theme The name of the theme to use. Format same as the ELM_THEME
3408 * environment variable.
3410 EAPI void elm_theme_all_set(const char *theme);
3412 * Return a list of theme elements in the theme search path
3414 * @return A list of strings that are the theme element names.
3416 * This lists all available theme files in the standard Elementary search path
3417 * for theme elements, and returns them in alphabetical order as theme
3418 * element names in a list of strings. Free this with
3419 * elm_theme_name_available_list_free() when you are done with the list.
3421 EAPI Eina_List *elm_theme_name_available_list_new(void);
3423 * Free the list returned by elm_theme_name_available_list_new()
3425 * This frees the list of themes returned by
3426 * elm_theme_name_available_list_new(). Once freed the list should no longer
3427 * be used. a new list mys be created.
3429 EAPI void elm_theme_name_available_list_free(Eina_List *list);
3431 * Set a specific theme to be used for this object and its children
3433 * @param obj The object to set the theme on
3434 * @param th The theme to set
3436 * This sets a specific theme that will be used for the given object and any
3437 * child objects it has. If @p th is NULL then the theme to be used is
3438 * cleared and the object will inherit its theme from its parent (which
3439 * ultimately will use the default theme if no specific themes are set).
3441 * Use special themes with great care as this will annoy users and make
3442 * configuration difficult. Avoid any custom themes at all if it can be
3445 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3447 * Get the specific theme to be used
3449 * @param obj The object to get the specific theme from
3450 * @return The specifc theme set.
3452 * This will return a specific theme set, or NULL if no specific theme is
3453 * set on that object. It will not return inherited themes from parents, only
3454 * the specific theme set for that specific object. See elm_object_theme_set()
3455 * for more information.
3457 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3460 * Get a data item from a theme
3462 * @param th The theme, or NULL for default theme
3463 * @param key The data key to search with
3464 * @return The data value, or NULL on failure
3466 * This function is used to return data items from edc in @p th, an overlay, or an extension.
3467 * It works the same way as edje_file_data_get() except that the return is stringshared.
3469 EAPI const char *elm_theme_data_get(Elm_Theme *th, const char *key) EINA_ARG_NONNULL(2);
3475 /** @defgroup Win Win
3477 * @image html img/widget/win/preview-00.png
3478 * @image latex img/widget/win/preview-00.eps
3480 * The window class of Elementary. Contains functions to manipulate
3481 * windows. The Evas engine used to render the window contents is specified
3482 * in the system or user elementary config files (whichever is found last),
3483 * and can be overridden with the ELM_ENGINE environment variable for
3484 * testing. Engines that may be supported (depending on Evas and Ecore-Evas
3485 * compilation setup and modules actually installed at runtime) are (listed
3486 * in order of best supported and most likely to be complete and work to
3489 * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3490 * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3492 * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3494 * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3496 * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3498 * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3499 * rendering using SDL as the buffer)
3500 * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3501 * GDI with software)
3502 * @li "dfb", "directfb" (Rendering to a DirectFB window)
3503 * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3504 * grayscale using dedicated 8bit software engine in X11)
3505 * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3506 * X11 using 16bit software engine)
3507 * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3508 * (Windows CE rendering via GDI with 16bit software renderer)
3509 * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3510 * buffer with 16bit software renderer)
3511 * @li "ews" (rendering to EWS - Ecore + Evas Single Process Windowing System)
3513 * All engines use a simple string to select the engine to render, EXCEPT
3514 * the "shot" engine. This actually encodes the output of the virtual
3515 * screenshot and how long to delay in the engine string. The engine string
3516 * is encoded in the following way:
3518 * "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3520 * Where options are separated by a ":" char if more than one option is
3521 * given, with delay, if provided being the first option and file the last
3522 * (order is important). The delay specifies how long to wait after the
3523 * window is shown before doing the virtual "in memory" rendering and then
3524 * save the output to the file specified by the file option (and then exit).
3525 * If no delay is given, the default is 0.5 seconds. If no file is given the
3526 * default output file is "out.png". Repeat option is for continous
3527 * capturing screenshots. Repeat range is from 1 to 999 and filename is
3528 * fixed to "out001.png" Some examples of using the shot engine:
3530 * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3531 * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3532 * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3533 * ELM_ENGINE="shot:delay=2.0" elementary_test
3534 * ELM_ENGINE="shot:" elementary_test
3536 * Signals that you can add callbacks for are:
3538 * @li "delete,request": the user requested to close the window. See
3539 * elm_win_autodel_set().
3540 * @li "focus,in": window got focus
3541 * @li "focus,out": window lost focus
3542 * @li "moved": window that holds the canvas was moved
3545 * @li @ref win_example_01
3550 * Defines the types of window that can be created
3552 * These are hints set on the window so that a running Window Manager knows
3553 * how the window should be handled and/or what kind of decorations it
3556 * Currently, only the X11 backed engines use them.
3558 typedef enum _Elm_Win_Type
3560 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3561 window. Almost every window will be created with this
3563 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3564 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3565 window holding desktop icons. */
3566 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3567 be kept on top of any other window by the Window
3569 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3571 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3572 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3574 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3575 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3576 entry in a menubar is clicked. Typically used
3577 with elm_win_override_set(). This hint exists
3578 for completion only, as the EFL way of
3579 implementing a menu would not normally use a
3580 separate window for its contents. */
3581 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3582 triggered by right-clicking an object. */
3583 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3584 explanatory text that typically appear after the
3585 mouse cursor hovers over an object for a while.
3586 Typically used with elm_win_override_set() and also
3587 not very commonly used in the EFL. */
3588 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3589 battery life or a new E-Mail received. */
3590 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3591 usually used in the EFL. */
3592 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3593 object being dragged across different windows, or even
3594 applications. Typically used with
3595 elm_win_override_set(). */
3596 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3597 buffer. No actual window is created for this
3598 type, instead the window and all of its
3599 contents will be rendered to an image buffer.
3600 This allows to have children window inside a
3601 parent one just like any other object would
3602 be, and do other things like applying @c
3603 Evas_Map effects to it. This is the only type
3604 of window that requires the @c parent
3605 parameter of elm_win_add() to be a valid @c
3610 * The differents layouts that can be requested for the virtual keyboard.
3612 * When the application window is being managed by Illume, it may request
3613 * any of the following layouts for the virtual keyboard.
3615 typedef enum _Elm_Win_Keyboard_Mode
3617 ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3618 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3619 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3620 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3621 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3622 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3623 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3624 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3625 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3626 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3627 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3628 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3629 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3630 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3631 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3632 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3633 } Elm_Win_Keyboard_Mode;
3636 * Available commands that can be sent to the Illume manager.
3638 * When running under an Illume session, a window may send commands to the
3639 * Illume manager to perform different actions.
3641 typedef enum _Elm_Illume_Command
3643 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3645 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3647 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3649 ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3650 } Elm_Illume_Command;
3653 * Adds a window object. If this is the first window created, pass NULL as
3656 * @param parent Parent object to add the window to, or NULL
3657 * @param name The name of the window
3658 * @param type The window type, one of #Elm_Win_Type.
3660 * The @p parent paramter can be @c NULL for every window @p type except
3661 * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3662 * which the image object will be created.
3664 * @return The created object, or NULL on failure
3666 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3668 * Add @p subobj as a resize object of window @p obj.
3671 * Setting an object as a resize object of the window means that the
3672 * @p subobj child's size and position will be controlled by the window
3673 * directly. That is, the object will be resized to match the window size
3674 * and should never be moved or resized manually by the developer.
3676 * In addition, resize objects of the window control what the minimum size
3677 * of it will be, as well as whether it can or not be resized by the user.
3679 * For the end user to be able to resize a window by dragging the handles
3680 * or borders provided by the Window Manager, or using any other similar
3681 * mechanism, all of the resize objects in the window should have their
3682 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
3684 * @param obj The window object
3685 * @param subobj The resize object to add
3687 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3689 * Delete @p subobj as a resize object of window @p obj.
3691 * This function removes the object @p subobj from the resize objects of
3692 * the window @p obj. It will not delete the object itself, which will be
3693 * left unmanaged and should be deleted by the developer, manually handled
3694 * or set as child of some other container.
3696 * @param obj The window object
3697 * @param subobj The resize object to add
3699 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3701 * Set the title of the window
3703 * @param obj The window object
3704 * @param title The title to set
3706 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3708 * Get the title of the window
3710 * The returned string is an internal one and should not be freed or
3711 * modified. It will also be rendered invalid if a new title is set or if
3712 * the window is destroyed.
3714 * @param obj The window object
3717 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3719 * Set the window's autodel state.
3721 * When closing the window in any way outside of the program control, like
3722 * pressing the X button in the titlebar or using a command from the
3723 * Window Manager, a "delete,request" signal is emitted to indicate that
3724 * this event occurred and the developer can take any action, which may
3725 * include, or not, destroying the window object.
3727 * When the @p autodel parameter is set, the window will be automatically
3728 * destroyed when this event occurs, after the signal is emitted.
3729 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
3730 * and is up to the program to do so when it's required.
3732 * @param obj The window object
3733 * @param autodel If true, the window will automatically delete itself when
3736 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
3738 * Get the window's autodel state.
3740 * @param obj The window object
3741 * @return If the window will automatically delete itself when closed
3743 * @see elm_win_autodel_set()
3745 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3747 * Activate a window object.
3749 * This function sends a request to the Window Manager to activate the
3750 * window pointed by @p obj. If honored by the WM, the window will receive
3751 * the keyboard focus.
3753 * @note This is just a request that a Window Manager may ignore, so calling
3754 * this function does not ensure in any way that the window will be the
3755 * active one after it.
3757 * @param obj The window object
3759 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
3761 * Lower a window object.
3763 * Places the window pointed by @p obj at the bottom of the stack, so that
3764 * no other window is covered by it.
3766 * If elm_win_override_set() is not set, the Window Manager may ignore this
3769 * @param obj The window object
3771 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
3773 * Raise a window object.
3775 * Places the window pointed by @p obj at the top of the stack, so that it's
3776 * not covered by any other window.
3778 * If elm_win_override_set() is not set, the Window Manager may ignore this
3781 * @param obj The window object
3783 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
3785 * Set the borderless state of a window.
3787 * This function requests the Window Manager to not draw any decoration
3788 * around the window.
3790 * @param obj The window object
3791 * @param borderless If true, the window is borderless
3793 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
3795 * Get the borderless state of a window.
3797 * @param obj The window object
3798 * @return If true, the window is borderless
3800 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3802 * Set the shaped state of a window.
3804 * Shaped windows, when supported, will render the parts of the window that
3805 * has no content, transparent.
3807 * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
3808 * background object or cover the entire window in any other way, or the
3809 * parts of the canvas that have no data will show framebuffer artifacts.
3811 * @param obj The window object
3812 * @param shaped If true, the window is shaped
3814 * @see elm_win_alpha_set()
3816 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
3818 * Get the shaped state of a window.
3820 * @param obj The window object
3821 * @return If true, the window is shaped
3823 * @see elm_win_shaped_set()
3825 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3827 * Set the alpha channel state of a window.
3829 * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
3830 * possibly making parts of the window completely or partially transparent.
3831 * This is also subject to the underlying system supporting it, like for
3832 * example, running under a compositing manager. If no compositing is
3833 * available, enabling this option will instead fallback to using shaped
3834 * windows, with elm_win_shaped_set().
3836 * @param obj The window object
3837 * @param alpha If true, the window has an alpha channel
3839 * @see elm_win_alpha_set()
3841 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
3843 * Get the transparency state of a window.
3845 * @param obj The window object
3846 * @return If true, the window is transparent
3848 * @see elm_win_transparent_set()
3850 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3852 * Set the transparency state of a window.
3854 * Use elm_win_alpha_set() instead.
3856 * @param obj The window object
3857 * @param transparent If true, the window is transparent
3859 * @see elm_win_alpha_set()
3861 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
3863 * Get the alpha channel state of a window.
3865 * @param obj The window object
3866 * @return If true, the window has an alpha channel
3868 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3870 * Set the override state of a window.
3872 * A window with @p override set to EINA_TRUE will not be managed by the
3873 * Window Manager. This means that no decorations of any kind will be shown
3874 * for it, moving and resizing must be handled by the application, as well
3875 * as the window visibility.
3877 * This should not be used for normal windows, and even for not so normal
3878 * ones, it should only be used when there's a good reason and with a lot
3879 * of care. Mishandling override windows may result situations that
3880 * disrupt the normal workflow of the end user.
3882 * @param obj The window object
3883 * @param override If true, the window is overridden
3885 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
3887 * Get the override state of a window.
3889 * @param obj The window object
3890 * @return If true, the window is overridden
3892 * @see elm_win_override_set()
3894 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3896 * Set the fullscreen state of a window.
3898 * @param obj The window object
3899 * @param fullscreen If true, the window is fullscreen
3901 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
3903 * Get the fullscreen state of a window.
3905 * @param obj The window object
3906 * @return If true, the window is fullscreen
3908 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3910 * Set the maximized state of a window.
3912 * @param obj The window object
3913 * @param maximized If true, the window is maximized
3915 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
3917 * Get the maximized state of a window.
3919 * @param obj The window object
3920 * @return If true, the window is maximized
3922 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3924 * Set the iconified state of a window.
3926 * @param obj The window object
3927 * @param iconified If true, the window is iconified
3929 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
3931 * Get the iconified state of a window.
3933 * @param obj The window object
3934 * @return If true, the window is iconified
3936 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3938 * Set the layer of the window.
3940 * What this means exactly will depend on the underlying engine used.
3942 * In the case of X11 backed engines, the value in @p layer has the
3943 * following meanings:
3944 * @li < 3: The window will be placed below all others.
3945 * @li > 5: The window will be placed above all others.
3946 * @li other: The window will be placed in the default layer.
3948 * @param obj The window object
3949 * @param layer The layer of the window
3951 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
3953 * Get the layer of the window.
3955 * @param obj The window object
3956 * @return The layer of the window
3958 * @see elm_win_layer_set()
3960 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3962 * Set the rotation of the window.
3964 * Most engines only work with multiples of 90.
3966 * This function is used to set the orientation of the window @p obj to
3967 * match that of the screen. The window itself will be resized to adjust
3968 * to the new geometry of its contents. If you want to keep the window size,
3969 * see elm_win_rotation_with_resize_set().
3971 * @param obj The window object
3972 * @param rotation The rotation of the window, in degrees (0-360),
3973 * counter-clockwise.
3975 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
3977 * Rotates the window and resizes it.
3979 * Like elm_win_rotation_set(), but it also resizes the window's contents so
3980 * that they fit inside the current window geometry.
3982 * @param obj The window object
3983 * @param layer The rotation of the window in degrees (0-360),
3984 * counter-clockwise.
3986 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
3988 * Get the rotation of the window.
3990 * @param obj The window object
3991 * @return The rotation of the window in degrees (0-360)
3993 * @see elm_win_rotation_set()
3994 * @see elm_win_rotation_with_resize_set()
3996 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3998 * Set the sticky state of the window.
4000 * Hints the Window Manager that the window in @p obj should be left fixed
4001 * at its position even when the virtual desktop it's on moves or changes.
4003 * @param obj The window object
4004 * @param sticky If true, the window's sticky state is enabled
4006 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
4008 * Get the sticky state of the window.
4010 * @param obj The window object
4011 * @return If true, the window's sticky state is enabled
4013 * @see elm_win_sticky_set()
4015 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4017 * Set if this window is an illume conformant window
4019 * @param obj The window object
4020 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
4022 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
4024 * Get if this window is an illume conformant window
4026 * @param obj The window object
4027 * @return A boolean if this window is illume conformant or not
4029 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4031 * Set a window to be an illume quickpanel window
4033 * By default window objects are not quickpanel windows.
4035 * @param obj The window object
4036 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4038 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4040 * Get if this window is a quickpanel or not
4042 * @param obj The window object
4043 * @return A boolean if this window is a quickpanel or not
4045 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4047 * Set the major priority of a quickpanel window
4049 * @param obj The window object
4050 * @param priority The major priority for this quickpanel
4052 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4054 * Get the major priority of a quickpanel window
4056 * @param obj The window object
4057 * @return The major priority of this quickpanel
4059 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4061 * Set the minor priority of a quickpanel window
4063 * @param obj The window object
4064 * @param priority The minor priority for this quickpanel
4066 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4068 * Get the minor priority of a quickpanel window
4070 * @param obj The window object
4071 * @return The minor priority of this quickpanel
4073 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4075 * Set which zone this quickpanel should appear in
4077 * @param obj The window object
4078 * @param zone The requested zone for this quickpanel
4080 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4082 * Get which zone this quickpanel should appear in
4084 * @param obj The window object
4085 * @return The requested zone for this quickpanel
4087 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4089 * Set the window to be skipped by keyboard focus
4091 * This sets the window to be skipped by normal keyboard input. This means
4092 * a window manager will be asked to not focus this window as well as omit
4093 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4095 * Call this and enable it on a window BEFORE you show it for the first time,
4096 * otherwise it may have no effect.
4098 * Use this for windows that have only output information or might only be
4099 * interacted with by the mouse or fingers, and never for typing input.
4100 * Be careful that this may have side-effects like making the window
4101 * non-accessible in some cases unless the window is specially handled. Use
4104 * @param obj The window object
4105 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4107 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4109 * Send a command to the windowing environment
4111 * This is intended to work in touchscreen or small screen device
4112 * environments where there is a more simplistic window management policy in
4113 * place. This uses the window object indicated to select which part of the
4114 * environment to control (the part that this window lives in), and provides
4115 * a command and an optional parameter structure (use NULL for this if not
4118 * @param obj The window object that lives in the environment to control
4119 * @param command The command to send
4120 * @param params Optional parameters for the command
4122 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4124 * Get the inlined image object handle
4126 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4127 * then the window is in fact an evas image object inlined in the parent
4128 * canvas. You can get this object (be careful to not manipulate it as it
4129 * is under control of elementary), and use it to do things like get pixel
4130 * data, save the image to a file, etc.
4132 * @param obj The window object to get the inlined image from
4133 * @return The inlined image object, or NULL if none exists
4135 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4137 * Set the enabled status for the focus highlight in a window
4139 * This function will enable or disable the focus highlight only for the
4140 * given window, regardless of the global setting for it
4142 * @param obj The window where to enable the highlight
4143 * @param enabled The enabled value for the highlight
4145 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4147 * Get the enabled value of the focus highlight for this window
4149 * @param obj The window in which to check if the focus highlight is enabled
4151 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4153 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4155 * Set the style for the focus highlight on this window
4157 * Sets the style to use for theming the highlight of focused objects on
4158 * the given window. If @p style is NULL, the default will be used.
4160 * @param obj The window where to set the style
4161 * @param style The style to set
4163 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4165 * Get the style set for the focus highlight object
4167 * Gets the style set for this windows highilght object, or NULL if none
4170 * @param obj The window to retrieve the highlights style from
4172 * @return The style set or NULL if none was. Default is used in that case.
4174 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4175 EAPI void elm_win_indicator_state_set(Evas_Object *obj, int show_state);
4176 EAPI int elm_win_indicator_state_get(Evas_Object *obj);
4178 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4179 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4180 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4181 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4182 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4183 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4184 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4186 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4187 * (blank mouse, private mouse obj, defaultmouse)
4191 * Sets the keyboard mode of the window.
4193 * @param obj The window object
4194 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4196 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4198 * Gets the keyboard mode of the window.
4200 * @param obj The window object
4201 * @return The mode, one of #Elm_Win_Keyboard_Mode
4203 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4205 * Sets whether the window is a keyboard.
4207 * @param obj The window object
4208 * @param is_keyboard If true, the window is a virtual keyboard
4210 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4212 * Gets whether the window is a keyboard.
4214 * @param obj The window object
4215 * @return If the window is a virtual keyboard
4217 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4220 * Get the screen position of a window.
4222 * @param obj The window object
4223 * @param x The int to store the x coordinate to
4224 * @param y The int to store the y coordinate to
4226 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4232 * @defgroup Inwin Inwin
4234 * @image html img/widget/inwin/preview-00.png
4235 * @image latex img/widget/inwin/preview-00.eps
4236 * @image html img/widget/inwin/preview-01.png
4237 * @image latex img/widget/inwin/preview-01.eps
4238 * @image html img/widget/inwin/preview-02.png
4239 * @image latex img/widget/inwin/preview-02.eps
4241 * An inwin is a window inside a window that is useful for a quick popup.
4242 * It does not hover.
4244 * It works by creating an object that will occupy the entire window, so it
4245 * must be created using an @ref Win "elm_win" as parent only. The inwin
4246 * object can be hidden or restacked below every other object if it's
4247 * needed to show what's behind it without destroying it. If this is done,
4248 * the elm_win_inwin_activate() function can be used to bring it back to
4249 * full visibility again.
4251 * There are three styles available in the default theme. These are:
4252 * @li default: The inwin is sized to take over most of the window it's
4254 * @li minimal: The size of the inwin will be the minimum necessary to show
4256 * @li minimal_vertical: Horizontally, the inwin takes as much space as
4257 * possible, but it's sized vertically the most it needs to fit its\
4260 * Some examples of Inwin can be found in the following:
4261 * @li @ref inwin_example_01
4266 * Adds an inwin to the current window
4268 * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4269 * Never call this function with anything other than the top-most window
4270 * as its parameter, unless you are fond of undefined behavior.
4272 * After creating the object, the widget will set itself as resize object
4273 * for the window with elm_win_resize_object_add(), so when shown it will
4274 * appear to cover almost the entire window (how much of it depends on its
4275 * content and the style used). It must not be added into other container
4276 * objects and it needs not be moved or resized manually.
4278 * @param parent The parent object
4279 * @return The new object or NULL if it cannot be created
4281 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4283 * Activates an inwin object, ensuring its visibility
4285 * This function will make sure that the inwin @p obj is completely visible
4286 * by calling evas_object_show() and evas_object_raise() on it, to bring it
4287 * to the front. It also sets the keyboard focus to it, which will be passed
4290 * The object's theme will also receive the signal "elm,action,show" with
4293 * @param obj The inwin to activate
4295 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4297 * Set the content of an inwin object.
4299 * Once the content object is set, a previously set one will be deleted.
4300 * If you want to keep that old content object, use the
4301 * elm_win_inwin_content_unset() function.
4303 * @param obj The inwin object
4304 * @param content The object to set as content
4306 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4308 * Get the content of an inwin object.
4310 * Return the content object which is set for this widget.
4312 * The returned object is valid as long as the inwin is still alive and no
4313 * other content is set on it. Deleting the object will notify the inwin
4314 * about it and this one will be left empty.
4316 * If you need to remove an inwin's content to be reused somewhere else,
4317 * see elm_win_inwin_content_unset().
4319 * @param obj The inwin object
4320 * @return The content that is being used
4322 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4324 * Unset the content of an inwin object.
4326 * Unparent and return the content object which was set for this widget.
4328 * @param obj The inwin object
4329 * @return The content that was being used
4331 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4335 /* X specific calls - won't work on non-x engines (return 0) */
4338 * Get the Ecore_X_Window of an Evas_Object
4340 * @param obj The object
4342 * @return The Ecore_X_Window of @p obj
4346 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4348 /* smart callbacks called:
4349 * "delete,request" - the user requested to delete the window
4350 * "focus,in" - window got focus
4351 * "focus,out" - window lost focus
4352 * "moved" - window that holds the canvas was moved
4358 * @image html img/widget/bg/preview-00.png
4359 * @image latex img/widget/bg/preview-00.eps
4361 * @brief Background object, used for setting a solid color, image or Edje
4362 * group as background to a window or any container object.
4364 * The bg object is used for setting a solid background to a window or
4365 * packing into any container object. It works just like an image, but has
4366 * some properties useful to a background, like setting it to tiled,
4367 * centered, scaled or stretched.
4369 * Default contents parts of the bg widget that you can use for are:
4370 * @li "elm.swallow.content" - overlay of the bg
4372 * Here is some sample code using it:
4373 * @li @ref bg_01_example_page
4374 * @li @ref bg_02_example_page
4375 * @li @ref bg_03_example_page
4379 typedef enum _Elm_Bg_Option
4381 ELM_BG_OPTION_CENTER, /**< center the background */
4382 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
4383 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4384 ELM_BG_OPTION_TILE /**< tile background at its original size */
4388 * Add a new background to the parent
4390 * @param parent The parent object
4391 * @return The new object or NULL if it cannot be created
4395 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4398 * Set the file (image or edje) used for the background
4400 * @param obj The bg object
4401 * @param file The file path
4402 * @param group Optional key (group in Edje) within the file
4404 * This sets the image file used in the background object. The image (or edje)
4405 * will be stretched (retaining aspect if its an image file) to completely fill
4406 * the bg object. This may mean some parts are not visible.
4408 * @note Once the image of @p obj is set, a previously set one will be deleted,
4409 * even if @p file is NULL.
4413 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4416 * Get the file (image or edje) used for the background
4418 * @param obj The bg object
4419 * @param file The file path
4420 * @param group Optional key (group in Edje) within the file
4424 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4427 * Set the option used for the background image
4429 * @param obj The bg object
4430 * @param option The desired background option (TILE, SCALE)
4432 * This sets the option used for manipulating the display of the background
4433 * image. The image can be tiled or scaled.
4437 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4440 * Get the option used for the background image
4442 * @param obj The bg object
4443 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4447 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4449 * Set the option used for the background color
4451 * @param obj The bg object
4456 * This sets the color used for the background rectangle. Its range goes
4461 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4463 * Get the option used for the background color
4465 * @param obj The bg object
4472 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4475 * Set the overlay object used for the background object.
4477 * @param obj The bg object
4478 * @param overlay The overlay object
4480 * This provides a way for elm_bg to have an 'overlay' that will be on top
4481 * of the bg. Once the over object is set, a previously set one will be
4482 * deleted, even if you set the new one to NULL. If you want to keep that
4483 * old content object, use the elm_bg_overlay_unset() function.
4488 EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4491 * Get the overlay object used for the background object.
4493 * @param obj The bg object
4494 * @return The content that is being used
4496 * Return the content object which is set for this widget
4500 EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4503 * Get the overlay object used for the background object.
4505 * @param obj The bg object
4506 * @return The content that was being used
4508 * Unparent and return the overlay object which was set for this widget
4512 EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4515 * Set the size of the pixmap representation of the image.
4517 * This option just makes sense if an image is going to be set in the bg.
4519 * @param obj The bg object
4520 * @param w The new width of the image pixmap representation.
4521 * @param h The new height of the image pixmap representation.
4523 * This function sets a new size for pixmap representation of the given bg
4524 * image. It allows the image to be loaded already in the specified size,
4525 * reducing the memory usage and load time when loading a big image with load
4526 * size set to a smaller size.
4528 * NOTE: this is just a hint, the real size of the pixmap may differ
4529 * depending on the type of image being loaded, being bigger than requested.
4533 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4534 /* smart callbacks called:
4538 * @defgroup Icon Icon
4540 * @image html img/widget/icon/preview-00.png
4541 * @image latex img/widget/icon/preview-00.eps
4543 * An object that provides standard icon images (delete, edit, arrows, etc.)
4544 * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4546 * The icon image requested can be in the elementary theme, or in the
4547 * freedesktop.org paths. It's possible to set the order of preference from
4548 * where the image will be used.
4550 * This API is very similar to @ref Image, but with ready to use images.
4552 * Default images provided by the theme are described below.
4554 * The first list contains icons that were first intended to be used in
4555 * toolbars, but can be used in many other places too:
4571 * Now some icons that were designed to be used in menus (but again, you can
4572 * use them anywhere else):
4577 * @li menu/arrow_down
4578 * @li menu/arrow_left
4579 * @li menu/arrow_right
4588 * And here we have some media player specific icons:
4589 * @li media_player/forward
4590 * @li media_player/info
4591 * @li media_player/next
4592 * @li media_player/pause
4593 * @li media_player/play
4594 * @li media_player/prev
4595 * @li media_player/rewind
4596 * @li media_player/stop
4598 * Signals that you can add callbacks for are:
4600 * "clicked" - This is called when a user has clicked the icon
4602 * An example of usage for this API follows:
4603 * @li @ref tutorial_icon
4611 typedef enum _Elm_Icon_Type
4618 * @enum _Elm_Icon_Lookup_Order
4619 * @typedef Elm_Icon_Lookup_Order
4621 * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4622 * theme, FDO paths, or both?
4626 typedef enum _Elm_Icon_Lookup_Order
4628 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4629 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4630 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
4631 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
4632 } Elm_Icon_Lookup_Order;
4635 * Add a new icon object to the parent.
4637 * @param parent The parent object
4638 * @return The new object or NULL if it cannot be created
4640 * @see elm_icon_file_set()
4644 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4646 * Set the file that will be used as icon.
4648 * @param obj The icon object
4649 * @param file The path to file that will be used as icon image
4650 * @param group The group that the icon belongs to an edje file
4652 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4654 * @note The icon image set by this function can be changed by
4655 * elm_icon_standard_set().
4657 * @see elm_icon_file_get()
4661 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4663 * Set a location in memory to be used as an icon
4665 * @param obj The icon object
4666 * @param img The binary data that will be used as an image
4667 * @param size The size of binary data @p img
4668 * @param format Optional format of @p img to pass to the image loader
4669 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
4671 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4673 * @note The icon image set by this function can be changed by
4674 * elm_icon_standard_set().
4678 EAPI Eina_Bool elm_icon_memfile_set(Evas_Object *obj, const void *img, size_t size, const char *format, const char *key); EINA_ARG_NONNULL(1, 2);
4680 * Get the file that will be used as icon.
4682 * @param obj The icon object
4683 * @param file The path to file that will be used as the icon image
4684 * @param group The group that the icon belongs to, in edje file
4686 * @see elm_icon_file_set()
4690 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4691 EAPI void elm_icon_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4693 * Set the icon by icon standards names.
4695 * @param obj The icon object
4696 * @param name The icon name
4698 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4700 * For example, freedesktop.org defines standard icon names such as "home",
4701 * "network", etc. There can be different icon sets to match those icon
4702 * keys. The @p name given as parameter is one of these "keys", and will be
4703 * used to look in the freedesktop.org paths and elementary theme. One can
4704 * change the lookup order with elm_icon_order_lookup_set().
4706 * If name is not found in any of the expected locations and it is the
4707 * absolute path of an image file, this image will be used.
4709 * @note The icon image set by this function can be changed by
4710 * elm_icon_file_set().
4712 * @see elm_icon_standard_get()
4713 * @see elm_icon_file_set()
4717 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
4719 * Get the icon name set by icon standard names.
4721 * @param obj The icon object
4722 * @return The icon name
4724 * If the icon image was set using elm_icon_file_set() instead of
4725 * elm_icon_standard_set(), then this function will return @c NULL.
4727 * @see elm_icon_standard_set()
4731 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4733 * Set the smooth scaling for an icon object.
4735 * @param obj The icon object
4736 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4737 * otherwise. Default is @c EINA_TRUE.
4739 * Set the scaling algorithm to be used when scaling the icon image. Smooth
4740 * scaling provides a better resulting image, but is slower.
4742 * The smooth scaling should be disabled when making animations that change
4743 * the icon size, since they will be faster. Animations that don't require
4744 * resizing of the icon can keep the smooth scaling enabled (even if the icon
4745 * is already scaled, since the scaled icon image will be cached).
4747 * @see elm_icon_smooth_get()
4751 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4753 * Get whether smooth scaling is enabled for an icon object.
4755 * @param obj The icon object
4756 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4758 * @see elm_icon_smooth_set()
4762 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4764 * Disable scaling of this object.
4766 * @param obj The icon object.
4767 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4768 * otherwise. Default is @c EINA_FALSE.
4770 * This function disables scaling of the icon object through the function
4771 * elm_object_scale_set(). However, this does not affect the object
4772 * size/resize in any way. For that effect, take a look at
4773 * elm_icon_scale_set().
4775 * @see elm_icon_no_scale_get()
4776 * @see elm_icon_scale_set()
4777 * @see elm_object_scale_set()
4781 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
4783 * Get whether scaling is disabled on the object.
4785 * @param obj The icon object
4786 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
4788 * @see elm_icon_no_scale_set()
4792 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4794 * Set if the object is (up/down) resizable.
4796 * @param obj The icon object
4797 * @param scale_up A bool to set if the object is resizable up. Default is
4799 * @param scale_down A bool to set if the object is resizable down. Default
4802 * This function limits the icon object resize ability. If @p scale_up is set to
4803 * @c EINA_FALSE, the object can't have its height or width resized to a value
4804 * higher than the original icon size. Same is valid for @p scale_down.
4806 * @see elm_icon_scale_get()
4810 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
4812 * Get if the object is (up/down) resizable.
4814 * @param obj The icon object
4815 * @param scale_up A bool to set if the object is resizable up
4816 * @param scale_down A bool to set if the object is resizable down
4818 * @see elm_icon_scale_set()
4822 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
4824 * Get the object's image size
4826 * @param obj The icon object
4827 * @param w A pointer to store the width in
4828 * @param h A pointer to store the height in
4832 EAPI void elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4834 * Set if the icon fill the entire object area.
4836 * @param obj The icon object
4837 * @param fill_outside @c EINA_TRUE if the object is filled outside,
4838 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4840 * When the icon object is resized to a different aspect ratio from the
4841 * original icon image, the icon image will still keep its aspect. This flag
4842 * tells how the image should fill the object's area. They are: keep the
4843 * entire icon inside the limits of height and width of the object (@p
4844 * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
4845 * of the object, and the icon will fill the entire object (@p fill_outside
4848 * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
4849 * retain property to false. Thus, the icon image will always keep its
4850 * original aspect ratio.
4852 * @see elm_icon_fill_outside_get()
4853 * @see elm_image_fill_outside_set()
4857 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
4859 * Get if the object is filled outside.
4861 * @param obj The icon object
4862 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
4864 * @see elm_icon_fill_outside_set()
4868 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4870 * Set the prescale size for the icon.
4872 * @param obj The icon object
4873 * @param size The prescale size. This value is used for both width and
4876 * This function sets a new size for pixmap representation of the given
4877 * icon. It allows the icon to be loaded already in the specified size,
4878 * reducing the memory usage and load time when loading a big icon with load
4879 * size set to a smaller size.
4881 * It's equivalent to the elm_bg_load_size_set() function for bg.
4883 * @note this is just a hint, the real size of the pixmap may differ
4884 * depending on the type of icon being loaded, being bigger than requested.
4886 * @see elm_icon_prescale_get()
4887 * @see elm_bg_load_size_set()
4891 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
4893 * Get the prescale size for the icon.
4895 * @param obj The icon object
4896 * @return The prescale size
4898 * @see elm_icon_prescale_set()
4902 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4904 * Sets the icon lookup order used by elm_icon_standard_set().
4906 * @param obj The icon object
4907 * @param order The icon lookup order (can be one of
4908 * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
4909 * or ELM_ICON_LOOKUP_THEME)
4911 * @see elm_icon_order_lookup_get()
4912 * @see Elm_Icon_Lookup_Order
4916 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
4918 * Gets the icon lookup order.
4920 * @param obj The icon object
4921 * @return The icon lookup order
4923 * @see elm_icon_order_lookup_set()
4924 * @see Elm_Icon_Lookup_Order
4928 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4930 * Get if the icon supports animation or not.
4932 * @param obj The icon object
4933 * @return @c EINA_TRUE if the icon supports animation,
4934 * @c EINA_FALSE otherwise.
4936 * Return if this elm icon's image can be animated. Currently Evas only
4937 * supports gif animation. If the return value is EINA_FALSE, other
4938 * elm_icon_animated_XXX APIs won't work.
4941 EAPI Eina_Bool elm_icon_anim_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4943 * Set animation mode of the icon.
4945 * @param obj The icon object
4946 * @param anim @c EINA_TRUE if the object do animation job,
4947 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4949 * Since the default animation mode is set to EINA_FALSE,
4950 * the icon is shown without animation.
4951 * This might be desirable when the application developer wants to show
4952 * a snapshot of the animated icon.
4953 * Set it to EINA_TRUE when the icon needs to be animated.
4956 EAPI void elm_icon_anim_set(Evas_Object *obj, Eina_Bool anim) EINA_ARG_NONNULL(1);
4958 * Get animation mode of the icon.
4960 * @param obj The icon object
4961 * @return The animation mode of the icon object
4962 * @see elm_icon_animated_set
4965 EAPI Eina_Bool elm_icon_anim_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4967 * Set animation play mode of the icon.
4969 * @param obj The icon object
4970 * @param play @c EINA_TRUE the object play animation images,
4971 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4973 * To play elm icon's animation, set play to EINA_TURE.
4974 * For example, you make gif player using this set/get API and click event.
4976 * 1. Click event occurs
4977 * 2. Check play flag using elm_icon_animaged_play_get
4978 * 3. If elm icon was playing, set play to EINA_FALSE.
4979 * Then animation will be stopped and vice versa
4982 EAPI void elm_icon_anim_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
4984 * Get animation play mode of the icon.
4986 * @param obj The icon object
4987 * @return The play mode of the icon object
4989 * @see elm_icon_animated_play_get
4992 EAPI Eina_Bool elm_icon_anim_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5004 * @enum _Elm_Image_Orient
5005 * @typedef Elm_Image_Orient
5007 * Possible orientation options for elm_image_orient_set().
5009 * @image html elm_image_orient_set.png
5010 * @image latex elm_image_orient_set.eps width=\textwidth
5014 typedef enum _Elm_Image_Orient
5016 ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
5017 ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
5018 ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
5019 ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5020 ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
5021 ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
5022 ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
5023 ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
5027 * Add a new image to the parent.
5029 * @param parent The parent object
5030 * @return The new object or NULL if it cannot be created
5032 * @see elm_image_file_set()
5036 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5038 * Set the file that will be used as image.
5040 * @param obj The image object
5041 * @param file The path to file that will be used as image
5042 * @param group The group that the image belongs in edje file (if it's an
5045 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5047 * @see elm_image_file_get()
5051 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5053 * Get the file that will be used as image.
5055 * @param obj The image object
5056 * @param file The path to file
5057 * @param group The group that the image belongs in edje file
5059 * @see elm_image_file_set()
5063 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5065 * Set the smooth effect for an image.
5067 * @param obj The image object
5068 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5069 * otherwise. Default is @c EINA_TRUE.
5071 * Set the scaling algorithm to be used when scaling the image. Smooth
5072 * scaling provides a better resulting image, but is slower.
5074 * The smooth scaling should be disabled when making animations that change
5075 * the image size, since it will be faster. Animations that don't require
5076 * resizing of the image can keep the smooth scaling enabled (even if the
5077 * image is already scaled, since the scaled image will be cached).
5079 * @see elm_image_smooth_get()
5083 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5085 * Get the smooth effect for an image.
5087 * @param obj The image object
5088 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5090 * @see elm_image_smooth_get()
5094 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5097 * Gets the current size of the image.
5099 * @param obj The image object.
5100 * @param w Pointer to store width, or NULL.
5101 * @param h Pointer to store height, or NULL.
5103 * This is the real size of the image, not the size of the object.
5105 * On error, neither w or h will be written.
5109 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5111 * Disable scaling of this object.
5113 * @param obj The image object.
5114 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5115 * otherwise. Default is @c EINA_FALSE.
5117 * This function disables scaling of the elm_image widget through the
5118 * function elm_object_scale_set(). However, this does not affect the widget
5119 * size/resize in any way. For that effect, take a look at
5120 * elm_image_scale_set().
5122 * @see elm_image_no_scale_get()
5123 * @see elm_image_scale_set()
5124 * @see elm_object_scale_set()
5128 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5130 * Get whether scaling is disabled on the object.
5132 * @param obj The image object
5133 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5135 * @see elm_image_no_scale_set()
5139 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5141 * Set if the object is (up/down) resizable.
5143 * @param obj The image object
5144 * @param scale_up A bool to set if the object is resizable up. Default is
5146 * @param scale_down A bool to set if the object is resizable down. Default
5149 * This function limits the image resize ability. If @p scale_up is set to
5150 * @c EINA_FALSE, the object can't have its height or width resized to a value
5151 * higher than the original image size. Same is valid for @p scale_down.
5153 * @see elm_image_scale_get()
5157 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5159 * Get if the object is (up/down) resizable.
5161 * @param obj The image object
5162 * @param scale_up A bool to set if the object is resizable up
5163 * @param scale_down A bool to set if the object is resizable down
5165 * @see elm_image_scale_set()
5169 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5171 * Set if the image fills the entire object area, when keeping the aspect ratio.
5173 * @param obj The image object
5174 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5175 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5177 * When the image should keep its aspect ratio even if resized to another
5178 * aspect ratio, there are two possibilities to resize it: keep the entire
5179 * image inside the limits of height and width of the object (@p fill_outside
5180 * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5181 * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5183 * @note This option will have no effect if
5184 * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5186 * @see elm_image_fill_outside_get()
5187 * @see elm_image_aspect_ratio_retained_set()
5191 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5193 * Get if the object is filled outside
5195 * @param obj The image object
5196 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5198 * @see elm_image_fill_outside_set()
5202 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5204 * Set the prescale size for the image
5206 * @param obj The image object
5207 * @param size The prescale size. This value is used for both width and
5210 * This function sets a new size for pixmap representation of the given
5211 * image. It allows the image to be loaded already in the specified size,
5212 * reducing the memory usage and load time when loading a big image with load
5213 * size set to a smaller size.
5215 * It's equivalent to the elm_bg_load_size_set() function for bg.
5217 * @note this is just a hint, the real size of the pixmap may differ
5218 * depending on the type of image being loaded, being bigger than requested.
5220 * @see elm_image_prescale_get()
5221 * @see elm_bg_load_size_set()
5225 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5227 * Get the prescale size for the image
5229 * @param obj The image object
5230 * @return The prescale size
5232 * @see elm_image_prescale_set()
5236 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5238 * Set the image orientation.
5240 * @param obj The image object
5241 * @param orient The image orientation @ref Elm_Image_Orient
5242 * Default is #ELM_IMAGE_ORIENT_NONE.
5244 * This function allows to rotate or flip the given image.
5246 * @see elm_image_orient_get()
5247 * @see @ref Elm_Image_Orient
5251 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5253 * Get the image orientation.
5255 * @param obj The image object
5256 * @return The image orientation @ref Elm_Image_Orient
5258 * @see elm_image_orient_set()
5259 * @see @ref Elm_Image_Orient
5263 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5265 * Make the image 'editable'.
5267 * @param obj Image object.
5268 * @param set Turn on or off editability. Default is @c EINA_FALSE.
5270 * This means the image is a valid drag target for drag and drop, and can be
5271 * cut or pasted too.
5275 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5277 * Check if the image 'editable'.
5279 * @param obj Image object.
5280 * @return Editability.
5282 * A return value of EINA_TRUE means the image is a valid drag target
5283 * for drag and drop, and can be cut or pasted too.
5287 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5289 * Get the basic Evas_Image object from this object (widget).
5291 * @param obj The image object to get the inlined image from
5292 * @return The inlined image object, or NULL if none exists
5294 * This function allows one to get the underlying @c Evas_Object of type
5295 * Image from this elementary widget. It can be useful to do things like get
5296 * the pixel data, save the image to a file, etc.
5298 * @note Be careful to not manipulate it, as it is under control of
5303 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5305 * Set whether the original aspect ratio of the image should be kept on resize.
5307 * @param obj The image object.
5308 * @param retained @c EINA_TRUE if the image should retain the aspect,
5309 * @c EINA_FALSE otherwise.
5311 * The original aspect ratio (width / height) of the image is usually
5312 * distorted to match the object's size. Enabling this option will retain
5313 * this original aspect, and the way that the image is fit into the object's
5314 * area depends on the option set by elm_image_fill_outside_set().
5316 * @see elm_image_aspect_ratio_retained_get()
5317 * @see elm_image_fill_outside_set()
5321 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5323 * Get if the object retains the original aspect ratio.
5325 * @param obj The image object.
5326 * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5331 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5340 * A simple GLView widget that allows GL rendering.
5342 * Signals that you can add callbacks for are:
5346 typedef void (*Elm_GLView_Func)(Evas_Object *obj);
5348 typedef enum _Elm_GLView_Mode
5350 ELM_GLVIEW_ALPHA = 1,
5351 ELM_GLVIEW_DEPTH = 2,
5352 ELM_GLVIEW_STENCIL = 4
5355 typedef enum _Elm_GLView_Resize_Policy
5357 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
5358 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
5359 } Elm_GLView_Resize_Policy;
5361 typedef enum _Elm_GLView_Render_Policy
5363 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
5364 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
5365 } Elm_GLView_Render_Policy;
5369 * Add a new glview to the parent
5371 * @param parent The parent object
5372 * @return The new object or NULL if it cannot be created
5376 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5379 * Sets the size of the glview
5381 * @param obj The glview object
5382 * @param width width of the glview object
5383 * @param height height of the glview object
5387 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5390 * Gets the size of the glview.
5392 * @param obj The glview object
5393 * @param width width of the glview object
5394 * @param height height of the glview object
5396 * Note that this function returns the actual image size of the
5397 * glview. This means that when the scale policy is set to
5398 * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5403 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5406 * Gets the gl api struct for gl rendering
5408 * @param obj The glview object
5409 * @return The api object or NULL if it cannot be created
5413 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5416 * Set the mode of the GLView. Supports Three simple modes.
5418 * @param obj The glview object
5419 * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5420 * @return True if set properly.
5424 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5427 * Set the resize policy for the glview object.
5429 * @param obj The glview object.
5430 * @param policy The scaling policy.
5432 * By default, the resize policy is set to
5433 * ELM_GLVIEW_RESIZE_POLICY_RECREATE. When resize is called it
5434 * destroys the previous surface and recreates the newly specified
5435 * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5436 * however, glview only scales the image object and not the underlying
5441 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5444 * Set the render policy for the glview object.
5446 * @param obj The glview object.
5447 * @param policy The render policy.
5449 * By default, the render policy is set to
5450 * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND. This policy is set such
5451 * that during the render loop, glview is only redrawn if it needs
5452 * to be redrawn. (i.e. When it is visible) If the policy is set to
5453 * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5454 * whether it is visible/need redrawing or not.
5458 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5461 * Set the init function that runs once in the main loop.
5463 * @param obj The glview object.
5464 * @param func The init function to be registered.
5466 * The registered init function gets called once during the render loop.
5470 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
5473 * Set the render function that runs in the main loop.
5475 * @param obj The glview object.
5476 * @param func The delete function to be registered.
5478 * The registered del function gets called when GLView object is deleted.
5482 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
5485 * Set the resize function that gets called when resize happens.
5487 * @param obj The glview object.
5488 * @param func The resize function to be registered.
5492 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
5495 * Set the render function that runs in the main loop.
5497 * @param obj The glview object.
5498 * @param func The render function to be registered.
5502 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
5505 * Notifies that there has been changes in the GLView.
5507 * @param obj The glview object.
5511 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5521 * A box arranges objects in a linear fashion, governed by a layout function
5522 * that defines the details of this arrangement.
5524 * By default, the box will use an internal function to set the layout to
5525 * a single row, either vertical or horizontal. This layout is affected
5526 * by a number of parameters, such as the homogeneous flag set by
5527 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5528 * elm_box_align_set() and the hints set to each object in the box.
5530 * For this default layout, it's possible to change the orientation with
5531 * elm_box_horizontal_set(). The box will start in the vertical orientation,
5532 * placing its elements ordered from top to bottom. When horizontal is set,
5533 * the order will go from left to right. If the box is set to be
5534 * homogeneous, every object in it will be assigned the same space, that
5535 * of the largest object. Padding can be used to set some spacing between
5536 * the cell given to each object. The alignment of the box, set with
5537 * elm_box_align_set(), determines how the bounding box of all the elements
5538 * will be placed within the space given to the box widget itself.
5540 * The size hints of each object also affect how they are placed and sized
5541 * within the box. evas_object_size_hint_min_set() will give the minimum
5542 * size the object can have, and the box will use it as the basis for all
5543 * latter calculations. Elementary widgets set their own minimum size as
5544 * needed, so there's rarely any need to use it manually.
5546 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5547 * used to tell whether the object will be allocated the minimum size it
5548 * needs or if the space given to it should be expanded. It's important
5549 * to realize that expanding the size given to the object is not the same
5550 * thing as resizing the object. It could very well end being a small
5551 * widget floating in a much larger empty space. If not set, the weight
5552 * for objects will normally be 0.0 for both axis, meaning the widget will
5553 * not be expanded. To take as much space possible, set the weight to
5554 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5556 * Besides how much space each object is allocated, it's possible to control
5557 * how the widget will be placed within that space using
5558 * evas_object_size_hint_align_set(). By default, this value will be 0.5
5559 * for both axis, meaning the object will be centered, but any value from
5560 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5561 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5562 * is -1.0, means the object will be resized to fill the entire space it
5565 * In addition, customized functions to define the layout can be set, which
5566 * allow the application developer to organize the objects within the box
5567 * in any number of ways.
5569 * The special elm_box_layout_transition() function can be used
5570 * to switch from one layout to another, animating the motion of the
5571 * children of the box.
5573 * @note Objects should not be added to box objects using _add() calls.
5575 * Some examples on how to use boxes follow:
5576 * @li @ref box_example_01
5577 * @li @ref box_example_02
5582 * @typedef Elm_Box_Transition
5584 * Opaque handler containing the parameters to perform an animated
5585 * transition of the layout the box uses.
5587 * @see elm_box_transition_new()
5588 * @see elm_box_layout_set()
5589 * @see elm_box_layout_transition()
5591 typedef struct _Elm_Box_Transition Elm_Box_Transition;
5594 * Add a new box to the parent
5596 * By default, the box will be in vertical mode and non-homogeneous.
5598 * @param parent The parent object
5599 * @return The new object or NULL if it cannot be created
5601 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5603 * Set the horizontal orientation
5605 * By default, box object arranges their contents vertically from top to
5607 * By calling this function with @p horizontal as EINA_TRUE, the box will
5608 * become horizontal, arranging contents from left to right.
5610 * @note This flag is ignored if a custom layout function is set.
5612 * @param obj The box object
5613 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5614 * EINA_FALSE = vertical)
5616 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5618 * Get the horizontal orientation
5620 * @param obj The box object
5621 * @return EINA_TRUE if the box is set to horizintal mode, EINA_FALSE otherwise
5623 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5625 * Set the box to arrange its children homogeneously
5627 * If enabled, homogeneous layout makes all items the same size, according
5628 * to the size of the largest of its children.
5630 * @note This flag is ignored if a custom layout function is set.
5632 * @param obj The box object
5633 * @param homogeneous The homogeneous flag
5635 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5637 * Get whether the box is using homogeneous mode or not
5639 * @param obj The box object
5640 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5642 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5643 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5644 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5646 * Add an object to the beginning of the pack list
5648 * Pack @p subobj into the box @p obj, placing it first in the list of
5649 * children objects. The actual position the object will get on screen
5650 * depends on the layout used. If no custom layout is set, it will be at
5651 * the top or left, depending if the box is vertical or horizontal,
5654 * @param obj The box object
5655 * @param subobj The object to add to the box
5657 * @see elm_box_pack_end()
5658 * @see elm_box_pack_before()
5659 * @see elm_box_pack_after()
5660 * @see elm_box_unpack()
5661 * @see elm_box_unpack_all()
5662 * @see elm_box_clear()
5664 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5666 * Add an object at the end of the pack list
5668 * Pack @p subobj into the box @p obj, placing it last in the list of
5669 * children objects. The actual position the object will get on screen
5670 * depends on the layout used. If no custom layout is set, it will be at
5671 * the bottom or right, depending if the box is vertical or horizontal,
5674 * @param obj The box object
5675 * @param subobj The object to add to the box
5677 * @see elm_box_pack_start()
5678 * @see elm_box_pack_before()
5679 * @see elm_box_pack_after()
5680 * @see elm_box_unpack()
5681 * @see elm_box_unpack_all()
5682 * @see elm_box_clear()
5684 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5686 * Adds an object to the box before the indicated object
5688 * This will add the @p subobj to the box indicated before the object
5689 * indicated with @p before. If @p before is not already in the box, results
5690 * are undefined. Before means either to the left of the indicated object or
5691 * above it depending on orientation.
5693 * @param obj The box object
5694 * @param subobj The object to add to the box
5695 * @param before The object before which to add it
5697 * @see elm_box_pack_start()
5698 * @see elm_box_pack_end()
5699 * @see elm_box_pack_after()
5700 * @see elm_box_unpack()
5701 * @see elm_box_unpack_all()
5702 * @see elm_box_clear()
5704 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
5706 * Adds an object to the box after the indicated object
5708 * This will add the @p subobj to the box indicated after the object
5709 * indicated with @p after. If @p after is not already in the box, results
5710 * are undefined. After means either to the right of the indicated object or
5711 * below it depending on orientation.
5713 * @param obj The box object
5714 * @param subobj The object to add to the box
5715 * @param after The object after which to add it
5717 * @see elm_box_pack_start()
5718 * @see elm_box_pack_end()
5719 * @see elm_box_pack_before()
5720 * @see elm_box_unpack()
5721 * @see elm_box_unpack_all()
5722 * @see elm_box_clear()
5724 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
5726 * Clear the box of all children
5728 * Remove all the elements contained by the box, deleting the respective
5731 * @param obj The box object
5733 * @see elm_box_unpack()
5734 * @see elm_box_unpack_all()
5736 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5740 * Remove the object given by @p subobj from the box @p obj without
5743 * @param obj The box object
5745 * @see elm_box_unpack_all()
5746 * @see elm_box_clear()
5748 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5750 * Remove all items from the box, without deleting them
5752 * Clear the box from all children, but don't delete the respective objects.
5753 * If no other references of the box children exist, the objects will never
5754 * be deleted, and thus the application will leak the memory. Make sure
5755 * when using this function that you hold a reference to all the objects
5756 * in the box @p obj.
5758 * @param obj The box object
5760 * @see elm_box_clear()
5761 * @see elm_box_unpack()
5763 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5765 * Retrieve a list of the objects packed into the box
5767 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
5768 * The order of the list corresponds to the packing order the box uses.
5770 * You must free this list with eina_list_free() once you are done with it.
5772 * @param obj The box object
5774 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5776 * Set the space (padding) between the box's elements.
5778 * Extra space in pixels that will be added between a box child and its
5779 * neighbors after its containing cell has been calculated. This padding
5780 * is set for all elements in the box, besides any possible padding that
5781 * individual elements may have through their size hints.
5783 * @param obj The box object
5784 * @param horizontal The horizontal space between elements
5785 * @param vertical The vertical space between elements
5787 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5789 * Get the space (padding) between the box's elements.
5791 * @param obj The box object
5792 * @param horizontal The horizontal space between elements
5793 * @param vertical The vertical space between elements
5795 * @see elm_box_padding_set()
5797 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5799 * Set the alignment of the whole bouding box of contents.
5801 * Sets how the bounding box containing all the elements of the box, after
5802 * their sizes and position has been calculated, will be aligned within
5803 * the space given for the whole box widget.
5805 * @param obj The box object
5806 * @param horizontal The horizontal alignment of elements
5807 * @param vertical The vertical alignment of elements
5809 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
5811 * Get the alignment of the whole bouding box of contents.
5813 * @param obj The box object
5814 * @param horizontal The horizontal alignment of elements
5815 * @param vertical The vertical alignment of elements
5817 * @see elm_box_align_set()
5819 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
5822 * Set the layout defining function to be used by the box
5824 * Whenever anything changes that requires the box in @p obj to recalculate
5825 * the size and position of its elements, the function @p cb will be called
5826 * to determine what the layout of the children will be.
5828 * Once a custom function is set, everything about the children layout
5829 * is defined by it. The flags set by elm_box_horizontal_set() and
5830 * elm_box_homogeneous_set() no longer have any meaning, and the values
5831 * given by elm_box_padding_set() and elm_box_align_set() are up to this
5832 * layout function to decide if they are used and how. These last two
5833 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
5834 * passed to @p cb. The @c Evas_Object the function receives is not the
5835 * Elementary widget, but the internal Evas Box it uses, so none of the
5836 * functions described here can be used on it.
5838 * Any of the layout functions in @c Evas can be used here, as well as the
5839 * special elm_box_layout_transition().
5841 * The final @p data argument received by @p cb is the same @p data passed
5842 * here, and the @p free_data function will be called to free it
5843 * whenever the box is destroyed or another layout function is set.
5845 * Setting @p cb to NULL will revert back to the default layout function.
5847 * @param obj The box object
5848 * @param cb The callback function used for layout
5849 * @param data Data that will be passed to layout function
5850 * @param free_data Function called to free @p data
5852 * @see elm_box_layout_transition()
5854 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);
5856 * Special layout function that animates the transition from one layout to another
5858 * Normally, when switching the layout function for a box, this will be
5859 * reflected immediately on screen on the next render, but it's also
5860 * possible to do this through an animated transition.
5862 * This is done by creating an ::Elm_Box_Transition and setting the box
5863 * layout to this function.
5867 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
5868 * evas_object_box_layout_vertical, // start
5869 * NULL, // data for initial layout
5870 * NULL, // free function for initial data
5871 * evas_object_box_layout_horizontal, // end
5872 * NULL, // data for final layout
5873 * NULL, // free function for final data
5874 * anim_end, // will be called when animation ends
5875 * NULL); // data for anim_end function\
5876 * elm_box_layout_set(box, elm_box_layout_transition, t,
5877 * elm_box_transition_free);
5880 * @note This function can only be used with elm_box_layout_set(). Calling
5881 * it directly will not have the expected results.
5883 * @see elm_box_transition_new
5884 * @see elm_box_transition_free
5885 * @see elm_box_layout_set
5887 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
5889 * Create a new ::Elm_Box_Transition to animate the switch of layouts
5891 * If you want to animate the change from one layout to another, you need
5892 * to set the layout function of the box to elm_box_layout_transition(),
5893 * passing as user data to it an instance of ::Elm_Box_Transition with the
5894 * necessary information to perform this animation. The free function to
5895 * set for the layout is elm_box_transition_free().
5897 * The parameters to create an ::Elm_Box_Transition sum up to how long
5898 * will it be, in seconds, a layout function to describe the initial point,
5899 * another for the final position of the children and one function to be
5900 * called when the whole animation ends. This last function is useful to
5901 * set the definitive layout for the box, usually the same as the end
5902 * layout for the animation, but could be used to start another transition.
5904 * @param start_layout The layout function that will be used to start the animation
5905 * @param start_layout_data The data to be passed the @p start_layout function
5906 * @param start_layout_free_data Function to free @p start_layout_data
5907 * @param end_layout The layout function that will be used to end the animation
5908 * @param end_layout_free_data The data to be passed the @p end_layout function
5909 * @param end_layout_free_data Function to free @p end_layout_data
5910 * @param transition_end_cb Callback function called when animation ends
5911 * @param transition_end_data Data to be passed to @p transition_end_cb
5912 * @return An instance of ::Elm_Box_Transition
5914 * @see elm_box_transition_new
5915 * @see elm_box_layout_transition
5917 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);
5919 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
5921 * This function is mostly useful as the @c free_data parameter in
5922 * elm_box_layout_set() when elm_box_layout_transition().
5924 * @param data The Elm_Box_Transition instance to be freed.
5926 * @see elm_box_transition_new
5927 * @see elm_box_layout_transition
5929 EAPI void elm_box_transition_free(void *data);
5936 * @defgroup Button Button
5938 * @image html widget/button/preview-00.png
5939 * @image html widget/button/preview-01.png
5940 * @image html widget/button/preview-02.png
5942 * This is a push-button. Press it and run some function. It can contain
5943 * a simple label and icon object and it also has an autorepeat feature.
5945 * This widgets emits the following signals:
5946 * @li "clicked": the user clicked the button (press/release).
5947 * @li "repeated": the user pressed the button without releasing it.
5948 * @li "pressed": button was pressed.
5949 * @li "unpressed": button was released after being pressed.
5950 * In all three cases, the @c event parameter of the callback will be
5953 * Also, defined in the default theme, the button has the following styles
5955 * @li default: a normal button.
5956 * @li anchor: Like default, but the button fades away when the mouse is not
5957 * over it, leaving only the text or icon.
5958 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
5959 * continuous look across its options.
5960 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
5962 * Follow through a complete example @ref button_example_01 "here".
5968 UIControlStateDefault,
5969 UIControlStateHighlighted,
5970 UIControlStateDisabled,
5971 UIControlStateFocused,
5972 UIControlStateReserved
5976 * Add a new button to the parent's canvas
5978 * @param parent The parent object
5979 * @return The new object or NULL if it cannot be created
5981 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5983 * Set the label used in the button
5985 * The passed @p label can be NULL to clean any existing text in it and
5986 * leave the button as an icon only object.
5988 * @param obj The button object
5989 * @param label The text will be written on the button
5990 * @deprecated use elm_object_text_set() instead.
5992 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5994 * Get the label set for the button
5996 * The string returned is an internal pointer and should not be freed or
5997 * altered. It will also become invalid when the button is destroyed.
5998 * The string returned, if not NULL, is a stringshare, so if you need to
5999 * keep it around even after the button is destroyed, you can use
6000 * eina_stringshare_ref().
6002 * @param obj The button object
6003 * @return The text set to the label, or NULL if nothing is set
6004 * @deprecated use elm_object_text_set() instead.
6006 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6008 * Set the label for each state of button
6010 * The passed @p label can be NULL to clean any existing text in it and
6011 * leave the button as an icon only object for the state.
6013 * @param obj The button object
6014 * @param label The text will be written on the button
6015 * @param state The state of button
6019 EINA_DEPRECATED EAPI void elm_button_label_set_for_state(Evas_Object *obj, const char *label, UIControlState state) EINA_ARG_NONNULL(1);
6021 * Get the label of button for each state
6023 * The string returned is an internal pointer and should not be freed or
6024 * altered. It will also become invalid when the button is destroyed.
6025 * The string returned, if not NULL, is a stringshare, so if you need to
6026 * keep it around even after the button is destroyed, you can use
6027 * eina_stringshare_ref().
6029 * @param obj The button object
6030 * @param state The state of button
6031 * @return The title of button for state
6035 EINA_DEPRECATED EAPI const char *elm_button_label_get_for_state(const Evas_Object *obj, UIControlState state) EINA_ARG_NONNULL(1);
6037 * Set the icon used for the button
6039 * Setting a new icon will delete any other that was previously set, making
6040 * any reference to them invalid. If you need to maintain the previous
6041 * object alive, unset it first with elm_button_icon_unset().
6043 * @param obj The button object
6044 * @param icon The icon object for the button
6046 EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6048 * Get the icon used for the button
6050 * Return the icon object which is set for this widget. If the button is
6051 * destroyed or another icon is set, the returned object will be deleted
6052 * and any reference to it will be invalid.
6054 * @param obj The button object
6055 * @return The icon object that is being used
6057 * @see elm_button_icon_unset()
6059 EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6061 * Remove the icon set without deleting it and return the object
6063 * This function drops the reference the button holds of the icon object
6064 * and returns this last object. It is used in case you want to remove any
6065 * icon, or set another one, without deleting the actual object. The button
6066 * will be left without an icon set.
6068 * @param obj The button object
6069 * @return The icon object that was being used
6071 EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6073 * Turn on/off the autorepeat event generated when the button is kept pressed
6075 * When off, no autorepeat is performed and buttons emit a normal @c clicked
6076 * signal when they are clicked.
6078 * When on, keeping a button pressed will continuously emit a @c repeated
6079 * signal until the button is released. The time it takes until it starts
6080 * emitting the signal is given by
6081 * elm_button_autorepeat_initial_timeout_set(), and the time between each
6082 * new emission by elm_button_autorepeat_gap_timeout_set().
6084 * @param obj The button object
6085 * @param on A bool to turn on/off the event
6087 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6089 * Get whether the autorepeat feature is enabled
6091 * @param obj The button object
6092 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6094 * @see elm_button_autorepeat_set()
6096 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6098 * Set the initial timeout before the autorepeat event is generated
6100 * Sets the timeout, in seconds, since the button is pressed until the
6101 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6102 * won't be any delay and the even will be fired the moment the button is
6105 * @param obj The button object
6106 * @param t Timeout in seconds
6108 * @see elm_button_autorepeat_set()
6109 * @see elm_button_autorepeat_gap_timeout_set()
6111 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6113 * Get the initial timeout before the autorepeat event is generated
6115 * @param obj The button object
6116 * @return Timeout in seconds
6118 * @see elm_button_autorepeat_initial_timeout_set()
6120 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6122 * Set the interval between each generated autorepeat event
6124 * After the first @c repeated event is fired, all subsequent ones will
6125 * follow after a delay of @p t seconds for each.
6127 * @param obj The button object
6128 * @param t Interval in seconds
6130 * @see elm_button_autorepeat_initial_timeout_set()
6132 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6134 * Get the interval between each generated autorepeat event
6136 * @param obj The button object
6137 * @return Interval in seconds
6139 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6145 * @defgroup File_Selector_Button File Selector Button
6147 * @image html img/widget/fileselector_button/preview-00.png
6148 * @image latex img/widget/fileselector_button/preview-00.eps
6149 * @image html img/widget/fileselector_button/preview-01.png
6150 * @image latex img/widget/fileselector_button/preview-01.eps
6151 * @image html img/widget/fileselector_button/preview-02.png
6152 * @image latex img/widget/fileselector_button/preview-02.eps
6154 * This is a button that, when clicked, creates an Elementary
6155 * window (or inner window) <b> with a @ref Fileselector "file
6156 * selector widget" within</b>. When a file is chosen, the (inner)
6157 * window is closed and the button emits a signal having the
6158 * selected file as it's @c event_info.
6160 * This widget encapsulates operations on its internal file
6161 * selector on its own API. There is less control over its file
6162 * selector than that one would have instatiating one directly.
6164 * The following styles are available for this button:
6167 * @li @c "hoversel_vertical"
6168 * @li @c "hoversel_vertical_entry"
6170 * Smart callbacks one can register to:
6171 * - @c "file,chosen" - the user has selected a path, whose string
6172 * pointer comes as the @c event_info data (a stringshared
6175 * Here is an example on its usage:
6176 * @li @ref fileselector_button_example
6178 * @see @ref File_Selector_Entry for a similar widget.
6183 * Add a new file selector button widget to the given parent
6184 * Elementary (container) object
6186 * @param parent The parent object
6187 * @return a new file selector button widget handle or @c NULL, on
6190 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6193 * Set the label for a given file selector button widget
6195 * @param obj The file selector button widget
6196 * @param label The text label to be displayed on @p obj
6198 * @deprecated use elm_object_text_set() instead.
6200 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6203 * Get the label set for a given file selector button widget
6205 * @param obj The file selector button widget
6206 * @return The button label
6208 * @deprecated use elm_object_text_set() instead.
6210 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6213 * Set the icon on a given file selector button widget
6215 * @param obj The file selector button widget
6216 * @param icon The icon object for the button
6218 * Once the icon object is set, a previously set one will be
6219 * deleted. If you want to keep the latter, use the
6220 * elm_fileselector_button_icon_unset() function.
6222 * @see elm_fileselector_button_icon_get()
6224 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6227 * Get the icon set for a given file selector button widget
6229 * @param obj The file selector button widget
6230 * @return The icon object currently set on @p obj or @c NULL, if
6233 * @see elm_fileselector_button_icon_set()
6235 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6238 * Unset the icon used in a given file selector button widget
6240 * @param obj The file selector button widget
6241 * @return The icon object that was being used on @p obj or @c
6244 * Unparent and return the icon object which was set for this
6247 * @see elm_fileselector_button_icon_set()
6249 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6252 * Set the title for a given file selector button widget's window
6254 * @param obj The file selector button widget
6255 * @param title The title string
6257 * This will change the window's title, when the file selector pops
6258 * out after a click on the button. Those windows have the default
6259 * (unlocalized) value of @c "Select a file" as titles.
6261 * @note It will only take any effect if the file selector
6262 * button widget is @b not under "inwin mode".
6264 * @see elm_fileselector_button_window_title_get()
6266 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6269 * Get the title set for a given file selector button widget's
6272 * @param obj The file selector button widget
6273 * @return Title of the file selector button's window
6275 * @see elm_fileselector_button_window_title_get() for more details
6277 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6280 * Set the size of a given file selector button widget's window,
6281 * holding the file selector itself.
6283 * @param obj The file selector button widget
6284 * @param width The window's width
6285 * @param height The window's height
6287 * @note it will only take any effect if the file selector button
6288 * widget is @b not under "inwin mode". The default size for the
6289 * window (when applicable) is 400x400 pixels.
6291 * @see elm_fileselector_button_window_size_get()
6293 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6296 * Get the size of a given file selector button widget's window,
6297 * holding the file selector itself.
6299 * @param obj The file selector button widget
6300 * @param width Pointer into which to store the width value
6301 * @param height Pointer into which to store the height value
6303 * @note Use @c NULL pointers on the size values you're not
6304 * interested in: they'll be ignored by the function.
6306 * @see elm_fileselector_button_window_size_set(), for more details
6308 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6311 * Set the initial file system path for a given file selector
6314 * @param obj The file selector button widget
6315 * @param path The path string
6317 * It must be a <b>directory</b> path, which will have the contents
6318 * displayed initially in the file selector's view, when invoked
6319 * from @p obj. The default initial path is the @c "HOME"
6320 * environment variable's value.
6322 * @see elm_fileselector_button_path_get()
6324 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6327 * Get the initial file system path set for a given file selector
6330 * @param obj The file selector button widget
6331 * @return path The path string
6333 * @see elm_fileselector_button_path_set() for more details
6335 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6338 * Enable/disable a tree view in the given file selector button
6339 * widget's internal file selector
6341 * @param obj The file selector button widget
6342 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6345 * This has the same effect as elm_fileselector_expandable_set(),
6346 * but now applied to a file selector button's internal file
6349 * @note There's no way to put a file selector button's internal
6350 * file selector in "grid mode", as one may do with "pure" file
6353 * @see elm_fileselector_expandable_get()
6355 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6358 * Get whether tree view is enabled for the given file selector
6359 * button widget's internal file selector
6361 * @param obj The file selector button widget
6362 * @return @c EINA_TRUE if @p obj widget's internal file selector
6363 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6365 * @see elm_fileselector_expandable_set() for more details
6367 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6370 * Set whether a given file selector button widget's internal file
6371 * selector is to display folders only or the directory contents,
6374 * @param obj The file selector button widget
6375 * @param only @c EINA_TRUE to make @p obj widget's internal file
6376 * selector only display directories, @c EINA_FALSE to make files
6377 * to be displayed in it too
6379 * This has the same effect as elm_fileselector_folder_only_set(),
6380 * but now applied to a file selector button's internal file
6383 * @see elm_fileselector_folder_only_get()
6385 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6388 * Get whether a given file selector button widget's internal file
6389 * selector is displaying folders only or the directory contents,
6392 * @param obj The file selector button widget
6393 * @return @c EINA_TRUE if @p obj widget's internal file
6394 * selector is only displaying directories, @c EINA_FALSE if files
6395 * are being displayed in it too (and on errors)
6397 * @see elm_fileselector_button_folder_only_set() for more details
6399 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6402 * Enable/disable the file name entry box where the user can type
6403 * in a name for a file, in a given file selector button widget's
6404 * internal file selector.
6406 * @param obj The file selector button widget
6407 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6408 * file selector a "saving dialog", @c EINA_FALSE otherwise
6410 * This has the same effect as elm_fileselector_is_save_set(),
6411 * but now applied to a file selector button's internal file
6414 * @see elm_fileselector_is_save_get()
6416 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6419 * Get whether the given file selector button widget's internal
6420 * file selector is in "saving dialog" mode
6422 * @param obj The file selector button widget
6423 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6424 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6427 * @see elm_fileselector_button_is_save_set() for more details
6429 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6432 * Set whether a given file selector button widget's internal file
6433 * selector will raise an Elementary "inner window", instead of a
6434 * dedicated Elementary window. By default, it won't.
6436 * @param obj The file selector button widget
6437 * @param value @c EINA_TRUE to make it use an inner window, @c
6438 * EINA_TRUE to make it use a dedicated window
6440 * @see elm_win_inwin_add() for more information on inner windows
6441 * @see elm_fileselector_button_inwin_mode_get()
6443 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6446 * Get whether a given file selector button widget's internal file
6447 * selector will raise an Elementary "inner window", instead of a
6448 * dedicated Elementary window.
6450 * @param obj The file selector button widget
6451 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6452 * if it will use a dedicated window
6454 * @see elm_fileselector_button_inwin_mode_set() for more details
6456 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6463 * @defgroup File_Selector_Entry File Selector Entry
6465 * @image html img/widget/fileselector_entry/preview-00.png
6466 * @image latex img/widget/fileselector_entry/preview-00.eps
6468 * This is an entry made to be filled with or display a <b>file
6469 * system path string</b>. Besides the entry itself, the widget has
6470 * a @ref File_Selector_Button "file selector button" on its side,
6471 * which will raise an internal @ref Fileselector "file selector widget",
6472 * when clicked, for path selection aided by file system
6475 * This file selector may appear in an Elementary window or in an
6476 * inner window. When a file is chosen from it, the (inner) window
6477 * is closed and the selected file's path string is exposed both as
6478 * an smart event and as the new text on the entry.
6480 * This widget encapsulates operations on its internal file
6481 * selector on its own API. There is less control over its file
6482 * selector than that one would have instatiating one directly.
6484 * Smart callbacks one can register to:
6485 * - @c "changed" - The text within the entry was changed
6486 * - @c "activated" - The entry has had editing finished and
6487 * changes are to be "committed"
6488 * - @c "press" - The entry has been clicked
6489 * - @c "longpressed" - The entry has been clicked (and held) for a
6491 * - @c "clicked" - The entry has been clicked
6492 * - @c "clicked,double" - The entry has been double clicked
6493 * - @c "focused" - The entry has received focus
6494 * - @c "unfocused" - The entry has lost focus
6495 * - @c "selection,paste" - A paste action has occurred on the
6497 * - @c "selection,copy" - A copy action has occurred on the entry
6498 * - @c "selection,cut" - A cut action has occurred on the entry
6499 * - @c "unpressed" - The file selector entry's button was released
6500 * after being pressed.
6501 * - @c "file,chosen" - The user has selected a path via the file
6502 * selector entry's internal file selector, whose string pointer
6503 * comes as the @c event_info data (a stringshared string)
6505 * Here is an example on its usage:
6506 * @li @ref fileselector_entry_example
6508 * @see @ref File_Selector_Button for a similar widget.
6513 * Add a new file selector entry widget to the given parent
6514 * Elementary (container) object
6516 * @param parent The parent object
6517 * @return a new file selector entry widget handle or @c NULL, on
6520 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6523 * Set the label for a given file selector entry widget's button
6525 * @param obj The file selector entry widget
6526 * @param label The text label to be displayed on @p obj widget's
6529 * @deprecated use elm_object_text_set() instead.
6531 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6534 * Get the label set for a given file selector entry widget's button
6536 * @param obj The file selector entry widget
6537 * @return The widget button's label
6539 * @deprecated use elm_object_text_set() instead.
6541 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6544 * Set the icon on a given file selector entry widget's button
6546 * @param obj The file selector entry widget
6547 * @param icon The icon object for the entry's button
6549 * Once the icon object is set, a previously set one will be
6550 * deleted. If you want to keep the latter, use the
6551 * elm_fileselector_entry_button_icon_unset() function.
6553 * @see elm_fileselector_entry_button_icon_get()
6555 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6558 * Get the icon set for a given file selector entry widget's button
6560 * @param obj The file selector entry widget
6561 * @return The icon object currently set on @p obj widget's button
6562 * or @c NULL, if none is
6564 * @see elm_fileselector_entry_button_icon_set()
6566 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6569 * Unset the icon used in a given file selector entry widget's
6572 * @param obj The file selector entry widget
6573 * @return The icon object that was being used on @p obj widget's
6574 * button or @c NULL, on errors
6576 * Unparent and return the icon object which was set for this
6579 * @see elm_fileselector_entry_button_icon_set()
6581 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6584 * Set the title for a given file selector entry widget's window
6586 * @param obj The file selector entry widget
6587 * @param title The title string
6589 * This will change the window's title, when the file selector pops
6590 * out after a click on the entry's button. Those windows have the
6591 * default (unlocalized) value of @c "Select a file" as titles.
6593 * @note It will only take any effect if the file selector
6594 * entry widget is @b not under "inwin mode".
6596 * @see elm_fileselector_entry_window_title_get()
6598 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6601 * Get the title set for a given file selector entry widget's
6604 * @param obj The file selector entry widget
6605 * @return Title of the file selector entry's window
6607 * @see elm_fileselector_entry_window_title_get() for more details
6609 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6612 * Set the size of a given file selector entry widget's window,
6613 * holding the file selector itself.
6615 * @param obj The file selector entry widget
6616 * @param width The window's width
6617 * @param height The window's height
6619 * @note it will only take any effect if the file selector entry
6620 * widget is @b not under "inwin mode". The default size for the
6621 * window (when applicable) is 400x400 pixels.
6623 * @see elm_fileselector_entry_window_size_get()
6625 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6628 * Get the size of a given file selector entry widget's window,
6629 * holding the file selector itself.
6631 * @param obj The file selector entry widget
6632 * @param width Pointer into which to store the width value
6633 * @param height Pointer into which to store the height value
6635 * @note Use @c NULL pointers on the size values you're not
6636 * interested in: they'll be ignored by the function.
6638 * @see elm_fileselector_entry_window_size_set(), for more details
6640 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6643 * Set the initial file system path and the entry's path string for
6644 * a given file selector entry widget
6646 * @param obj The file selector entry widget
6647 * @param path The path string
6649 * It must be a <b>directory</b> path, which will have the contents
6650 * displayed initially in the file selector's view, when invoked
6651 * from @p obj. The default initial path is the @c "HOME"
6652 * environment variable's value.
6654 * @see elm_fileselector_entry_path_get()
6656 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6659 * Get the entry's path string for a given file selector entry
6662 * @param obj The file selector entry widget
6663 * @return path The path string
6665 * @see elm_fileselector_entry_path_set() for more details
6667 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6670 * Enable/disable a tree view in the given file selector entry
6671 * widget's internal file selector
6673 * @param obj The file selector entry widget
6674 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6677 * This has the same effect as elm_fileselector_expandable_set(),
6678 * but now applied to a file selector entry's internal file
6681 * @note There's no way to put a file selector entry's internal
6682 * file selector in "grid mode", as one may do with "pure" file
6685 * @see elm_fileselector_expandable_get()
6687 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6690 * Get whether tree view is enabled for the given file selector
6691 * entry widget's internal file selector
6693 * @param obj The file selector entry widget
6694 * @return @c EINA_TRUE if @p obj widget's internal file selector
6695 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6697 * @see elm_fileselector_expandable_set() for more details
6699 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6702 * Set whether a given file selector entry widget's internal file
6703 * selector is to display folders only or the directory contents,
6706 * @param obj The file selector entry widget
6707 * @param only @c EINA_TRUE to make @p obj widget's internal file
6708 * selector only display directories, @c EINA_FALSE to make files
6709 * to be displayed in it too
6711 * This has the same effect as elm_fileselector_folder_only_set(),
6712 * but now applied to a file selector entry's internal file
6715 * @see elm_fileselector_folder_only_get()
6717 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6720 * Get whether a given file selector entry widget's internal file
6721 * selector is displaying folders only or the directory contents,
6724 * @param obj The file selector entry widget
6725 * @return @c EINA_TRUE if @p obj widget's internal file
6726 * selector is only displaying directories, @c EINA_FALSE if files
6727 * are being displayed in it too (and on errors)
6729 * @see elm_fileselector_entry_folder_only_set() for more details
6731 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6734 * Enable/disable the file name entry box where the user can type
6735 * in a name for a file, in a given file selector entry widget's
6736 * internal file selector.
6738 * @param obj The file selector entry widget
6739 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6740 * file selector a "saving dialog", @c EINA_FALSE otherwise
6742 * This has the same effect as elm_fileselector_is_save_set(),
6743 * but now applied to a file selector entry's internal file
6746 * @see elm_fileselector_is_save_get()
6748 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6751 * Get whether the given file selector entry widget's internal
6752 * file selector is in "saving dialog" mode
6754 * @param obj The file selector entry widget
6755 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6756 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6759 * @see elm_fileselector_entry_is_save_set() for more details
6761 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6764 * Set whether a given file selector entry widget's internal file
6765 * selector will raise an Elementary "inner window", instead of a
6766 * dedicated Elementary window. By default, it won't.
6768 * @param obj The file selector entry widget
6769 * @param value @c EINA_TRUE to make it use an inner window, @c
6770 * EINA_TRUE to make it use a dedicated window
6772 * @see elm_win_inwin_add() for more information on inner windows
6773 * @see elm_fileselector_entry_inwin_mode_get()
6775 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6778 * Get whether a given file selector entry widget's internal file
6779 * selector will raise an Elementary "inner window", instead of a
6780 * dedicated Elementary window.
6782 * @param obj The file selector entry widget
6783 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6784 * if it will use a dedicated window
6786 * @see elm_fileselector_entry_inwin_mode_set() for more details
6788 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6791 * Set the initial file system path for a given file selector entry
6794 * @param obj The file selector entry widget
6795 * @param path The path string
6797 * It must be a <b>directory</b> path, which will have the contents
6798 * displayed initially in the file selector's view, when invoked
6799 * from @p obj. The default initial path is the @c "HOME"
6800 * environment variable's value.
6802 * @see elm_fileselector_entry_path_get()
6804 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6807 * Get the parent directory's path to the latest file selection on
6808 * a given filer selector entry widget
6810 * @param obj The file selector object
6811 * @return The (full) path of the directory of the last selection
6812 * on @p obj widget, a @b stringshared string
6814 * @see elm_fileselector_entry_path_set()
6816 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6823 * @defgroup Scroller Scroller
6825 * A scroller holds a single object and "scrolls it around". This means that
6826 * it allows the user to use a scrollbar (or a finger) to drag the viewable
6827 * region around, allowing to move through a much larger object that is
6828 * contained in the scroller. The scroller will always have a small minimum
6829 * size by default as it won't be limited by the contents of the scroller.
6831 * Signals that you can add callbacks for are:
6832 * @li "edge,left" - the left edge of the content has been reached
6833 * @li "edge,right" - the right edge of the content has been reached
6834 * @li "edge,top" - the top edge of the content has been reached
6835 * @li "edge,bottom" - the bottom edge of the content has been reached
6836 * @li "scroll" - the content has been scrolled (moved)
6837 * @li "scroll,anim,start" - scrolling animation has started
6838 * @li "scroll,anim,stop" - scrolling animation has stopped
6839 * @li "scroll,drag,start" - dragging the contents around has started
6840 * @li "scroll,drag,stop" - dragging the contents around has stopped
6841 * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
6844 * @note When Elemementary is in embedded mode the scrollbars will not be
6845 * dragable, they appear merely as indicators of how much has been scrolled.
6846 * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
6847 * fingerscroll) won't work.
6849 * To set/get/unset the content of the panel, you can use
6850 * elm_object_content_set/get/unset APIs.
6851 * Once the content object is set, a previously set one will be deleted.
6852 * If you want to keep that old content object, use the
6853 * elm_object_content_unset() function
6855 * In @ref tutorial_scroller you'll find an example of how to use most of
6860 * @brief Type that controls when scrollbars should appear.
6862 * @see elm_scroller_policy_set()
6864 typedef enum _Elm_Scroller_Policy
6866 ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
6867 ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
6868 ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
6869 ELM_SCROLLER_POLICY_LAST
6870 } Elm_Scroller_Policy;
6872 * @brief Add a new scroller to the parent
6874 * @param parent The parent object
6875 * @return The new object or NULL if it cannot be created
6877 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6879 * @brief Set the content of the scroller widget (the object to be scrolled around).
6881 * @param obj The scroller object
6882 * @param content The new content object
6884 * Once the content object is set, a previously set one will be deleted.
6885 * If you want to keep that old content object, use the
6886 * elm_scroller_content_unset() function.
6887 * @deprecated See elm_object_content_set()
6889 EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
6891 * @brief Get the content of the scroller widget
6893 * @param obj The slider object
6894 * @return The content that is being used
6896 * Return the content object which is set for this widget
6898 * @see elm_scroller_content_set()
6899 * @deprecated use elm_object_content_get() instead.
6901 EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6903 * @brief Unset the content of the scroller widget
6905 * @param obj The slider object
6906 * @return The content that was being used
6908 * Unparent and return the content object which was set for this widget
6910 * @see elm_scroller_content_set()
6911 * @deprecated use elm_object_content_unset() instead.
6913 EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6915 * @brief Set custom theme elements for the scroller
6917 * @param obj The scroller object
6918 * @param widget The widget name to use (default is "scroller")
6919 * @param base The base name to use (default is "base")
6921 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
6923 * @brief Make the scroller minimum size limited to the minimum size of the content
6925 * @param obj The scroller object
6926 * @param w Enable limiting minimum size horizontally
6927 * @param h Enable limiting minimum size vertically
6929 * By default the scroller will be as small as its design allows,
6930 * irrespective of its content. This will make the scroller minimum size the
6931 * right size horizontally and/or vertically to perfectly fit its content in
6934 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
6936 * @brief Show a specific virtual region within the scroller content object
6938 * @param obj The scroller object
6939 * @param x X coordinate of the region
6940 * @param y Y coordinate of the region
6941 * @param w Width of the region
6942 * @param h Height of the region
6944 * This will ensure all (or part if it does not fit) of the designated
6945 * region in the virtual content object (0, 0 starting at the top-left of the
6946 * virtual content object) is shown within the scroller.
6948 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);
6950 * @brief Set the scrollbar visibility policy
6952 * @param obj The scroller object
6953 * @param policy_h Horizontal scrollbar policy
6954 * @param policy_v Vertical scrollbar policy
6956 * This sets the scrollbar visibility policy for the given scroller.
6957 * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
6958 * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
6959 * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
6960 * respectively for the horizontal and vertical scrollbars.
6962 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
6964 * @brief Gets scrollbar visibility policy
6966 * @param obj The scroller object
6967 * @param policy_h Horizontal scrollbar policy
6968 * @param policy_v Vertical scrollbar policy
6970 * @see elm_scroller_policy_set()
6972 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
6974 * @brief Get the currently visible content region
6976 * @param obj The scroller object
6977 * @param x X coordinate of the region
6978 * @param y Y coordinate of the region
6979 * @param w Width of the region
6980 * @param h Height of the region
6982 * This gets the current region in the content object that is visible through
6983 * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
6984 * w, @p h values pointed to.
6986 * @note All coordinates are relative to the content.
6988 * @see elm_scroller_region_show()
6990 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);
6992 * @brief Get the size of the content object
6994 * @param obj The scroller object
6995 * @param w Width of the content object.
6996 * @param h Height of the content object.
6998 * This gets the size of the content object of the scroller.
7000 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7002 * @brief Set bouncing behavior
7004 * @param obj The scroller object
7005 * @param h_bounce Allow bounce horizontally
7006 * @param v_bounce Allow bounce vertically
7008 * When scrolling, the scroller may "bounce" when reaching an edge of the
7009 * content object. This is a visual way to indicate the end has been reached.
7010 * This is enabled by default for both axis. This API will set if it is enabled
7011 * for the given axis with the boolean parameters for each axis.
7013 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7015 * @brief Get the bounce behaviour
7017 * @param obj The Scroller object
7018 * @param h_bounce Will the scroller bounce horizontally or not
7019 * @param v_bounce Will the scroller bounce vertically or not
7021 * @see elm_scroller_bounce_set()
7023 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7025 * @brief Set scroll page size relative to viewport size.
7027 * @param obj The scroller object
7028 * @param h_pagerel The horizontal page relative size
7029 * @param v_pagerel The vertical page relative size
7031 * The scroller is capable of limiting scrolling by the user to "pages". That
7032 * is to jump by and only show a "whole page" at a time as if the continuous
7033 * area of the scroller content is split into page sized pieces. This sets
7034 * the size of a page relative to the viewport of the scroller. 1.0 is "1
7035 * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7036 * axis. This is mutually exclusive with page size
7037 * (see elm_scroller_page_size_set() for more information). Likewise 0.5
7038 * is "half a viewport". Sane usable values are normally between 0.0 and 1.0
7039 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7042 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7044 * @brief Set scroll page size.
7046 * @param obj The scroller object
7047 * @param h_pagesize The horizontal page size
7048 * @param v_pagesize The vertical page size
7050 * This sets the page size to an absolute fixed value, with 0 turning it off
7053 * @see elm_scroller_page_relative_set()
7055 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7057 * @brief Show a specific virtual region within the scroller content object.
7059 * @param obj The scroller object
7060 * @param x X coordinate of the region
7061 * @param y Y coordinate of the region
7062 * @param w Width of the region
7063 * @param h Height of the region
7065 * This will ensure all (or part if it does not fit) of the designated
7066 * region in the virtual content object (0, 0 starting at the top-left of the
7067 * virtual content object) is shown within the scroller. Unlike
7068 * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7069 * to this location (if configuration in general calls for transitions). It
7070 * may not jump immediately to the new location and make take a while and
7071 * show other content along the way.
7073 * @see elm_scroller_region_show()
7075 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);
7077 * @brief Set event propagation on a scroller
7079 * @param obj The scroller object
7080 * @param propagation If propagation is enabled or not
7082 * This enables or disabled event propagation from the scroller content to
7083 * the scroller and its parent. By default event propagation is disabled.
7085 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation) EINA_ARG_NONNULL(1);
7087 * @brief Get event propagation for a scroller
7089 * @param obj The scroller object
7090 * @return The propagation state
7092 * This gets the event propagation for a scroller.
7094 * @see elm_scroller_propagate_events_set()
7096 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7098 * @brief Set scrolling gravity on a scroller
7100 * @param obj The scroller object
7101 * @param x The scrolling horizontal gravity
7102 * @param y The scrolling vertical gravity
7104 * The gravity, defines how the scroller will adjust its view
7105 * when the size of the scroller contents increase.
7107 * The scroller will adjust the view to glue itself as follows.
7109 * x=0.0, for showing the left most region of the content.
7110 * x=1.0, for showing the right most region of the content.
7111 * y=0.0, for showing the bottom most region of the content.
7112 * y=1.0, for showing the top most region of the content.
7114 * Default values for x and y are 0.0
7116 EAPI void elm_scroller_gravity_set(Evas_Object *obj, double x, double y) EINA_ARG_NONNULL(1);
7118 * @brief Get scrolling gravity values for a scroller
7120 * @param obj The scroller object
7121 * @param x The scrolling horizontal gravity
7122 * @param y The scrolling vertical gravity
7124 * This gets gravity values for a scroller.
7126 * @see elm_scroller_gravity_set()
7129 EAPI void elm_scroller_gravity_get(const Evas_Object *obj, double *x, double *y) EINA_ARG_NONNULL(1);
7135 * @defgroup Label Label
7137 * @image html img/widget/label/preview-00.png
7138 * @image latex img/widget/label/preview-00.eps
7140 * @brief Widget to display text, with simple html-like markup.
7142 * The Label widget @b doesn't allow text to overflow its boundaries, if the
7143 * text doesn't fit the geometry of the label it will be ellipsized or be
7144 * cut. Elementary provides several themes for this widget:
7145 * @li default - No animation
7146 * @li marker - Centers the text in the label and make it bold by default
7147 * @li slide_long - The entire text appears from the right of the screen and
7148 * slides until it disappears in the left of the screen(reappering on the
7150 * @li slide_short - The text appears in the left of the label and slides to
7151 * the right to show the overflow. When all of the text has been shown the
7152 * position is reset.
7153 * @li slide_bounce - The text appears in the left of the label and slides to
7154 * the right to show the overflow. When all of the text has been shown the
7155 * animation reverses, moving the text to the left.
7157 * Custom themes can of course invent new markup tags and style them any way
7160 * The following signals may be emitted by the label widget:
7161 * @li "language,changed": The program's language changed.
7163 * See @ref tutorial_label for a demonstration of how to use a label widget.
7167 * @brief Add a new label to the parent
7169 * @param parent The parent object
7170 * @return The new object or NULL if it cannot be created
7172 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7174 * @brief Set the label on the label object
7176 * @param obj The label object
7177 * @param label The label will be used on the label object
7178 * @deprecated See elm_object_text_set()
7180 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 */
7182 * @brief Get the label used on the label object
7184 * @param obj The label object
7185 * @return The string inside the label
7186 * @deprecated See elm_object_text_get()
7188 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7190 * @brief Set the wrapping behavior of the label
7192 * @param obj The label object
7193 * @param wrap To wrap text or not
7195 * By default no wrapping is done. Possible values for @p wrap are:
7196 * @li ELM_WRAP_NONE - No wrapping
7197 * @li ELM_WRAP_CHAR - wrap between characters
7198 * @li ELM_WRAP_WORD - wrap between words
7199 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7201 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7203 * @brief Get the wrapping behavior of the label
7205 * @param obj The label object
7208 * @see elm_label_line_wrap_set()
7210 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7212 * @brief Set wrap width of the label
7214 * @param obj The label object
7215 * @param w The wrap width in pixels at a minimum where words need to wrap
7217 * This function sets the maximum width size hint of the label.
7219 * @warning This is only relevant if the label is inside a container.
7221 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7223 * @brief Get wrap width of the label
7225 * @param obj The label object
7226 * @return The wrap width in pixels at a minimum where words need to wrap
7228 * @see elm_label_wrap_width_set()
7230 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7232 * @brief Set wrap height of the label
7234 * @param obj The label object
7235 * @param h The wrap height in pixels at a minimum where words need to wrap
7237 * This function sets the maximum height size hint of the label.
7239 * @warning This is only relevant if the label is inside a container.
7241 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7243 * @brief get wrap width of the label
7245 * @param obj The label object
7246 * @return The wrap height in pixels at a minimum where words need to wrap
7248 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7250 * @brief Set the font size on the label object.
7252 * @param obj The label object
7253 * @param size font size
7255 * @warning NEVER use this. It is for hyper-special cases only. use styles
7256 * instead. e.g. "big", "medium", "small" - or better name them by use:
7257 * "title", "footnote", "quote" etc.
7259 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7261 * @brief Set the text color on the label object
7263 * @param obj The label object
7264 * @param r Red property background color of The label object
7265 * @param g Green property background color of The label object
7266 * @param b Blue property background color of The label object
7267 * @param a Alpha property background color of The label object
7269 * @warning NEVER use this. It is for hyper-special cases only. use styles
7270 * instead. e.g. "big", "medium", "small" - or better name them by use:
7271 * "title", "footnote", "quote" etc.
7273 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);
7275 * @brief Set the text align on the label object
7277 * @param obj The label object
7278 * @param align align mode ("left", "center", "right")
7280 * @warning NEVER use this. It is for hyper-special cases only. use styles
7281 * instead. e.g. "big", "medium", "small" - or better name them by use:
7282 * "title", "footnote", "quote" etc.
7284 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7286 * @brief Set background color of the label
7288 * @param obj The label object
7289 * @param r Red property background color of The label object
7290 * @param g Green property background color of The label object
7291 * @param b Blue property background color of The label object
7292 * @param a Alpha property background alpha of The label object
7294 * @warning NEVER use this. It is for hyper-special cases only. use styles
7295 * instead. e.g. "big", "medium", "small" - or better name them by use:
7296 * "title", "footnote", "quote" etc.
7298 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);
7300 * @brief Set the ellipsis behavior of the label
7302 * @param obj The label object
7303 * @param ellipsis To ellipsis text or not
7305 * If set to true and the text doesn't fit in the label an ellipsis("...")
7306 * will be shown at the end of the widget.
7308 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7309 * choosen wrap method was ELM_WRAP_WORD.
7311 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7312 EINA_DEPRECATED EAPI void elm_label_wrap_mode_set(Evas_Object *obj, Eina_Bool wrapmode) EINA_ARG_NONNULL(1);
7314 * @brief Set the text slide of the label
7316 * @param obj The label object
7317 * @param slide To start slide or stop
7319 * If set to true, the text of the label will slide/scroll through the length of
7322 * @warning This only works with the themes "slide_short", "slide_long" and
7325 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7327 * @brief Get the text slide mode of the label
7329 * @param obj The label object
7330 * @return slide slide mode value
7332 * @see elm_label_slide_set()
7334 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7336 * @brief Set the slide duration(speed) of the label
7338 * @param obj The label object
7339 * @return The duration in seconds in moving text from slide begin position
7340 * to slide end position
7342 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7344 * @brief Get the slide duration(speed) of the label
7346 * @param obj The label object
7347 * @return The duration time in moving text from slide begin position to slide end position
7349 * @see elm_label_slide_duration_set()
7351 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7357 * @defgroup Toggle Toggle
7359 * @image html img/widget/toggle/preview-00.png
7360 * @image latex img/widget/toggle/preview-00.eps
7362 * @brief A toggle is a slider which can be used to toggle between
7363 * two values. It has two states: on and off.
7365 * This widget is deprecated. Please use elm_check_add() instead using the
7366 * toggle style like:
7369 * obj = elm_check_add(parent);
7370 * elm_object_style_set(obj, "toggle");
7371 * elm_object_text_part_set(obj, "on", "ON");
7372 * elm_object_text_part_set(obj, "off", "OFF");
7375 * Signals that you can add callbacks for are:
7376 * @li "changed" - Whenever the toggle value has been changed. Is not called
7377 * until the toggle is released by the cursor (assuming it
7378 * has been triggered by the cursor in the first place).
7380 * @ref tutorial_toggle show how to use a toggle.
7384 * @brief Add a toggle to @p parent.
7386 * @param parent The parent object
7388 * @return The toggle object
7390 EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7392 * @brief Sets the label to be displayed with the toggle.
7394 * @param obj The toggle object
7395 * @param label The label to be displayed
7397 * @deprecated use elm_object_text_set() instead.
7399 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7401 * @brief Gets the label of the toggle
7403 * @param obj toggle object
7404 * @return The label of the toggle
7406 * @deprecated use elm_object_text_get() instead.
7408 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7410 * @brief Set the icon used for the toggle
7412 * @param obj The toggle object
7413 * @param icon The icon object for the button
7415 * Once the icon object is set, a previously set one will be deleted
7416 * If you want to keep that old content object, use the
7417 * elm_toggle_icon_unset() function.
7419 * @deprecated use elm_object_content_set() instead.
7421 EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7423 * @brief Get the icon used for the toggle
7425 * @param obj The toggle object
7426 * @return The icon object that is being used
7428 * Return the icon object which is set for this widget.
7430 * @see elm_toggle_icon_set()
7432 * @deprecated use elm_object_content_get() instead.
7434 EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7436 * @brief Unset the icon used for the toggle
7438 * @param obj The toggle object
7439 * @return The icon object that was being used
7441 * Unparent and return the icon object which was set for this widget.
7443 * @see elm_toggle_icon_set()
7445 * @deprecated use elm_object_content_unset() instead.
7447 EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7449 * @brief Sets the labels to be associated with the on and off states of the toggle.
7451 * @param obj The toggle object
7452 * @param onlabel The label displayed when the toggle is in the "on" state
7453 * @param offlabel The label displayed when the toggle is in the "off" state
7455 * @deprecated use elm_object_text_part_set() for "on" and "off" parts
7458 EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7460 * @brief Gets the labels associated with the on and off states of the
7463 * @param obj The toggle object
7464 * @param onlabel A char** to place the onlabel of @p obj into
7465 * @param offlabel A char** to place the offlabel of @p obj into
7467 * @deprecated use elm_object_text_part_get() for "on" and "off" parts
7470 EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7472 * @brief Sets the state of the toggle to @p state.
7474 * @param obj The toggle object
7475 * @param state The state of @p obj
7477 * @deprecated use elm_check_state_set() instead.
7479 EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7481 * @brief Gets the state of the toggle to @p state.
7483 * @param obj The toggle object
7484 * @return The state of @p obj
7486 * @deprecated use elm_check_state_get() instead.
7488 EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7490 * @brief Sets the state pointer of the toggle to @p statep.
7492 * @param obj The toggle object
7493 * @param statep The state pointer of @p obj
7495 * @deprecated use elm_check_state_pointer_set() instead.
7497 EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7503 * @page tutorial_frame Frame example
7504 * @dontinclude frame_example_01.c
7506 * In this example we are going to create 4 Frames with different styles and
7507 * add a rectangle of different color in each.
7509 * We start we the usual setup code:
7512 * And then create one rectangle:
7515 * To add it in our first frame, which since it doesn't have it's style
7516 * specifically set uses the default style:
7519 * And then create another rectangle:
7522 * To add it in our second frame, which uses the "pad_small" style, note that
7523 * even tough we are setting a text for this frame it won't be show, only the
7524 * default style shows the Frame's title:
7526 * @note The "pad_small", "pad_medium", "pad_large" and "pad_huge" styles are
7527 * very similar, their only difference is the size of the empty area around
7528 * the content of the frame.
7530 * And then create yet another rectangle:
7533 * To add it in our third frame, which uses the "outdent_top" style, note
7534 * that even tough we are setting a text for this frame it won't be show,
7535 * only the default style shows the Frame's title:
7538 * And then create one last rectangle:
7541 * To add it in our fourth and final frame, which uses the "outdent_bottom"
7542 * style, note that even tough we are setting a text for this frame it won't
7543 * be show, only the default style shows the Frame's title:
7546 * And now we are left with just some more setup code:
7549 * Our example will look like this:
7550 * @image html screenshots/frame_example_01.png
7551 * @image latex screenshots/frame_example_01.eps
7553 * @example frame_example_01.c
7556 * @defgroup Frame Frame
7558 * @brief Frame is a widget that holds some content and has a title.
7560 * The default look is a frame with a title, but Frame supports multple
7568 * @li outdent_bottom
7570 * Of all this styles only default shows the title. Frame emits no signals.
7572 * For a detailed example see the @ref tutorial_frame.
7577 * @brief Add a new frame to the parent
7579 * @param parent The parent object
7580 * @return The new object or NULL if it cannot be created
7582 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7584 * @brief Set the frame label
7586 * @param obj The frame object
7587 * @param label The label of this frame object
7589 * @deprecated use elm_object_text_set() instead.
7591 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7593 * @brief Get the frame label
7595 * @param obj The frame object
7597 * @return The label of this frame objet or NULL if unable to get frame
7599 * @deprecated use elm_object_text_get() instead.
7601 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7603 * @brief Set the content of the frame widget
7605 * Once the content object is set, a previously set one will be deleted.
7606 * If you want to keep that old content object, use the
7607 * elm_frame_content_unset() function.
7609 * @param obj The frame object
7610 * @param content The content will be filled in this frame object
7612 EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7614 * @brief Get the content of the frame widget
7616 * Return the content object which is set for this widget
7618 * @param obj The frame object
7619 * @return The content that is being used
7621 EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7623 * @brief Unset the content of the frame widget
7625 * Unparent and return the content object which was set for this widget
7627 * @param obj The frame object
7628 * @return The content that was being used
7630 EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7636 * @defgroup Table Table
7638 * A container widget to arrange other widgets in a table where items can
7639 * also span multiple columns or rows - even overlap (and then be raised or
7640 * lowered accordingly to adjust stacking if they do overlap).
7642 * For a Table widget the row/column count is not fixed.
7643 * The table widget adjusts itself when subobjects are added to it dynamically.
7645 * The followin are examples of how to use a table:
7646 * @li @ref tutorial_table_01
7647 * @li @ref tutorial_table_02
7652 * @brief Add a new table to the parent
7654 * @param parent The parent object
7655 * @return The new object or NULL if it cannot be created
7657 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7659 * @brief Set the homogeneous layout in the table
7661 * @param obj The layout object
7662 * @param homogeneous A boolean to set if the layout is homogeneous in the
7663 * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7665 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7667 * @brief Get the current table homogeneous mode.
7669 * @param obj The table object
7670 * @return A boolean to indicating if the layout is homogeneous in the table
7671 * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7673 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7675 * @warning <b>Use elm_table_homogeneous_set() instead</b>
7677 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7679 * @warning <b>Use elm_table_homogeneous_get() instead</b>
7681 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7683 * @brief Set padding between cells.
7685 * @param obj The layout object.
7686 * @param horizontal set the horizontal padding.
7687 * @param vertical set the vertical padding.
7689 * Default value is 0.
7691 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7693 * @brief Get padding between cells.
7695 * @param obj The layout object.
7696 * @param horizontal set the horizontal padding.
7697 * @param vertical set the vertical padding.
7699 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7701 * @brief Add a subobject on the table with the coordinates passed
7703 * @param obj The table object
7704 * @param subobj The subobject to be added to the table
7705 * @param x Row number
7706 * @param y Column number
7710 * @note All positioning inside the table is relative to rows and columns, so
7711 * a value of 0 for x and y, means the top left cell of the table, and a
7712 * value of 1 for w and h means @p subobj only takes that 1 cell.
7714 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7716 * @brief Remove child from table.
7718 * @param obj The table object
7719 * @param subobj The subobject
7721 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
7723 * @brief Faster way to remove all child objects from a table object.
7725 * @param obj The table object
7726 * @param clear If true, will delete children, else just remove from table.
7728 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
7730 * @brief Set the packing location of an existing child of the table
7732 * @param subobj The subobject to be modified in the table
7733 * @param x Row number
7734 * @param y Column number
7738 * Modifies the position of an object already in the table.
7740 * @note All positioning inside the table is relative to rows and columns, so
7741 * a value of 0 for x and y, means the top left cell of the table, and a
7742 * value of 1 for w and h means @p subobj only takes that 1 cell.
7744 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7746 * @brief Get the packing location of an existing child of the table
7748 * @param subobj The subobject to be modified in the table
7749 * @param x Row number
7750 * @param y Column number
7754 * @see elm_table_pack_set()
7756 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
7762 * @defgroup Gengrid Gengrid (Generic grid)
7764 * This widget aims to position objects in a grid layout while
7765 * actually creating and rendering only the visible ones, using the
7766 * same idea as the @ref Genlist "genlist": the user defines a @b
7767 * class for each item, specifying functions that will be called at
7768 * object creation, deletion, etc. When those items are selected by
7769 * the user, a callback function is issued. Users may interact with
7770 * a gengrid via the mouse (by clicking on items to select them and
7771 * clicking on the grid's viewport and swiping to pan the whole
7772 * view) or via the keyboard, navigating through item with the
7775 * @section Gengrid_Layouts Gengrid layouts
7777 * Gengrid may layout its items in one of two possible layouts:
7781 * When in "horizontal mode", items will be placed in @b columns,
7782 * from top to bottom and, when the space for a column is filled,
7783 * another one is started on the right, thus expanding the grid
7784 * horizontally, making for horizontal scrolling. When in "vertical
7785 * mode" , though, items will be placed in @b rows, from left to
7786 * right and, when the space for a row is filled, another one is
7787 * started below, thus expanding the grid vertically (and making
7788 * for vertical scrolling).
7790 * @section Gengrid_Items Gengrid items
7792 * An item in a gengrid can have 0 or more text labels (they can be
7793 * regular text or textblock Evas objects - that's up to the style
7794 * to determine), 0 or more icons (which are simply objects
7795 * swallowed into the gengrid item's theming Edje object) and 0 or
7796 * more <b>boolean states</b>, which have the behavior left to the
7797 * user to define. The Edje part names for each of these properties
7798 * will be looked up, in the theme file for the gengrid, under the
7799 * Edje (string) data items named @c "labels", @c "icons" and @c
7800 * "states", respectively. For each of those properties, if more
7801 * than one part is provided, they must have names listed separated
7802 * by spaces in the data fields. For the default gengrid item
7803 * theme, we have @b one label part (@c "elm.text"), @b two icon
7804 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
7807 * A gengrid item may be at one of several styles. Elementary
7808 * provides one by default - "default", but this can be extended by
7809 * system or application custom themes/overlays/extensions (see
7810 * @ref Theme "themes" for more details).
7812 * @section Gengrid_Item_Class Gengrid item classes
7814 * In order to have the ability to add and delete items on the fly,
7815 * gengrid implements a class (callback) system where the
7816 * application provides a structure with information about that
7817 * type of item (gengrid may contain multiple different items with
7818 * different classes, states and styles). Gengrid will call the
7819 * functions in this struct (methods) when an item is "realized"
7820 * (i.e., created dynamically, while the user is scrolling the
7821 * grid). All objects will simply be deleted when no longer needed
7822 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
7823 * contains the following members:
7824 * - @c item_style - This is a constant string and simply defines
7825 * the name of the item style. It @b must be specified and the
7826 * default should be @c "default".
7827 * - @c func.label_get - This function is called when an item
7828 * object is actually created. The @c data parameter will point to
7829 * the same data passed to elm_gengrid_item_append() and related
7830 * item creation functions. The @c obj parameter is the gengrid
7831 * object itself, while the @c part one is the name string of one
7832 * of the existing text parts in the Edje group implementing the
7833 * item's theme. This function @b must return a strdup'()ed string,
7834 * as the caller will free() it when done. See
7835 * #Elm_Gengrid_Item_Label_Get_Cb.
7836 * - @c func.content_get - This function is called when an item object
7837 * is actually created. The @c data parameter will point to the
7838 * same data passed to elm_gengrid_item_append() and related item
7839 * creation functions. The @c obj parameter is the gengrid object
7840 * itself, while the @c part one is the name string of one of the
7841 * existing (content) swallow parts in the Edje group implementing the
7842 * item's theme. It must return @c NULL, when no content is desired,
7843 * or a valid object handle, otherwise. The object will be deleted
7844 * by the gengrid on its deletion or when the item is "unrealized".
7845 * See #Elm_Gengrid_Item_Content_Get_Cb.
7846 * - @c func.state_get - This function is called when an item
7847 * object is actually created. The @c data parameter will point to
7848 * the same data passed to elm_gengrid_item_append() and related
7849 * item creation functions. The @c obj parameter is the gengrid
7850 * object itself, while the @c part one is the name string of one
7851 * of the state parts in the Edje group implementing the item's
7852 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
7853 * true/on. Gengrids will emit a signal to its theming Edje object
7854 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
7855 * "source" arguments, respectively, when the state is true (the
7856 * default is false), where @c XXX is the name of the (state) part.
7857 * See #Elm_Gengrid_Item_State_Get_Cb.
7858 * - @c func.del - This is called when elm_gengrid_item_del() is
7859 * called on an item or elm_gengrid_clear() is called on the
7860 * gengrid. This is intended for use when gengrid items are
7861 * deleted, so any data attached to the item (e.g. its data
7862 * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
7864 * @section Gengrid_Usage_Hints Usage hints
7866 * If the user wants to have multiple items selected at the same
7867 * time, elm_gengrid_multi_select_set() will permit it. If the
7868 * gengrid is single-selection only (the default), then
7869 * elm_gengrid_select_item_get() will return the selected item or
7870 * @c NULL, if none is selected. If the gengrid is under
7871 * multi-selection, then elm_gengrid_selected_items_get() will
7872 * return a list (that is only valid as long as no items are
7873 * modified (added, deleted, selected or unselected) of child items
7876 * If an item changes (internal (boolean) state, label or content
7877 * changes), then use elm_gengrid_item_update() to have gengrid
7878 * update the item with the new state. A gengrid will re-"realize"
7879 * the item, thus calling the functions in the
7880 * #Elm_Gengrid_Item_Class set for that item.
7882 * To programmatically (un)select an item, use
7883 * elm_gengrid_item_selected_set(). To get its selected state use
7884 * elm_gengrid_item_selected_get(). To make an item disabled
7885 * (unable to be selected and appear differently) use
7886 * elm_gengrid_item_disabled_set() to set this and
7887 * elm_gengrid_item_disabled_get() to get the disabled state.
7889 * Grid cells will only have their selection smart callbacks called
7890 * when firstly getting selected. Any further clicks will do
7891 * nothing, unless you enable the "always select mode", with
7892 * elm_gengrid_always_select_mode_set(), thus making every click to
7893 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
7894 * turn off the ability to select items entirely in the widget and
7895 * they will neither appear selected nor call the selection smart
7898 * Remember that you can create new styles and add your own theme
7899 * augmentation per application with elm_theme_extension_add(). If
7900 * you absolutely must have a specific style that overrides any
7901 * theme the user or system sets up you can use
7902 * elm_theme_overlay_add() to add such a file.
7904 * @section Gengrid_Smart_Events Gengrid smart events
7906 * Smart events that you can add callbacks for are:
7907 * - @c "activated" - The user has double-clicked or pressed
7908 * (enter|return|spacebar) on an item. The @c event_info parameter
7909 * is the gengrid item that was activated.
7910 * - @c "clicked,double" - The user has double-clicked an item.
7911 * The @c event_info parameter is the gengrid item that was double-clicked.
7912 * - @c "longpressed" - This is called when the item is pressed for a certain
7913 * amount of time. By default it's 1 second.
7914 * - @c "selected" - The user has made an item selected. The
7915 * @c event_info parameter is the gengrid item that was selected.
7916 * - @c "unselected" - The user has made an item unselected. The
7917 * @c event_info parameter is the gengrid item that was unselected.
7918 * - @c "realized" - This is called when the item in the gengrid
7919 * has its implementing Evas object instantiated, de facto. @c
7920 * event_info is the gengrid item that was created. The object
7921 * may be deleted at any time, so it is highly advised to the
7922 * caller @b not to use the object pointer returned from
7923 * elm_gengrid_item_object_get(), because it may point to freed
7925 * - @c "unrealized" - This is called when the implementing Evas
7926 * object for this item is deleted. @c event_info is the gengrid
7927 * item that was deleted.
7928 * - @c "changed" - Called when an item is added, removed, resized
7929 * or moved and when the gengrid is resized or gets "horizontal"
7931 * - @c "scroll,anim,start" - This is called when scrolling animation has
7933 * - @c "scroll,anim,stop" - This is called when scrolling animation has
7935 * - @c "drag,start,up" - Called when the item in the gengrid has
7936 * been dragged (not scrolled) up.
7937 * - @c "drag,start,down" - Called when the item in the gengrid has
7938 * been dragged (not scrolled) down.
7939 * - @c "drag,start,left" - Called when the item in the gengrid has
7940 * been dragged (not scrolled) left.
7941 * - @c "drag,start,right" - Called when the item in the gengrid has
7942 * been dragged (not scrolled) right.
7943 * - @c "drag,stop" - Called when the item in the gengrid has
7944 * stopped being dragged.
7945 * - @c "drag" - Called when the item in the gengrid is being
7947 * - @c "scroll" - called when the content has been scrolled
7949 * - @c "scroll,drag,start" - called when dragging the content has
7951 * - @c "scroll,drag,stop" - called when dragging the content has
7953 * - @c "edge,top" - This is called when the gengrid is scrolled until
7955 * - @c "edge,bottom" - This is called when the gengrid is scrolled
7956 * until the bottom edge.
7957 * - @c "edge,left" - This is called when the gengrid is scrolled
7958 * until the left edge.
7959 * - @c "edge,right" - This is called when the gengrid is scrolled
7960 * until the right edge.
7962 * List of gengrid examples:
7963 * @li @ref gengrid_example
7967 * @addtogroup Gengrid
7971 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
7972 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
7973 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
7974 typedef char *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
7975 typedef Evas_Object *(*Elm_Gengrid_Item_Content_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Content (swallowed object) fetching class function for gengrid item classes. */
7976 typedef Eina_Bool (*Elm_Gengrid_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for gengrid item classes. */
7977 typedef void (*Elm_Gengrid_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
7979 /* temporary compatibility code */
7980 typedef Elm_Gengrid_Item_Label_Get_Cb GridItemLabelGetFunc EINA_DEPRECATED;
7981 typedef Elm_Gengrid_Item_Content_Get_Cb GridItemIconGetFunc EINA_DEPRECATED;
7982 typedef Elm_Gengrid_Item_State_Get_Cb GridItemStateGetFunc EINA_DEPRECATED;
7983 typedef Elm_Gengrid_Item_Del_Cb GridItemDelFunc EINA_DEPRECATED;
7986 * @struct _Elm_Gengrid_Item_Class
7988 * Gengrid item class definition. See @ref Gengrid_Item_Class for
7991 struct _Elm_Gengrid_Item_Class
7993 const char *item_style;
7994 struct _Elm_Gengrid_Item_Class_Func
7996 Elm_Gengrid_Item_Label_Get_Cb label_get;
7997 Elm_Gengrid_Item_Content_Get_Cb icon_get;
7998 Elm_Gengrid_Item_State_Get_Cb state_get;
7999 Elm_Gengrid_Item_Del_Cb del;
8001 }; /**< #Elm_Gengrid_Item_Class member definitions */
8003 * Add a new gengrid widget to the given parent Elementary
8004 * (container) object
8006 * @param parent The parent object
8007 * @return a new gengrid widget handle or @c NULL, on errors
8009 * This function inserts a new gengrid widget on the canvas.
8011 * @see elm_gengrid_item_size_set()
8012 * @see elm_gengrid_group_item_size_set()
8013 * @see elm_gengrid_horizontal_set()
8014 * @see elm_gengrid_item_append()
8015 * @see elm_gengrid_item_del()
8016 * @see elm_gengrid_clear()
8020 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8023 * Set the size for the items of a given gengrid widget
8025 * @param obj The gengrid object.
8026 * @param w The items' width.
8027 * @param h The items' height;
8029 * A gengrid, after creation, has still no information on the size
8030 * to give to each of its cells. So, you most probably will end up
8031 * with squares one @ref Fingers "finger" wide, the default
8032 * size. Use this function to force a custom size for you items,
8033 * making them as big as you wish.
8035 * @see elm_gengrid_item_size_get()
8039 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8042 * Get the size set for the items of a given gengrid widget
8044 * @param obj The gengrid object.
8045 * @param w Pointer to a variable where to store the items' width.
8046 * @param h Pointer to a variable where to store the items' height.
8048 * @note Use @c NULL pointers on the size values you're not
8049 * interested in: they'll be ignored by the function.
8051 * @see elm_gengrid_item_size_get() for more details
8055 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8058 * Set the items grid's alignment within a given gengrid widget
8060 * @param obj The gengrid object.
8061 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8062 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8064 * This sets the alignment of the whole grid of items of a gengrid
8065 * within its given viewport. By default, those values are both
8066 * 0.5, meaning that the gengrid will have its items grid placed
8067 * exactly in the middle of its viewport.
8069 * @note If given alignment values are out of the cited ranges,
8070 * they'll be changed to the nearest boundary values on the valid
8073 * @see elm_gengrid_align_get()
8077 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8080 * Get the items grid's alignment values within a given gengrid
8083 * @param obj The gengrid object.
8084 * @param align_x Pointer to a variable where to store the
8085 * horizontal alignment.
8086 * @param align_y Pointer to a variable where to store the vertical
8089 * @note Use @c NULL pointers on the alignment values you're not
8090 * interested in: they'll be ignored by the function.
8092 * @see elm_gengrid_align_set() for more details
8096 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8099 * Set whether a given gengrid widget is or not able have items
8102 * @param obj The gengrid object
8103 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8104 * @c EINA_FALSE to turn it off
8106 * If a gengrid is set to allow reordering, a click held for more
8107 * than 0.5 over a given item will highlight it specially,
8108 * signalling the gengrid has entered the reordering state. From
8109 * that time on, the user will be able to, while still holding the
8110 * mouse button down, move the item freely in the gengrid's
8111 * viewport, replacing to said item to the locations it goes to.
8112 * The replacements will be animated and, whenever the user
8113 * releases the mouse button, the item being replaced gets a new
8114 * definitive place in the grid.
8116 * @see elm_gengrid_reorder_mode_get()
8120 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8123 * Get whether a given gengrid widget is or not able have items
8126 * @param obj The gengrid object
8127 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8130 * @see elm_gengrid_reorder_mode_set() for more details
8134 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8137 * Append a new item in a given gengrid widget.
8139 * @param obj The gengrid object.
8140 * @param gic The item class for the item.
8141 * @param data The item data.
8142 * @param func Convenience function called when the item is
8144 * @param func_data Data to be passed to @p func.
8145 * @return A handle to the item added or @c NULL, on errors.
8147 * This adds an item to the beginning of the gengrid.
8149 * @see elm_gengrid_item_prepend()
8150 * @see elm_gengrid_item_insert_before()
8151 * @see elm_gengrid_item_insert_after()
8152 * @see elm_gengrid_item_del()
8156 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);
8159 * Prepend a new item in a given gengrid widget.
8161 * @param obj The gengrid object.
8162 * @param gic The item class for the item.
8163 * @param data The item data.
8164 * @param func Convenience function called when the item is
8166 * @param func_data Data to be passed to @p func.
8167 * @return A handle to the item added or @c NULL, on errors.
8169 * This adds an item to the end of the gengrid.
8171 * @see elm_gengrid_item_append()
8172 * @see elm_gengrid_item_insert_before()
8173 * @see elm_gengrid_item_insert_after()
8174 * @see elm_gengrid_item_del()
8178 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);
8181 * Insert an item before another in a gengrid widget
8183 * @param obj The gengrid object.
8184 * @param gic The item class for the item.
8185 * @param data The item data.
8186 * @param relative The item to place this new one before.
8187 * @param func Convenience function called when the item is
8189 * @param func_data Data to be passed to @p func.
8190 * @return A handle to the item added or @c NULL, on errors.
8192 * This inserts an item before another in the gengrid.
8194 * @see elm_gengrid_item_append()
8195 * @see elm_gengrid_item_prepend()
8196 * @see elm_gengrid_item_insert_after()
8197 * @see elm_gengrid_item_del()
8201 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);
8204 * Insert an item after another in a gengrid widget
8206 * @param obj The gengrid object.
8207 * @param gic The item class for the item.
8208 * @param data The item data.
8209 * @param relative The item to place this new one after.
8210 * @param func Convenience function called when the item is
8212 * @param func_data Data to be passed to @p func.
8213 * @return A handle to the item added or @c NULL, on errors.
8215 * This inserts an item after another in the gengrid.
8217 * @see elm_gengrid_item_append()
8218 * @see elm_gengrid_item_prepend()
8219 * @see elm_gengrid_item_insert_after()
8220 * @see elm_gengrid_item_del()
8224 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);
8227 * Insert an item in a gengrid widget using a user-defined sort function.
8229 * @param obj The gengrid object.
8230 * @param gic The item class for the item.
8231 * @param data The item data.
8232 * @param comp User defined comparison function that defines the sort order based on
8233 * Elm_Gen_Item and its data param.
8234 * @param func Convenience function called when the item is selected.
8235 * @param func_data Data to be passed to @p func.
8236 * @return A handle to the item added or @c NULL, on errors.
8238 * This inserts an item in the gengrid based on user defined comparison function.
8240 * @see elm_gengrid_item_append()
8241 * @see elm_gengrid_item_prepend()
8242 * @see elm_gengrid_item_insert_after()
8243 * @see elm_gengrid_item_del()
8244 * @see elm_gengrid_item_direct_sorted_insert()
8248 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);
8251 * Insert an item in a gengrid widget using a user-defined sort function.
8253 * @param obj The gengrid object.
8254 * @param gic The item class for the item.
8255 * @param data The item data.
8256 * @param comp User defined comparison function that defines the sort order based on
8258 * @param func Convenience function called when the item is selected.
8259 * @param func_data Data to be passed to @p func.
8260 * @return A handle to the item added or @c NULL, on errors.
8262 * This inserts an item in the gengrid based on user defined comparison function.
8264 * @see elm_gengrid_item_append()
8265 * @see elm_gengrid_item_prepend()
8266 * @see elm_gengrid_item_insert_after()
8267 * @see elm_gengrid_item_del()
8268 * @see elm_gengrid_item_sorted_insert()
8272 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);
8275 * Set whether items on a given gengrid widget are to get their
8276 * selection callbacks issued for @b every subsequent selection
8277 * click on them or just for the first click.
8279 * @param obj The gengrid object
8280 * @param always_select @c EINA_TRUE to make items "always
8281 * selected", @c EINA_FALSE, otherwise
8283 * By default, grid items will only call their selection callback
8284 * function when firstly getting selected, any subsequent further
8285 * clicks will do nothing. With this call, you make those
8286 * subsequent clicks also to issue the selection callbacks.
8288 * @note <b>Double clicks</b> will @b always be reported on items.
8290 * @see elm_gengrid_always_select_mode_get()
8294 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8297 * Get whether items on a given gengrid widget have their selection
8298 * callbacks issued for @b every subsequent selection click on them
8299 * or just for the first click.
8301 * @param obj The gengrid object.
8302 * @return @c EINA_TRUE if the gengrid items are "always selected",
8303 * @c EINA_FALSE, otherwise
8305 * @see elm_gengrid_always_select_mode_set() for more details
8309 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8312 * Set whether items on a given gengrid widget can be selected or not.
8314 * @param obj The gengrid object
8315 * @param no_select @c EINA_TRUE to make items selectable,
8316 * @c EINA_FALSE otherwise
8318 * This will make items in @p obj selectable or not. In the latter
8319 * case, any user interaction on the gengrid items will neither make
8320 * them appear selected nor them call their selection callback
8323 * @see elm_gengrid_no_select_mode_get()
8327 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8330 * Get whether items on a given gengrid widget can be selected or
8333 * @param obj The gengrid object
8334 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8337 * @see elm_gengrid_no_select_mode_set() for more details
8341 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8344 * Enable or disable multi-selection in a given gengrid widget
8346 * @param obj The gengrid object.
8347 * @param multi @c EINA_TRUE, to enable multi-selection,
8348 * @c EINA_FALSE to disable it.
8350 * Multi-selection is the ability to have @b more than one
8351 * item selected, on a given gengrid, simultaneously. When it is
8352 * enabled, a sequence of clicks on different items will make them
8353 * all selected, progressively. A click on an already selected item
8354 * will unselect it. If interacting via the keyboard,
8355 * multi-selection is enabled while holding the "Shift" key.
8357 * @note By default, multi-selection is @b disabled on gengrids
8359 * @see elm_gengrid_multi_select_get()
8363 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8366 * Get whether multi-selection is enabled or disabled for a given
8369 * @param obj The gengrid object.
8370 * @return @c EINA_TRUE, if multi-selection is enabled, @c
8371 * EINA_FALSE otherwise
8373 * @see elm_gengrid_multi_select_set() for more details
8377 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8380 * Enable or disable bouncing effect for a given gengrid widget
8382 * @param obj The gengrid object
8383 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8384 * @c EINA_FALSE to disable it
8385 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8386 * @c EINA_FALSE to disable it
8388 * The bouncing effect occurs whenever one reaches the gengrid's
8389 * edge's while panning it -- it will scroll past its limits a
8390 * little bit and return to the edge again, in a animated for,
8393 * @note By default, gengrids have bouncing enabled on both axis
8395 * @see elm_gengrid_bounce_get()
8399 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8402 * Get whether bouncing effects are enabled or disabled, for a
8403 * given gengrid widget, on each axis
8405 * @param obj The gengrid object
8406 * @param h_bounce Pointer to a variable where to store the
8407 * horizontal bouncing flag.
8408 * @param v_bounce Pointer to a variable where to store the
8409 * vertical bouncing flag.
8411 * @see elm_gengrid_bounce_set() for more details
8415 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8418 * Set a given gengrid widget's scrolling page size, relative to
8419 * its viewport size.
8421 * @param obj The gengrid object
8422 * @param h_pagerel The horizontal page (relative) size
8423 * @param v_pagerel The vertical page (relative) size
8425 * The gengrid's scroller is capable of binding scrolling by the
8426 * user to "pages". It means that, while scrolling and, specially
8427 * after releasing the mouse button, the grid will @b snap to the
8428 * nearest displaying page's area. When page sizes are set, the
8429 * grid's continuous content area is split into (equal) page sized
8432 * This function sets the size of a page <b>relatively to the
8433 * viewport dimensions</b> of the gengrid, for each axis. A value
8434 * @c 1.0 means "the exact viewport's size", in that axis, while @c
8435 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8436 * a viewport". Sane usable values are, than, between @c 0.0 and @c
8437 * 1.0. Values beyond those will make it behave behave
8438 * inconsistently. If you only want one axis to snap to pages, use
8439 * the value @c 0.0 for the other one.
8441 * There is a function setting page size values in @b absolute
8442 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8443 * is mutually exclusive to this one.
8445 * @see elm_gengrid_page_relative_get()
8449 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8452 * Get a given gengrid widget's scrolling page size, relative to
8453 * its viewport size.
8455 * @param obj The gengrid object
8456 * @param h_pagerel Pointer to a variable where to store the
8457 * horizontal page (relative) size
8458 * @param v_pagerel Pointer to a variable where to store the
8459 * vertical page (relative) size
8461 * @see elm_gengrid_page_relative_set() for more details
8465 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8468 * Set a given gengrid widget's scrolling page size
8470 * @param obj The gengrid object
8471 * @param h_pagerel The horizontal page size, in pixels
8472 * @param v_pagerel The vertical page size, in pixels
8474 * The gengrid's scroller is capable of binding scrolling by the
8475 * user to "pages". It means that, while scrolling and, specially
8476 * after releasing the mouse button, the grid will @b snap to the
8477 * nearest displaying page's area. When page sizes are set, the
8478 * grid's continuous content area is split into (equal) page sized
8481 * This function sets the size of a page of the gengrid, in pixels,
8482 * for each axis. Sane usable values are, between @c 0 and the
8483 * dimensions of @p obj, for each axis. Values beyond those will
8484 * make it behave behave inconsistently. If you only want one axis
8485 * to snap to pages, use the value @c 0 for the other one.
8487 * There is a function setting page size values in @b relative
8488 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8489 * use is mutually exclusive to this one.
8493 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8496 * Set the direction in which a given gengrid widget will expand while
8497 * placing its items.
8499 * @param obj The gengrid object.
8500 * @param setting @c EINA_TRUE to make the gengrid expand
8501 * horizontally, @c EINA_FALSE to expand vertically.
8503 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8504 * in @b columns, from top to bottom and, when the space for a
8505 * column is filled, another one is started on the right, thus
8506 * expanding the grid horizontally. When in "vertical mode"
8507 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8508 * to right and, when the space for a row is filled, another one is
8509 * started below, thus expanding the grid vertically.
8511 * @see elm_gengrid_horizontal_get()
8515 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8518 * Get for what direction a given gengrid widget will expand while
8519 * placing its items.
8521 * @param obj The gengrid object.
8522 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8523 * @c EINA_FALSE if it's set to expand vertically.
8525 * @see elm_gengrid_horizontal_set() for more detais
8529 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8532 * Get the first item in a given gengrid widget
8534 * @param obj The gengrid object
8535 * @return The first item's handle or @c NULL, if there are no
8536 * items in @p obj (and on errors)
8538 * This returns the first item in the @p obj's internal list of
8541 * @see elm_gengrid_last_item_get()
8545 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8548 * Get the last item in a given gengrid widget
8550 * @param obj The gengrid object
8551 * @return The last item's handle or @c NULL, if there are no
8552 * items in @p obj (and on errors)
8554 * This returns the last item in the @p obj's internal list of
8557 * @see elm_gengrid_first_item_get()
8561 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8564 * Get the @b next item in a gengrid widget's internal list of items,
8565 * given a handle to one of those items.
8567 * @param item The gengrid item to fetch next from
8568 * @return The item after @p item, or @c NULL if there's none (and
8571 * This returns the item placed after the @p item, on the container
8574 * @see elm_gengrid_item_prev_get()
8578 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8581 * Get the @b previous item in a gengrid widget's internal list of items,
8582 * given a handle to one of those items.
8584 * @param item The gengrid item to fetch previous from
8585 * @return The item before @p item, or @c NULL if there's none (and
8588 * This returns the item placed before the @p item, on the container
8591 * @see elm_gengrid_item_next_get()
8595 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8598 * Get the gengrid object's handle which contains a given gengrid
8601 * @param item The item to fetch the container from
8602 * @return The gengrid (parent) object
8604 * This returns the gengrid object itself that an item belongs to.
8608 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8611 * Remove a gengrid item from its parent, deleting it.
8613 * @param item The item to be removed.
8614 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8616 * @see elm_gengrid_clear(), to remove all items in a gengrid at
8621 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8624 * Update the contents of a given gengrid item
8626 * @param item The gengrid item
8628 * This updates an item by calling all the item class functions
8629 * again to get the contents, labels and states. Use this when the
8630 * original item data has changed and you want the changes to be
8635 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8638 * Get the Gengrid Item class for the given Gengrid Item.
8640 * @param item The gengrid item
8642 * This returns the Gengrid_Item_Class for the given item. It can be used to examine
8643 * the function pointers and item_style.
8647 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8650 * Get the Gengrid Item class for the given Gengrid Item.
8652 * This sets the Gengrid_Item_Class for the given item. It can be used to examine
8653 * the function pointers and item_style.
8655 * @param item The gengrid item
8656 * @param gic The gengrid item class describing the function pointers and the item style.
8660 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
8663 * Return the data associated to a given gengrid item
8665 * @param item The gengrid item.
8666 * @return the data associated with this item.
8668 * This returns the @c data value passed on the
8669 * elm_gengrid_item_append() and related item addition calls.
8671 * @see elm_gengrid_item_append()
8672 * @see elm_gengrid_item_data_set()
8676 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8679 * Set the data associated with a given gengrid item
8681 * @param item The gengrid item
8682 * @param data The data pointer to set on it
8684 * This @b overrides the @c data value passed on the
8685 * elm_gengrid_item_append() and related item addition calls. This
8686 * function @b won't call elm_gengrid_item_update() automatically,
8687 * so you'd issue it afterwards if you want to have the item
8688 * updated to reflect the new data.
8690 * @see elm_gengrid_item_data_get()
8691 * @see elm_gengrid_item_update()
8695 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
8698 * Get a given gengrid item's position, relative to the whole
8699 * gengrid's grid area.
8701 * @param item The Gengrid item.
8702 * @param x Pointer to variable to store the item's <b>row number</b>.
8703 * @param y Pointer to variable to store the item's <b>column number</b>.
8705 * This returns the "logical" position of the item within the
8706 * gengrid. For example, @c (0, 1) would stand for first row,
8711 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
8714 * Set whether a given gengrid item is selected or not
8716 * @param item The gengrid item
8717 * @param selected Use @c EINA_TRUE, to make it selected, @c
8718 * EINA_FALSE to make it unselected
8720 * This sets the selected state of an item. If multi-selection is
8721 * not enabled on the containing gengrid and @p selected is @c
8722 * EINA_TRUE, any other previously selected items will get
8723 * unselected in favor of this new one.
8725 * @see elm_gengrid_item_selected_get()
8729 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
8732 * Get whether a given gengrid item is selected or not
8734 * @param item The gengrid item
8735 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
8737 * This API returns EINA_TRUE for all the items selected in multi-select mode as well.
8739 * @see elm_gengrid_item_selected_set() for more details
8743 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8746 * Get the real Evas object created to implement the view of a
8747 * given gengrid item
8749 * @param item The gengrid item.
8750 * @return the Evas object implementing this item's view.
8752 * This returns the actual Evas object used to implement the
8753 * specified gengrid item's view. This may be @c NULL, as it may
8754 * not have been created or may have been deleted, at any time, by
8755 * the gengrid. <b>Do not modify this object</b> (move, resize,
8756 * show, hide, etc.), as the gengrid is controlling it. This
8757 * function is for querying, emitting custom signals or hooking
8758 * lower level callbacks for events on that object. Do not delete
8759 * this object under any circumstances.
8761 * @see elm_gengrid_item_data_get()
8765 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8768 * Show the portion of a gengrid's internal grid containing a given
8769 * item, @b immediately.
8771 * @param item The item to display
8773 * This causes gengrid to @b redraw its viewport's contents to the
8774 * region contining the given @p item item, if it is not fully
8777 * @see elm_gengrid_item_bring_in()
8781 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8784 * Animatedly bring in, to the visible area of a gengrid, a given
8787 * @param item The gengrid item to display
8789 * This causes gengrid to jump to the given @p item and show
8790 * it (by scrolling), if it is not fully visible. This will use
8791 * animation to do so and take a period of time to complete.
8793 * @see elm_gengrid_item_show()
8797 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8800 * Set whether a given gengrid item is disabled or not.
8802 * @param item The gengrid item
8803 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
8804 * to enable it back.
8806 * A disabled item cannot be selected or unselected. It will also
8807 * change its appearance, to signal the user it's disabled.
8809 * @see elm_gengrid_item_disabled_get()
8813 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
8816 * Get whether a given gengrid item is disabled or not.
8818 * @param item The gengrid item
8819 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
8822 * @see elm_gengrid_item_disabled_set() for more details
8826 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8829 * Set the text to be shown in a given gengrid item's tooltips.
8831 * @param item The gengrid item
8832 * @param text The text to set in the content
8834 * This call will setup the text to be used as tooltip to that item
8835 * (analogous to elm_object_tooltip_text_set(), but being item
8836 * tooltips with higher precedence than object tooltips). It can
8837 * have only one tooltip at a time, so any previous tooltip data
8842 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
8845 * Set the content to be shown in a given gengrid item's tooltip
8847 * @param item The gengrid item.
8848 * @param func The function returning the tooltip contents.
8849 * @param data What to provide to @a func as callback data/context.
8850 * @param del_cb Called when data is not needed anymore, either when
8851 * another callback replaces @p func, the tooltip is unset with
8852 * elm_gengrid_item_tooltip_unset() or the owner @p item
8853 * dies. This callback receives as its first parameter the
8854 * given @p data, being @c event_info the item handle.
8856 * This call will setup the tooltip's contents to @p item
8857 * (analogous to elm_object_tooltip_content_cb_set(), but being
8858 * item tooltips with higher precedence than object tooltips). It
8859 * can have only one tooltip at a time, so any previous tooltip
8860 * content will get removed. @p func (with @p data) will be called
8861 * every time Elementary needs to show the tooltip and it should
8862 * return a valid Evas object, which will be fully managed by the
8863 * tooltip system, getting deleted when the tooltip is gone.
8867 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);
8870 * Unset a tooltip from a given gengrid item
8872 * @param item gengrid item to remove a previously set tooltip from.
8874 * This call removes any tooltip set on @p item. The callback
8875 * provided as @c del_cb to
8876 * elm_gengrid_item_tooltip_content_cb_set() will be called to
8877 * notify it is not used anymore (and have resources cleaned, if
8880 * @see elm_gengrid_item_tooltip_content_cb_set()
8884 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8887 * Set a different @b style for a given gengrid item's tooltip.
8889 * @param item gengrid item with tooltip set
8890 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
8891 * "default", @c "transparent", etc)
8893 * Tooltips can have <b>alternate styles</b> to be displayed on,
8894 * which are defined by the theme set on Elementary. This function
8895 * works analogously as elm_object_tooltip_style_set(), but here
8896 * applied only to gengrid item objects. The default style for
8897 * tooltips is @c "default".
8899 * @note before you set a style you should define a tooltip with
8900 * elm_gengrid_item_tooltip_content_cb_set() or
8901 * elm_gengrid_item_tooltip_text_set()
8903 * @see elm_gengrid_item_tooltip_style_get()
8907 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
8910 * Get the style set a given gengrid item's tooltip.
8912 * @param item gengrid item with tooltip already set on.
8913 * @return style the theme style in use, which defaults to
8914 * "default". If the object does not have a tooltip set,
8915 * then @c NULL is returned.
8917 * @see elm_gengrid_item_tooltip_style_set() for more details
8921 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8923 * Set the type of mouse pointer/cursor decoration to be shown,
8924 * when the mouse pointer is over the given gengrid widget item
8926 * @param item gengrid item to customize cursor on
8927 * @param cursor the cursor type's name
8929 * This function works analogously as elm_object_cursor_set(), but
8930 * here the cursor's changing area is restricted to the item's
8931 * area, and not the whole widget's. Note that that item cursors
8932 * have precedence over widget cursors, so that a mouse over @p
8933 * item will always show cursor @p type.
8935 * If this function is called twice for an object, a previously set
8936 * cursor will be unset on the second call.
8938 * @see elm_object_cursor_set()
8939 * @see elm_gengrid_item_cursor_get()
8940 * @see elm_gengrid_item_cursor_unset()
8944 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
8947 * Get the type of mouse pointer/cursor decoration set to be shown,
8948 * when the mouse pointer is over the given gengrid widget item
8950 * @param item gengrid item with custom cursor set
8951 * @return the cursor type's name or @c NULL, if no custom cursors
8952 * were set to @p item (and on errors)
8954 * @see elm_object_cursor_get()
8955 * @see elm_gengrid_item_cursor_set() for more details
8956 * @see elm_gengrid_item_cursor_unset()
8960 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8963 * Unset any custom mouse pointer/cursor decoration set to be
8964 * shown, when the mouse pointer is over the given gengrid widget
8965 * item, thus making it show the @b default cursor again.
8967 * @param item a gengrid item
8969 * Use this call to undo any custom settings on this item's cursor
8970 * decoration, bringing it back to defaults (no custom style set).
8972 * @see elm_object_cursor_unset()
8973 * @see elm_gengrid_item_cursor_set() for more details
8977 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8980 * Set a different @b style for a given custom cursor set for a
8983 * @param item gengrid item with custom cursor set
8984 * @param style the <b>theme style</b> to use (e.g. @c "default",
8985 * @c "transparent", etc)
8987 * This function only makes sense when one is using custom mouse
8988 * cursor decorations <b>defined in a theme file</b> , which can
8989 * have, given a cursor name/type, <b>alternate styles</b> on
8990 * it. It works analogously as elm_object_cursor_style_set(), but
8991 * here applied only to gengrid item objects.
8993 * @warning Before you set a cursor style you should have defined a
8994 * custom cursor previously on the item, with
8995 * elm_gengrid_item_cursor_set()
8997 * @see elm_gengrid_item_cursor_engine_only_set()
8998 * @see elm_gengrid_item_cursor_style_get()
9002 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9005 * Get the current @b style set for a given gengrid item's custom
9008 * @param item gengrid item with custom cursor set.
9009 * @return style the cursor style in use. If the object does not
9010 * have a cursor set, then @c NULL is returned.
9012 * @see elm_gengrid_item_cursor_style_set() for more details
9016 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9019 * Set if the (custom) cursor for a given gengrid item should be
9020 * searched in its theme, also, or should only rely on the
9023 * @param item item with custom (custom) cursor already set on
9024 * @param engine_only Use @c EINA_TRUE to have cursors looked for
9025 * only on those provided by the rendering engine, @c EINA_FALSE to
9026 * have them searched on the widget's theme, as well.
9028 * @note This call is of use only if you've set a custom cursor
9029 * for gengrid items, with elm_gengrid_item_cursor_set().
9031 * @note By default, cursors will only be looked for between those
9032 * provided by the rendering engine.
9036 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9039 * Get if the (custom) cursor for a given gengrid item is being
9040 * searched in its theme, also, or is only relying on the rendering
9043 * @param item a gengrid item
9044 * @return @c EINA_TRUE, if cursors are being looked for only on
9045 * those provided by the rendering engine, @c EINA_FALSE if they
9046 * are being searched on the widget's theme, as well.
9048 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
9052 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9055 * Remove all items from a given gengrid widget
9057 * @param obj The gengrid object.
9059 * This removes (and deletes) all items in @p obj, leaving it
9062 * @see elm_gengrid_item_del(), to remove just one item.
9066 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9069 * Get the selected item in a given gengrid widget
9071 * @param obj The gengrid object.
9072 * @return The selected item's handleor @c NULL, if none is
9073 * selected at the moment (and on errors)
9075 * This returns the selected item in @p obj. If multi selection is
9076 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
9077 * the first item in the list is selected, which might not be very
9078 * useful. For that case, see elm_gengrid_selected_items_get().
9082 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9085 * Get <b>a list</b> of selected items in a given gengrid
9087 * @param obj The gengrid object.
9088 * @return The list of selected items or @c NULL, if none is
9089 * selected at the moment (and on errors)
9091 * This returns a list of the selected items, in the order that
9092 * they appear in the grid. This list is only valid as long as no
9093 * more items are selected or unselected (or unselected implictly
9094 * by deletion). The list contains #Elm_Gengrid_Item pointers as
9097 * @see elm_gengrid_selected_item_get()
9101 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9108 * @defgroup Clock Clock
9110 * This is a @b digital clock widget. In its default theme, it has a
9111 * vintage "flipping numbers clock" appearance, which will animate
9112 * sheets of individual algarisms individually as time goes by.
9114 * A newly created clock will fetch system's time (already
9115 * considering local time adjustments) to start with, and will tick
9116 * accondingly. It may or may not show seconds.
9118 * Clocks have an @b edition mode. When in it, the sheets will
9119 * display extra arrow indications on the top and bottom and the
9120 * user may click on them to raise or lower the time values. After
9121 * it's told to exit edition mode, it will keep ticking with that
9122 * new time set (it keeps the difference from local time).
9124 * Also, when under edition mode, user clicks on the cited arrows
9125 * which are @b held for some time will make the clock to flip the
9126 * sheet, thus editing the time, continuosly and automatically for
9127 * the user. The interval between sheet flips will keep growing in
9128 * time, so that it helps the user to reach a time which is distant
9131 * The time display is, by default, in military mode (24h), but an
9132 * am/pm indicator may be optionally shown, too, when it will
9135 * Smart callbacks one can register to:
9136 * - "changed" - the clock's user changed the time
9138 * Here is an example on its usage:
9139 * @li @ref clock_example
9148 * Identifiers for which clock digits should be editable, when a
9149 * clock widget is in edition mode. Values may be ORed together to
9150 * make a mask, naturally.
9152 * @see elm_clock_edit_set()
9153 * @see elm_clock_digit_edit_set()
9155 typedef enum _Elm_Clock_Digedit
9157 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9158 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9159 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
9160 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9161 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
9162 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9163 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
9164 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
9165 } Elm_Clock_Digedit;
9168 * Add a new clock widget to the given parent Elementary
9169 * (container) object
9171 * @param parent The parent object
9172 * @return a new clock widget handle or @c NULL, on errors
9174 * This function inserts a new clock widget on the canvas.
9178 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9181 * Set a clock widget's time, programmatically
9183 * @param obj The clock widget object
9184 * @param hrs The hours to set
9185 * @param min The minutes to set
9186 * @param sec The secondes to set
9188 * This function updates the time that is showed by the clock
9191 * Values @b must be set within the following ranges:
9192 * - 0 - 23, for hours
9193 * - 0 - 59, for minutes
9194 * - 0 - 59, for seconds,
9196 * even if the clock is not in "military" mode.
9198 * @warning The behavior for values set out of those ranges is @b
9203 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9206 * Get a clock widget's time values
9208 * @param obj The clock object
9209 * @param[out] hrs Pointer to the variable to get the hours value
9210 * @param[out] min Pointer to the variable to get the minutes value
9211 * @param[out] sec Pointer to the variable to get the seconds value
9213 * This function gets the time set for @p obj, returning
9214 * it on the variables passed as the arguments to function
9216 * @note Use @c NULL pointers on the time values you're not
9217 * interested in: they'll be ignored by the function.
9221 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9224 * Set whether a given clock widget is under <b>edition mode</b> or
9225 * under (default) displaying-only mode.
9227 * @param obj The clock object
9228 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9229 * put it back to "displaying only" mode
9231 * This function makes a clock's time to be editable or not <b>by
9232 * user interaction</b>. When in edition mode, clocks @b stop
9233 * ticking, until one brings them back to canonical mode. The
9234 * elm_clock_digit_edit_set() function will influence which digits
9235 * of the clock will be editable. By default, all of them will be
9236 * (#ELM_CLOCK_NONE).
9238 * @note am/pm sheets, if being shown, will @b always be editable
9239 * under edition mode.
9241 * @see elm_clock_edit_get()
9245 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9248 * Retrieve whether a given clock widget is under <b>edition
9249 * mode</b> or under (default) displaying-only mode.
9251 * @param obj The clock object
9252 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9255 * This function retrieves whether the clock's time can be edited
9256 * or not by user interaction.
9258 * @see elm_clock_edit_set() for more details
9262 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9265 * Set what digits of the given clock widget should be editable
9266 * when in edition mode.
9268 * @param obj The clock object
9269 * @param digedit Bit mask indicating the digits to be editable
9270 * (values in #Elm_Clock_Digedit).
9272 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9273 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9276 * @see elm_clock_digit_edit_get()
9280 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9283 * Retrieve what digits of the given clock widget should be
9284 * editable when in edition mode.
9286 * @param obj The clock object
9287 * @return Bit mask indicating the digits to be editable
9288 * (values in #Elm_Clock_Digedit).
9290 * @see elm_clock_digit_edit_set() for more details
9294 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9297 * Set if the given clock widget must show hours in military or
9300 * @param obj The clock object
9301 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9304 * This function sets if the clock must show hours in military or
9305 * am/pm mode. In some countries like Brazil the military mode
9306 * (00-24h-format) is used, in opposition to the USA, where the
9307 * am/pm mode is more commonly used.
9309 * @see elm_clock_show_am_pm_get()
9313 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9316 * Get if the given clock widget shows hours in military or am/pm
9319 * @param obj The clock object
9320 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9323 * This function gets if the clock shows hours in military or am/pm
9326 * @see elm_clock_show_am_pm_set() for more details
9330 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9333 * Set if the given clock widget must show time with seconds or not
9335 * @param obj The clock object
9336 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9338 * This function sets if the given clock must show or not elapsed
9339 * seconds. By default, they are @b not shown.
9341 * @see elm_clock_show_seconds_get()
9345 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9348 * Get whether the given clock widget is showing time with seconds
9351 * @param obj The clock object
9352 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9354 * This function gets whether @p obj is showing or not the elapsed
9357 * @see elm_clock_show_seconds_set()
9361 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9364 * Set the interval on time updates for an user mouse button hold
9365 * on clock widgets' time edition.
9367 * @param obj The clock object
9368 * @param interval The (first) interval value in seconds
9370 * This interval value is @b decreased while the user holds the
9371 * mouse pointer either incrementing or decrementing a given the
9372 * clock digit's value.
9374 * This helps the user to get to a given time distant from the
9375 * current one easier/faster, as it will start to flip quicker and
9376 * quicker on mouse button holds.
9378 * The calculation for the next flip interval value, starting from
9379 * the one set with this call, is the previous interval divided by
9380 * 1.05, so it decreases a little bit.
9382 * The default starting interval value for automatic flips is
9385 * @see elm_clock_interval_get()
9389 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9392 * Get the interval on time updates for an user mouse button hold
9393 * on clock widgets' time edition.
9395 * @param obj The clock object
9396 * @return The (first) interval value, in seconds, set on it
9398 * @see elm_clock_interval_set() for more details
9402 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9409 * @defgroup Layout Layout
9411 * @image html img/widget/layout/preview-00.png
9412 * @image latex img/widget/layout/preview-00.eps width=\textwidth
9414 * @image html img/layout-predefined.png
9415 * @image latex img/layout-predefined.eps width=\textwidth
9417 * This is a container widget that takes a standard Edje design file and
9418 * wraps it very thinly in a widget.
9420 * An Edje design (theme) file has a very wide range of possibilities to
9421 * describe the behavior of elements added to the Layout. Check out the Edje
9422 * documentation and the EDC reference to get more information about what can
9423 * be done with Edje.
9425 * Just like @ref List, @ref Box, and other container widgets, any
9426 * object added to the Layout will become its child, meaning that it will be
9427 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9429 * The Layout widget can contain as many Contents, Boxes or Tables as
9430 * described in its theme file. For instance, objects can be added to
9431 * different Tables by specifying the respective Table part names. The same
9432 * is valid for Content and Box.
9434 * The objects added as child of the Layout will behave as described in the
9435 * part description where they were added. There are 3 possible types of
9436 * parts where a child can be added:
9438 * @section secContent Content (SWALLOW part)
9440 * Only one object can be added to the @c SWALLOW part (but you still can
9441 * have many @c SWALLOW parts and one object on each of them). Use the @c
9442 * elm_object_content_set/get/unset functions to set, retrieve and unset
9443 * objects as content of the @c SWALLOW. After being set to this part, the
9444 * object size, position, visibility, clipping and other description
9445 * properties will be totally controled by the description of the given part
9446 * (inside the Edje theme file).
9448 * One can use @c evas_object_size_hint_* functions on the child to have some
9449 * kind of control over its behavior, but the resulting behavior will still
9450 * depend heavily on the @c SWALLOW part description.
9452 * The Edje theme also can change the part description, based on signals or
9453 * scripts running inside the theme. This change can also be animated. All of
9454 * this will affect the child object set as content accordingly. The object
9455 * size will be changed if the part size is changed, it will animate move if
9456 * the part is moving, and so on.
9458 * The following picture demonstrates a Layout widget with a child object
9459 * added to its @c SWALLOW:
9461 * @image html layout_swallow.png
9462 * @image latex layout_swallow.eps width=\textwidth
9464 * @section secBox Box (BOX part)
9466 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9467 * allows one to add objects to the box and have them distributed along its
9468 * area, accordingly to the specified @a layout property (now by @a layout we
9469 * mean the chosen layouting design of the Box, not the Layout widget
9472 * A similar effect for having a box with its position, size and other things
9473 * controled by the Layout theme would be to create an Elementary @ref Box
9474 * widget and add it as a Content in the @c SWALLOW part.
9476 * The main difference of using the Layout Box is that its behavior, the box
9477 * properties like layouting format, padding, align, etc. will be all
9478 * controled by the theme. This means, for example, that a signal could be
9479 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9480 * handled the signal by changing the box padding, or align, or both. Using
9481 * the Elementary @ref Box widget is not necessarily harder or easier, it
9482 * just depends on the circunstances and requirements.
9484 * The Layout Box can be used through the @c elm_layout_box_* set of
9487 * The following picture demonstrates a Layout widget with many child objects
9488 * added to its @c BOX part:
9490 * @image html layout_box.png
9491 * @image latex layout_box.eps width=\textwidth
9493 * @section secTable Table (TABLE part)
9495 * Just like the @ref secBox, the Layout Table is very similar to the
9496 * Elementary @ref Table widget. It allows one to add objects to the Table
9497 * specifying the row and column where the object should be added, and any
9498 * column or row span if necessary.
9500 * Again, we could have this design by adding a @ref Table widget to the @c
9501 * SWALLOW part using elm_object_content_part_set(). The same difference happens
9502 * here when choosing to use the Layout Table (a @c TABLE part) instead of
9503 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9505 * The Layout Table can be used through the @c elm_layout_table_* set of
9508 * The following picture demonstrates a Layout widget with many child objects
9509 * added to its @c TABLE part:
9511 * @image html layout_table.png
9512 * @image latex layout_table.eps width=\textwidth
9514 * @section secPredef Predefined Layouts
9516 * Another interesting thing about the Layout widget is that it offers some
9517 * predefined themes that come with the default Elementary theme. These
9518 * themes can be set by the call elm_layout_theme_set(), and provide some
9519 * basic functionality depending on the theme used.
9521 * Most of them already send some signals, some already provide a toolbar or
9522 * back and next buttons.
9524 * These are available predefined theme layouts. All of them have class = @c
9525 * layout, group = @c application, and style = one of the following options:
9527 * @li @c toolbar-content - application with toolbar and main content area
9528 * @li @c toolbar-content-back - application with toolbar and main content
9529 * area with a back button and title area
9530 * @li @c toolbar-content-back-next - application with toolbar and main
9531 * content area with a back and next buttons and title area
9532 * @li @c content-back - application with a main content area with a back
9533 * button and title area
9534 * @li @c content-back-next - application with a main content area with a
9535 * back and next buttons and title area
9536 * @li @c toolbar-vbox - application with toolbar and main content area as a
9538 * @li @c toolbar-table - application with toolbar and main content area as a
9541 * @section secExamples Examples
9543 * Some examples of the Layout widget can be found here:
9544 * @li @ref layout_example_01
9545 * @li @ref layout_example_02
9546 * @li @ref layout_example_03
9547 * @li @ref layout_example_edc
9552 * Add a new layout to the parent
9554 * @param parent The parent object
9555 * @return The new object or NULL if it cannot be created
9557 * @see elm_layout_file_set()
9558 * @see elm_layout_theme_set()
9562 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9564 * Set the file that will be used as layout
9566 * @param obj The layout object
9567 * @param file The path to file (edj) that will be used as layout
9568 * @param group The group that the layout belongs in edje file
9570 * @return (1 = success, 0 = error)
9574 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9576 * Set the edje group from the elementary theme that will be used as layout
9578 * @param obj The layout object
9579 * @param clas the clas of the group
9580 * @param group the group
9581 * @param style the style to used
9583 * @return (1 = success, 0 = error)
9587 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9589 * Set the layout content.
9591 * @param obj The layout object
9592 * @param swallow The swallow part name in the edje file
9593 * @param content The child that will be added in this layout object
9595 * Once the content object is set, a previously set one will be deleted.
9596 * If you want to keep that old content object, use the
9597 * elm_object_content_part_unset() function.
9599 * @note In an Edje theme, the part used as a content container is called @c
9600 * SWALLOW. This is why the parameter name is called @p swallow, but it is
9601 * expected to be a part name just like the second parameter of
9602 * elm_layout_box_append().
9604 * @see elm_layout_box_append()
9605 * @see elm_object_content_part_get()
9606 * @see elm_object_content_part_unset()
9611 EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9613 * Get the child object in the given content part.
9615 * @param obj The layout object
9616 * @param swallow The SWALLOW part to get its content
9618 * @return The swallowed object or NULL if none or an error occurred
9620 * @see elm_object_content_part_set()
9624 EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9626 * Unset the layout content.
9628 * @param obj The layout object
9629 * @param swallow The swallow part name in the edje file
9630 * @return The content that was being used
9632 * Unparent and return the content object which was set for this part.
9634 * @see elm_object_content_part_set()
9638 EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9640 * Set the text of the given part
9642 * @param obj The layout object
9643 * @param part The TEXT part where to set the text
9644 * @param text The text to set
9647 * @deprecated use elm_object_text_* instead.
9649 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
9651 * Get the text set in the given part
9653 * @param obj The layout object
9654 * @param part The TEXT part to retrieve the text off
9656 * @return The text set in @p part
9659 * @deprecated use elm_object_text_* instead.
9661 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
9663 * Append child to layout box part.
9665 * @param obj the layout object
9666 * @param part the box part to which the object will be appended.
9667 * @param child the child object to append to box.
9669 * Once the object is appended, it will become child of the layout. Its
9670 * lifetime will be bound to the layout, whenever the layout dies the child
9671 * will be deleted automatically. One should use elm_layout_box_remove() to
9672 * make this layout forget about the object.
9674 * @see elm_layout_box_prepend()
9675 * @see elm_layout_box_insert_before()
9676 * @see elm_layout_box_insert_at()
9677 * @see elm_layout_box_remove()
9681 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9683 * Prepend child to layout box part.
9685 * @param obj the layout object
9686 * @param part the box part to prepend.
9687 * @param child the child object to prepend to box.
9689 * Once the object is prepended, it will become child of the layout. Its
9690 * lifetime will be bound to the layout, whenever the layout dies the child
9691 * will be deleted automatically. One should use elm_layout_box_remove() to
9692 * make this layout forget about the object.
9694 * @see elm_layout_box_append()
9695 * @see elm_layout_box_insert_before()
9696 * @see elm_layout_box_insert_at()
9697 * @see elm_layout_box_remove()
9701 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9703 * Insert child to layout box part before a reference object.
9705 * @param obj the layout object
9706 * @param part the box part to insert.
9707 * @param child the child object to insert into box.
9708 * @param reference another reference object to insert before in box.
9710 * Once the object is inserted, it will become child of the layout. Its
9711 * lifetime will be bound to the layout, whenever the layout dies the child
9712 * will be deleted automatically. One should use elm_layout_box_remove() to
9713 * make this layout forget about the object.
9715 * @see elm_layout_box_append()
9716 * @see elm_layout_box_prepend()
9717 * @see elm_layout_box_insert_before()
9718 * @see elm_layout_box_remove()
9722 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
9724 * Insert child to layout box part at a given position.
9726 * @param obj the layout object
9727 * @param part the box part to insert.
9728 * @param child the child object to insert into box.
9729 * @param pos the numeric position >=0 to insert the child.
9731 * Once the object is inserted, it will become child of the layout. Its
9732 * lifetime will be bound to the layout, whenever the layout dies the child
9733 * will be deleted automatically. One should use elm_layout_box_remove() to
9734 * make this layout forget about the object.
9736 * @see elm_layout_box_append()
9737 * @see elm_layout_box_prepend()
9738 * @see elm_layout_box_insert_before()
9739 * @see elm_layout_box_remove()
9743 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
9745 * Remove a child of the given part box.
9747 * @param obj The layout object
9748 * @param part The box part name to remove child.
9749 * @param child The object to remove from box.
9750 * @return The object that was being used, or NULL if not found.
9752 * The object will be removed from the box part and its lifetime will
9753 * not be handled by the layout anymore. This is equivalent to
9754 * elm_object_content_part_unset() for box.
9756 * @see elm_layout_box_append()
9757 * @see elm_layout_box_remove_all()
9761 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
9763 * Remove all child of the given part box.
9765 * @param obj The layout object
9766 * @param part The box part name to remove child.
9767 * @param clear If EINA_TRUE, then all objects will be deleted as
9768 * well, otherwise they will just be removed and will be
9769 * dangling on the canvas.
9771 * The objects will be removed from the box part and their lifetime will
9772 * not be handled by the layout anymore. This is equivalent to
9773 * elm_layout_box_remove() for all box children.
9775 * @see elm_layout_box_append()
9776 * @see elm_layout_box_remove()
9780 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9782 * Insert child to layout table part.
9784 * @param obj the layout object
9785 * @param part the box part to pack child.
9786 * @param child_obj the child object to pack into table.
9787 * @param col the column to which the child should be added. (>= 0)
9788 * @param row the row to which the child should be added. (>= 0)
9789 * @param colspan how many columns should be used to store this object. (>=
9791 * @param rowspan how many rows should be used to store this object. (>= 1)
9793 * Once the object is inserted, it will become child of the table. Its
9794 * lifetime will be bound to the layout, and whenever the layout dies the
9795 * child will be deleted automatically. One should use
9796 * elm_layout_table_remove() to make this layout forget about the object.
9798 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
9799 * more space than a single cell. For instance, the following code:
9801 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
9804 * Would result in an object being added like the following picture:
9806 * @image html layout_colspan.png
9807 * @image latex layout_colspan.eps width=\textwidth
9809 * @see elm_layout_table_unpack()
9810 * @see elm_layout_table_clear()
9814 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);
9816 * Unpack (remove) a child of the given part table.
9818 * @param obj The layout object
9819 * @param part The table part name to remove child.
9820 * @param child_obj The object to remove from table.
9821 * @return The object that was being used, or NULL if not found.
9823 * The object will be unpacked from the table part and its lifetime
9824 * will not be handled by the layout anymore. This is equivalent to
9825 * elm_object_content_part_unset() for table.
9827 * @see elm_layout_table_pack()
9828 * @see elm_layout_table_clear()
9832 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
9834 * Remove all child of the given part table.
9836 * @param obj The layout object
9837 * @param part The table part name to remove child.
9838 * @param clear If EINA_TRUE, then all objects will be deleted as
9839 * well, otherwise they will just be removed and will be
9840 * dangling on the canvas.
9842 * The objects will be removed from the table part and their lifetime will
9843 * not be handled by the layout anymore. This is equivalent to
9844 * elm_layout_table_unpack() for all table children.
9846 * @see elm_layout_table_pack()
9847 * @see elm_layout_table_unpack()
9851 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9853 * Get the edje layout
9855 * @param obj The layout object
9857 * @return A Evas_Object with the edje layout settings loaded
9858 * with function elm_layout_file_set
9860 * This returns the edje object. It is not expected to be used to then
9861 * swallow objects via edje_object_part_swallow() for example. Use
9862 * elm_object_content_part_set() instead so child object handling and sizing is
9865 * @note This function should only be used if you really need to call some
9866 * low level Edje function on this edje object. All the common stuff (setting
9867 * text, emitting signals, hooking callbacks to signals, etc.) can be done
9868 * with proper elementary functions.
9870 * @see elm_object_signal_callback_add()
9871 * @see elm_object_signal_emit()
9872 * @see elm_object_text_part_set()
9873 * @see elm_object_content_part_set()
9874 * @see elm_layout_box_append()
9875 * @see elm_layout_table_pack()
9876 * @see elm_layout_data_get()
9880 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9882 * Get the edje data from the given layout
9884 * @param obj The layout object
9885 * @param key The data key
9887 * @return The edje data string
9889 * This function fetches data specified inside the edje theme of this layout.
9890 * This function return NULL if data is not found.
9892 * In EDC this comes from a data block within the group block that @p
9893 * obj was loaded from. E.g.
9900 * item: "key1" "value1";
9901 * item: "key2" "value2";
9909 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
9913 * @param obj The layout object
9915 * Manually forces a sizing re-evaluation. This is useful when the minimum
9916 * size required by the edje theme of this layout has changed. The change on
9917 * the minimum size required by the edje theme is not immediately reported to
9918 * the elementary layout, so one needs to call this function in order to tell
9919 * the widget (layout) that it needs to reevaluate its own size.
9921 * The minimum size of the theme is calculated based on minimum size of
9922 * parts, the size of elements inside containers like box and table, etc. All
9923 * of this can change due to state changes, and that's when this function
9926 * Also note that a standard signal of "size,eval" "elm" emitted from the
9927 * edje object will cause this to happen too.
9931 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
9934 * Sets a specific cursor for an edje part.
9936 * @param obj The layout object.
9937 * @param part_name a part from loaded edje group.
9938 * @param cursor cursor name to use, see Elementary_Cursor.h
9940 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9941 * part not exists or it has "mouse_events: 0".
9945 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
9948 * Get the cursor to be shown when mouse is over an edje part
9950 * @param obj The layout object.
9951 * @param part_name a part from loaded edje group.
9952 * @return the cursor name.
9956 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9959 * Unsets a cursor previously set with elm_layout_part_cursor_set().
9961 * @param obj The layout object.
9962 * @param part_name a part from loaded edje group, that had a cursor set
9963 * with elm_layout_part_cursor_set().
9967 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9970 * Sets a specific cursor style for an edje part.
9972 * @param obj The layout object.
9973 * @param part_name a part from loaded edje group.
9974 * @param style the theme style to use (default, transparent, ...)
9976 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9977 * part not exists or it did not had a cursor set.
9981 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
9984 * Gets a specific cursor style for an edje part.
9986 * @param obj The layout object.
9987 * @param part_name a part from loaded edje group.
9989 * @return the theme style in use, defaults to "default". If the
9990 * object does not have a cursor set, then NULL is returned.
9994 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9997 * Sets if the cursor set should be searched on the theme or should use
9998 * the provided by the engine, only.
10000 * @note before you set if should look on theme you should define a
10001 * cursor with elm_layout_part_cursor_set(). By default it will only
10002 * look for cursors provided by the engine.
10004 * @param obj The layout object.
10005 * @param part_name a part from loaded edje group.
10006 * @param engine_only if cursors should be just provided by the engine
10007 * or should also search on widget's theme as well
10009 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10010 * part not exists or it did not had a cursor set.
10014 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);
10017 * Gets a specific cursor engine_only for an edje part.
10019 * @param obj The layout object.
10020 * @param part_name a part from loaded edje group.
10022 * @return whenever the cursor is just provided by engine or also from theme.
10026 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10029 * @def elm_layout_icon_set
10030 * Convienience macro to set the icon object in a layout that follows the
10031 * Elementary naming convention for its parts.
10035 #define elm_layout_icon_set(_ly, _obj) \
10038 elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
10039 if ((_obj)) sig = "elm,state,icon,visible"; \
10040 else sig = "elm,state,icon,hidden"; \
10041 elm_object_signal_emit((_ly), sig, "elm"); \
10045 * @def elm_layout_icon_get
10046 * Convienience macro to get the icon object from a layout that follows the
10047 * Elementary naming convention for its parts.
10051 #define elm_layout_icon_get(_ly) \
10052 elm_layout_content_get((_ly), "elm.swallow.icon")
10055 * @def elm_layout_end_set
10056 * Convienience macro to set the end object in a layout that follows the
10057 * Elementary naming convention for its parts.
10061 #define elm_layout_end_set(_ly, _obj) \
10064 elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
10065 if ((_obj)) sig = "elm,state,end,visible"; \
10066 else sig = "elm,state,end,hidden"; \
10067 elm_object_signal_emit((_ly), sig, "elm"); \
10071 * @def elm_layout_end_get
10072 * Convienience macro to get the end object in a layout that follows the
10073 * Elementary naming convention for its parts.
10077 #define elm_layout_end_get(_ly) \
10078 elm_layout_content_get((_ly), "elm.swallow.end")
10081 * @def elm_layout_label_set
10082 * Convienience macro to set the label in a layout that follows the
10083 * Elementary naming convention for its parts.
10086 * @deprecated use elm_object_text_* instead.
10088 #define elm_layout_label_set(_ly, _txt) \
10089 elm_layout_text_set((_ly), "elm.text", (_txt))
10092 * @def elm_layout_label_get
10093 * Convenience macro to get the label in a layout that follows the
10094 * Elementary naming convention for its parts.
10097 * @deprecated use elm_object_text_* instead.
10099 #define elm_layout_label_get(_ly) \
10100 elm_layout_text_get((_ly), "elm.text")
10102 /* smart callbacks called:
10103 * "theme,changed" - when elm theme is changed.
10107 * @defgroup Notify Notify
10109 * @image html img/widget/notify/preview-00.png
10110 * @image latex img/widget/notify/preview-00.eps
10112 * Display a container in a particular region of the parent(top, bottom,
10113 * etc). A timeout can be set to automatically hide the notify. This is so
10114 * that, after an evas_object_show() on a notify object, if a timeout was set
10115 * on it, it will @b automatically get hidden after that time.
10117 * Signals that you can add callbacks for are:
10118 * @li "timeout" - when timeout happens on notify and it's hidden
10119 * @li "block,clicked" - when a click outside of the notify happens
10121 * Default contents parts of the notify widget that you can use for are:
10122 * @li "elm.swallow.content" - A content of the notify
10124 * @ref tutorial_notify show usage of the API.
10129 * @brief Possible orient values for notify.
10131 * This values should be used in conjunction to elm_notify_orient_set() to
10132 * set the position in which the notify should appear(relative to its parent)
10133 * and in conjunction with elm_notify_orient_get() to know where the notify
10136 typedef enum _Elm_Notify_Orient
10138 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
10139 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
10140 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
10141 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
10142 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
10143 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
10144 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
10145 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
10146 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10147 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10148 } Elm_Notify_Orient;
10150 * @brief Add a new notify to the parent
10152 * @param parent The parent object
10153 * @return The new object or NULL if it cannot be created
10155 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10157 * @brief Set the content of the notify widget
10159 * @param obj The notify object
10160 * @param content The content will be filled in this notify object
10162 * Once the content object is set, a previously set one will be deleted. If
10163 * you want to keep that old content object, use the
10164 * elm_notify_content_unset() function.
10166 EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10168 * @brief Unset the content of the notify widget
10170 * @param obj The notify object
10171 * @return The content that was being used
10173 * Unparent and return the content object which was set for this widget
10175 * @see elm_notify_content_set()
10177 EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10179 * @brief Return the content of the notify widget
10181 * @param obj The notify object
10182 * @return The content that is being used
10184 * @see elm_notify_content_set()
10186 EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10188 * @brief Set the notify parent
10190 * @param obj The notify object
10191 * @param content The new parent
10193 * Once the parent object is set, a previously set one will be disconnected
10196 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10198 * @brief Get the notify parent
10200 * @param obj The notify object
10201 * @return The parent
10203 * @see elm_notify_parent_set()
10205 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10207 * @brief Set the orientation
10209 * @param obj The notify object
10210 * @param orient The new orientation
10212 * Sets the position in which the notify will appear in its parent.
10214 * @see @ref Elm_Notify_Orient for possible values.
10216 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10218 * @brief Return the orientation
10219 * @param obj The notify object
10220 * @return The orientation of the notification
10222 * @see elm_notify_orient_set()
10223 * @see Elm_Notify_Orient
10225 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10227 * @brief Set the time interval after which the notify window is going to be
10230 * @param obj The notify object
10231 * @param time The timeout in seconds
10233 * This function sets a timeout and starts the timer controlling when the
10234 * notify is hidden. Since calling evas_object_show() on a notify restarts
10235 * the timer controlling when the notify is hidden, setting this before the
10236 * notify is shown will in effect mean starting the timer when the notify is
10239 * @note Set a value <= 0.0 to disable a running timer.
10241 * @note If the value > 0.0 and the notify is previously visible, the
10242 * timer will be started with this value, canceling any running timer.
10244 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10246 * @brief Return the timeout value (in seconds)
10247 * @param obj the notify object
10249 * @see elm_notify_timeout_set()
10251 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10253 * @brief Sets whether events should be passed to by a click outside
10256 * @param obj The notify object
10257 * @param repeats EINA_TRUE Events are repeats, else no
10259 * When true if the user clicks outside the window the events will be caught
10260 * by the others widgets, else the events are blocked.
10262 * @note The default value is EINA_TRUE.
10264 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10266 * @brief Return true if events are repeat below the notify object
10267 * @param obj the notify object
10269 * @see elm_notify_repeat_events_set()
10271 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10277 * @defgroup Hover Hover
10279 * @image html img/widget/hover/preview-00.png
10280 * @image latex img/widget/hover/preview-00.eps
10282 * A Hover object will hover over its @p parent object at the @p target
10283 * location. Anything in the background will be given a darker coloring to
10284 * indicate that the hover object is on top (at the default theme). When the
10285 * hover is clicked it is dismissed(hidden), if the contents of the hover are
10286 * clicked that @b doesn't cause the hover to be dismissed.
10288 * A Hover object has two parents. One parent that owns it during creation
10289 * and the other parent being the one over which the hover object spans.
10292 * @note The hover object will take up the entire space of @p target
10295 * Elementary has the following styles for the hover widget:
10299 * @li hoversel_vertical
10301 * The following are the available position for content:
10313 * Signals that you can add callbacks for are:
10314 * @li "clicked" - the user clicked the empty space in the hover to dismiss
10315 * @li "smart,changed" - a content object placed under the "smart"
10316 * policy was replaced to a new slot direction.
10318 * See @ref tutorial_hover for more information.
10322 typedef enum _Elm_Hover_Axis
10324 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10325 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10326 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10327 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10330 * @brief Adds a hover object to @p parent
10332 * @param parent The parent object
10333 * @return The hover object or NULL if one could not be created
10335 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10337 * @brief Sets the target object for the hover.
10339 * @param obj The hover object
10340 * @param target The object to center the hover onto. The hover
10342 * This function will cause the hover to be centered on the target object.
10344 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10346 * @brief Gets the target object for the hover.
10348 * @param obj The hover object
10349 * @param parent The object to locate the hover over.
10351 * @see elm_hover_target_set()
10353 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10355 * @brief Sets the parent object for the hover.
10357 * @param obj The hover object
10358 * @param parent The object to locate the hover over.
10360 * This function will cause the hover to take up the entire space that the
10361 * parent object fills.
10363 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10365 * @brief Gets the parent object for the hover.
10367 * @param obj The hover object
10368 * @return The parent object to locate the hover over.
10370 * @see elm_hover_parent_set()
10372 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10374 * @brief Sets the content of the hover object and the direction in which it
10377 * @param obj The hover object
10378 * @param swallow The direction that the object will be displayed
10379 * at. Accepted values are "left", "top-left", "top", "top-right",
10380 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10382 * @param content The content to place at @p swallow
10384 * Once the content object is set for a given direction, a previously
10385 * set one (on the same direction) will be deleted. If you want to
10386 * keep that old content object, use the elm_hover_content_unset()
10389 * All directions may have contents at the same time, except for
10390 * "smart". This is a special placement hint and its use case
10391 * independs of the calculations coming from
10392 * elm_hover_best_content_location_get(). Its use is for cases when
10393 * one desires only one hover content, but with a dinamic special
10394 * placement within the hover area. The content's geometry, whenever
10395 * it changes, will be used to decide on a best location not
10396 * extrapolating the hover's parent object view to show it in (still
10397 * being the hover's target determinant of its medium part -- move and
10398 * resize it to simulate finger sizes, for example). If one of the
10399 * directions other than "smart" are used, a previously content set
10400 * using it will be deleted, and vice-versa.
10402 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10404 * @brief Get the content of the hover object, in a given direction.
10406 * Return the content object which was set for this widget in the
10407 * @p swallow direction.
10409 * @param obj The hover object
10410 * @param swallow The direction that the object was display at.
10411 * @return The content that was being used
10413 * @see elm_hover_content_set()
10415 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10417 * @brief Unset the content of the hover object, in a given direction.
10419 * Unparent and return the content object set at @p swallow direction.
10421 * @param obj The hover object
10422 * @param swallow The direction that the object was display at.
10423 * @return The content that was being used.
10425 * @see elm_hover_content_set()
10427 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10429 * @brief Returns the best swallow location for content in the hover.
10431 * @param obj The hover object
10432 * @param pref_axis The preferred orientation axis for the hover object to use
10433 * @return The edje location to place content into the hover or @c
10436 * Best is defined here as the location at which there is the most available
10439 * @p pref_axis may be one of
10440 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10441 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10442 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10443 * - @c ELM_HOVER_AXIS_BOTH -- both
10445 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10446 * nescessarily be along the horizontal axis("left" or "right"). If
10447 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10448 * be along the vertical axis("top" or "bottom"). Chossing
10449 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10450 * returned position may be in either axis.
10452 * @see elm_hover_content_set()
10454 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10461 * @defgroup Entry Entry
10463 * @image html img/widget/entry/preview-00.png
10464 * @image latex img/widget/entry/preview-00.eps width=\textwidth
10465 * @image html img/widget/entry/preview-01.png
10466 * @image latex img/widget/entry/preview-01.eps width=\textwidth
10467 * @image html img/widget/entry/preview-02.png
10468 * @image latex img/widget/entry/preview-02.eps width=\textwidth
10469 * @image html img/widget/entry/preview-03.png
10470 * @image latex img/widget/entry/preview-03.eps width=\textwidth
10472 * An entry is a convenience widget which shows a box that the user can
10473 * enter text into. Entries by default don't scroll, so they grow to
10474 * accomodate the entire text, resizing the parent window as needed. This
10475 * can be changed with the elm_entry_scrollable_set() function.
10477 * They can also be single line or multi line (the default) and when set
10478 * to multi line mode they support text wrapping in any of the modes
10479 * indicated by #Elm_Wrap_Type.
10481 * Other features include password mode, filtering of inserted text with
10482 * elm_entry_text_filter_append() and related functions, inline "items" and
10483 * formatted markup text.
10485 * @section entry-markup Formatted text
10487 * The markup tags supported by the Entry are defined by the theme, but
10488 * even when writing new themes or extensions it's a good idea to stick to
10489 * a sane default, to maintain coherency and avoid application breakages.
10490 * Currently defined by the default theme are the following tags:
10491 * @li \<br\>: Inserts a line break.
10492 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10494 * @li \<tab\>: Inserts a tab.
10495 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10497 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10498 * @li \<link\>...\</link\>: Underlines the enclosed text.
10499 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10501 * @section entry-special Special markups
10503 * Besides those used to format text, entries support two special markup
10504 * tags used to insert clickable portions of text or items inlined within
10507 * @subsection entry-anchors Anchors
10509 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10510 * \</a\> tags and an event will be generated when this text is clicked,
10514 * This text is outside <a href=anc-01>but this one is an anchor</a>
10517 * The @c href attribute in the opening tag gives the name that will be
10518 * used to identify the anchor and it can be any valid utf8 string.
10520 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10521 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10522 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10523 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10526 * @subsection entry-items Items
10528 * Inlined in the text, any other @c Evas_Object can be inserted by using
10529 * \<item\> tags this way:
10532 * <item size=16x16 vsize=full href=emoticon/haha></item>
10535 * Just like with anchors, the @c href identifies each item, but these need,
10536 * in addition, to indicate their size, which is done using any one of
10537 * @c size, @c absize or @c relsize attributes. These attributes take their
10538 * value in the WxH format, where W is the width and H the height of the
10541 * @li absize: Absolute pixel size for the item. Whatever value is set will
10542 * be the item's size regardless of any scale value the object may have
10543 * been set to. The final line height will be adjusted to fit larger items.
10544 * @li size: Similar to @c absize, but it's adjusted to the scale value set
10546 * @li relsize: Size is adjusted for the item to fit within the current
10549 * Besides their size, items are specificed a @c vsize value that affects
10550 * how their final size and position are calculated. The possible values
10552 * @li ascent: Item will be placed within the line's baseline and its
10553 * ascent. That is, the height between the line where all characters are
10554 * positioned and the highest point in the line. For @c size and @c absize
10555 * items, the descent value will be added to the total line height to make
10556 * them fit. @c relsize items will be adjusted to fit within this space.
10557 * @li full: Items will be placed between the descent and ascent, or the
10558 * lowest point in the line and its highest.
10560 * The next image shows different configurations of items and how they
10561 * are the previously mentioned options affect their sizes. In all cases,
10562 * the green line indicates the ascent, blue for the baseline and red for
10565 * @image html entry_item.png
10566 * @image latex entry_item.eps width=\textwidth
10568 * And another one to show how size differs from absize. In the first one,
10569 * the scale value is set to 1.0, while the second one is using one of 2.0.
10571 * @image html entry_item_scale.png
10572 * @image latex entry_item_scale.eps width=\textwidth
10574 * After the size for an item is calculated, the entry will request an
10575 * object to place in its space. For this, the functions set with
10576 * elm_entry_item_provider_append() and related functions will be called
10577 * in order until one of them returns a @c non-NULL value. If no providers
10578 * are available, or all of them return @c NULL, then the entry falls back
10579 * to one of the internal defaults, provided the name matches with one of
10582 * All of the following are currently supported:
10585 * - emoticon/angry-shout
10586 * - emoticon/crazy-laugh
10587 * - emoticon/evil-laugh
10589 * - emoticon/goggle-smile
10590 * - emoticon/grumpy
10591 * - emoticon/grumpy-smile
10592 * - emoticon/guilty
10593 * - emoticon/guilty-smile
10595 * - emoticon/half-smile
10596 * - emoticon/happy-panting
10598 * - emoticon/indifferent
10600 * - emoticon/knowing-grin
10602 * - emoticon/little-bit-sorry
10603 * - emoticon/love-lots
10605 * - emoticon/minimal-smile
10606 * - emoticon/not-happy
10607 * - emoticon/not-impressed
10609 * - emoticon/opensmile
10612 * - emoticon/squint-laugh
10613 * - emoticon/surprised
10614 * - emoticon/suspicious
10615 * - emoticon/tongue-dangling
10616 * - emoticon/tongue-poke
10618 * - emoticon/unhappy
10619 * - emoticon/very-sorry
10622 * - emoticon/worried
10625 * Alternatively, an item may reference an image by its path, using
10626 * the URI form @c file:///path/to/an/image.png and the entry will then
10627 * use that image for the item.
10629 * @section entry-files Loading and saving files
10631 * Entries have convinience functions to load text from a file and save
10632 * changes back to it after a short delay. The automatic saving is enabled
10633 * by default, but can be disabled with elm_entry_autosave_set() and files
10634 * can be loaded directly as plain text or have any markup in them
10635 * recognized. See elm_entry_file_set() for more details.
10637 * @section entry-signals Emitted signals
10639 * This widget emits the following signals:
10641 * @li "changed": The text within the entry was changed.
10642 * @li "changed,user": The text within the entry was changed because of user interaction.
10643 * @li "activated": The enter key was pressed on a single line entry.
10644 * @li "press": A mouse button has been pressed on the entry.
10645 * @li "longpressed": A mouse button has been pressed and held for a couple
10647 * @li "clicked": The entry has been clicked (mouse press and release).
10648 * @li "clicked,double": The entry has been double clicked.
10649 * @li "clicked,triple": The entry has been triple clicked.
10650 * @li "focused": The entry has received focus.
10651 * @li "unfocused": The entry has lost focus.
10652 * @li "selection,paste": A paste of the clipboard contents was requested.
10653 * @li "selection,copy": A copy of the selected text into the clipboard was
10655 * @li "selection,cut": A cut of the selected text into the clipboard was
10657 * @li "selection,start": A selection has begun and no previous selection
10659 * @li "selection,changed": The current selection has changed.
10660 * @li "selection,cleared": The current selection has been cleared.
10661 * @li "cursor,changed": The cursor has changed position.
10662 * @li "anchor,clicked": An anchor has been clicked. The event_info
10663 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10664 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
10665 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10666 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
10667 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10668 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
10669 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10670 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
10671 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10672 * @li "preedit,changed": The preedit string has changed.
10673 * @li "language,changed": Program language changed.
10675 * @section entry-examples
10677 * An overview of the Entry API can be seen in @ref entry_example_01
10682 * @typedef Elm_Entry_Anchor_Info
10684 * The info sent in the callback for the "anchor,clicked" signals emitted
10687 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
10689 * @struct _Elm_Entry_Anchor_Info
10691 * The info sent in the callback for the "anchor,clicked" signals emitted
10694 struct _Elm_Entry_Anchor_Info
10696 const char *name; /**< The name of the anchor, as stated in its href */
10697 int button; /**< The mouse button used to click on it */
10698 Evas_Coord x, /**< Anchor geometry, relative to canvas */
10699 y, /**< Anchor geometry, relative to canvas */
10700 w, /**< Anchor geometry, relative to canvas */
10701 h; /**< Anchor geometry, relative to canvas */
10704 * @typedef Elm_Entry_Filter_Cb
10705 * This callback type is used by entry filters to modify text.
10706 * @param data The data specified as the last param when adding the filter
10707 * @param entry The entry object
10708 * @param text A pointer to the location of the text being filtered. This data can be modified,
10709 * but any additional allocations must be managed by the user.
10710 * @see elm_entry_text_filter_append
10711 * @see elm_entry_text_filter_prepend
10713 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
10716 * This adds an entry to @p parent object.
10718 * By default, entries are:
10722 * @li autosave is enabled
10724 * @param parent The parent object
10725 * @return The new object or NULL if it cannot be created
10727 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10729 * Sets the entry to single line mode.
10731 * In single line mode, entries don't ever wrap when the text reaches the
10732 * edge, and instead they keep growing horizontally. Pressing the @c Enter
10733 * key will generate an @c "activate" event instead of adding a new line.
10735 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
10736 * and pressing enter will break the text into a different line
10737 * without generating any events.
10739 * @param obj The entry object
10740 * @param single_line If true, the text in the entry
10741 * will be on a single line.
10743 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
10745 * Gets whether the entry is set to be single line.
10747 * @param obj The entry object
10748 * @return single_line If true, the text in the entry is set to display
10749 * on a single line.
10751 * @see elm_entry_single_line_set()
10753 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10755 * Sets the entry to password mode.
10757 * In password mode, entries are implicitly single line and the display of
10758 * any text in them is replaced with asterisks (*).
10760 * @param obj The entry object
10761 * @param password If true, password mode is enabled.
10763 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
10765 * Gets whether the entry is set to password mode.
10767 * @param obj The entry object
10768 * @return If true, the entry is set to display all characters
10769 * as asterisks (*).
10771 * @see elm_entry_password_set()
10773 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10775 * This sets the text displayed within the entry to @p entry.
10777 * @param obj The entry object
10778 * @param entry The text to be displayed
10780 * @deprecated Use elm_object_text_set() instead.
10781 * @note Using this function bypasses text filters
10783 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10785 * This returns the text currently shown in object @p entry.
10786 * See also elm_entry_entry_set().
10788 * @param obj The entry object
10789 * @return The currently displayed text or NULL on failure
10791 * @deprecated Use elm_object_text_get() instead.
10793 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10795 * Appends @p entry to the text of the entry.
10797 * Adds the text in @p entry to the end of any text already present in the
10800 * The appended text is subject to any filters set for the widget.
10802 * @param obj The entry object
10803 * @param entry The text to be displayed
10805 * @see elm_entry_text_filter_append()
10807 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10809 * Gets whether the entry is empty.
10811 * Empty means no text at all. If there are any markup tags, like an item
10812 * tag for which no provider finds anything, and no text is displayed, this
10813 * function still returns EINA_FALSE.
10815 * @param obj The entry object
10816 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
10818 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10820 * Gets any selected text within the entry.
10822 * If there's any selected text in the entry, this function returns it as
10823 * a string in markup format. NULL is returned if no selection exists or
10824 * if an error occurred.
10826 * The returned value points to an internal string and should not be freed
10827 * or modified in any way. If the @p entry object is deleted or its
10828 * contents are changed, the returned pointer should be considered invalid.
10830 * @param obj The entry object
10831 * @return The selected text within the entry or NULL on failure
10833 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10835 * Inserts the given text into the entry at the current cursor position.
10837 * This inserts text at the cursor position as if it was typed
10838 * by the user (note that this also allows markup which a user
10839 * can't just "type" as it would be converted to escaped text, so this
10840 * call can be used to insert things like emoticon items or bold push/pop
10841 * tags, other font and color change tags etc.)
10843 * If any selection exists, it will be replaced by the inserted text.
10845 * The inserted text is subject to any filters set for the widget.
10847 * @param obj The entry object
10848 * @param entry The text to insert
10850 * @see elm_entry_text_filter_append()
10852 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10854 * Set the line wrap type to use on multi-line entries.
10856 * Sets the wrap type used by the entry to any of the specified in
10857 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
10858 * line (without inserting a line break or paragraph separator) when it
10859 * reaches the far edge of the widget.
10861 * Note that this only makes sense for multi-line entries. A widget set
10862 * to be single line will never wrap.
10864 * @param obj The entry object
10865 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
10867 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
10868 EINA_DEPRECATED EAPI void elm_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
10870 * Gets the wrap mode the entry was set to use.
10872 * @param obj The entry object
10873 * @return Wrap type
10875 * @see also elm_entry_line_wrap_set()
10877 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10879 * Sets if the entry is to be editable or not.
10881 * By default, entries are editable and when focused, any text input by the
10882 * user will be inserted at the current cursor position. But calling this
10883 * function with @p editable as EINA_FALSE will prevent the user from
10884 * inputting text into the entry.
10886 * The only way to change the text of a non-editable entry is to use
10887 * elm_object_text_set(), elm_entry_entry_insert() and other related
10890 * @param obj The entry object
10891 * @param editable If EINA_TRUE, user input will be inserted in the entry,
10892 * if not, the entry is read-only and no user input is allowed.
10894 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
10896 * Gets whether the entry is editable or not.
10898 * @param obj The entry object
10899 * @return If true, the entry is editable by the user.
10900 * If false, it is not editable by the user
10902 * @see elm_entry_editable_set()
10904 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10906 * This drops any existing text selection within the entry.
10908 * @param obj The entry object
10910 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
10912 * This selects all text within the entry.
10914 * @param obj The entry object
10916 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
10918 * This moves the cursor one place to the right within the entry.
10920 * @param obj The entry object
10921 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10923 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
10925 * This moves the cursor one place to the left within the entry.
10927 * @param obj The entry object
10928 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10930 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
10932 * This moves the cursor one line up within the entry.
10934 * @param obj The entry object
10935 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10937 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
10939 * This moves the cursor one line down within the entry.
10941 * @param obj The entry object
10942 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10944 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
10946 * This moves the cursor to the beginning of the entry.
10948 * @param obj The entry object
10950 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10952 * This moves the cursor to the end of the entry.
10954 * @param obj The entry object
10956 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10958 * This moves the cursor to the beginning of the current line.
10960 * @param obj The entry object
10962 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10964 * This moves the cursor to the end of the current line.
10966 * @param obj The entry object
10968 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10970 * This begins a selection within the entry as though
10971 * the user were holding down the mouse button to make a selection.
10973 * @param obj The entry object
10975 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
10977 * This ends a selection within the entry as though
10978 * the user had just released the mouse button while making a selection.
10980 * @param obj The entry object
10982 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
10984 * Gets whether a format node exists at the current cursor position.
10986 * A format node is anything that defines how the text is rendered. It can
10987 * be a visible format node, such as a line break or a paragraph separator,
10988 * or an invisible one, such as bold begin or end tag.
10989 * This function returns whether any format node exists at the current
10992 * @param obj The entry object
10993 * @return EINA_TRUE if the current cursor position contains a format node,
10994 * EINA_FALSE otherwise.
10996 * @see elm_entry_cursor_is_visible_format_get()
10998 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11000 * Gets if the current cursor position holds a visible format node.
11002 * @param obj The entry object
11003 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
11004 * if it's an invisible one or no format exists.
11006 * @see elm_entry_cursor_is_format_get()
11008 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11010 * Gets the character pointed by the cursor at its current position.
11012 * This function returns a string with the utf8 character stored at the
11013 * current cursor position.
11014 * Only the text is returned, any format that may exist will not be part
11015 * of the return value.
11017 * @param obj The entry object
11018 * @return The text pointed by the cursors.
11020 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11022 * This function returns the geometry of the cursor.
11024 * It's useful if you want to draw something on the cursor (or where it is),
11025 * or for example in the case of scrolled entry where you want to show the
11028 * @param obj The entry object
11029 * @param x returned geometry
11030 * @param y returned geometry
11031 * @param w returned geometry
11032 * @param h returned geometry
11033 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11035 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);
11037 * Sets the cursor position in the entry to the given value
11039 * The value in @p pos is the index of the character position within the
11040 * contents of the string as returned by elm_entry_cursor_pos_get().
11042 * @param obj The entry object
11043 * @param pos The position of the cursor
11045 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
11047 * Retrieves the current position of the cursor in the entry
11049 * @param obj The entry object
11050 * @return The cursor position
11052 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11054 * This executes a "cut" action on the selected text in the entry.
11056 * @param obj The entry object
11058 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
11060 * This executes a "copy" action on the selected text in the entry.
11062 * @param obj The entry object
11064 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
11066 * This executes a "paste" action in the entry.
11068 * @param obj The entry object
11070 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
11072 * This clears and frees the items in a entry's contextual (longpress)
11075 * @param obj The entry object
11077 * @see elm_entry_context_menu_item_add()
11079 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11081 * This adds an item to the entry's contextual menu.
11083 * A longpress on an entry will make the contextual menu show up, if this
11084 * hasn't been disabled with elm_entry_context_menu_disabled_set().
11085 * By default, this menu provides a few options like enabling selection mode,
11086 * which is useful on embedded devices that need to be explicit about it,
11087 * and when a selection exists it also shows the copy and cut actions.
11089 * With this function, developers can add other options to this menu to
11090 * perform any action they deem necessary.
11092 * @param obj The entry object
11093 * @param label The item's text label
11094 * @param icon_file The item's icon file
11095 * @param icon_type The item's icon type
11096 * @param func The callback to execute when the item is clicked
11097 * @param data The data to associate with the item for related functions
11099 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);
11101 * This disables the entry's contextual (longpress) menu.
11103 * @param obj The entry object
11104 * @param disabled If true, the menu is disabled
11106 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11108 * This returns whether the entry's contextual (longpress) menu is
11111 * @param obj The entry object
11112 * @return If true, the menu is disabled
11114 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11116 * This appends a custom item provider to the list for that entry
11118 * This appends the given callback. The list is walked from beginning to end
11119 * with each function called given the item href string in the text. If the
11120 * function returns an object handle other than NULL (it should create an
11121 * object to do this), then this object is used to replace that item. If
11122 * not the next provider is called until one provides an item object, or the
11123 * default provider in entry does.
11125 * @param obj The entry object
11126 * @param func The function called to provide the item object
11127 * @param data The data passed to @p func
11129 * @see @ref entry-items
11131 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);
11133 * This prepends a custom item provider to the list for that entry
11135 * This prepends the given callback. See elm_entry_item_provider_append() for
11138 * @param obj The entry object
11139 * @param func The function called to provide the item object
11140 * @param data The data passed to @p func
11142 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);
11144 * This removes a custom item provider to the list for that entry
11146 * This removes the given callback. See elm_entry_item_provider_append() for
11149 * @param obj The entry object
11150 * @param func The function called to provide the item object
11151 * @param data The data passed to @p func
11153 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);
11155 * Append a filter function for text inserted in the entry
11157 * Append the given callback to the list. This functions will be called
11158 * whenever any text is inserted into the entry, with the text to be inserted
11159 * as a parameter. The callback function is free to alter the text in any way
11160 * it wants, but it must remember to free the given pointer and update it.
11161 * If the new text is to be discarded, the function can free it and set its
11162 * text parameter to NULL. This will also prevent any following filters from
11165 * @param obj The entry object
11166 * @param func The function to use as text filter
11167 * @param data User data to pass to @p func
11169 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11171 * Prepend a filter function for text insdrted in the entry
11173 * Prepend the given callback to the list. See elm_entry_text_filter_append()
11174 * for more information
11176 * @param obj The entry object
11177 * @param func The function to use as text filter
11178 * @param data User data to pass to @p func
11180 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11182 * Remove a filter from the list
11184 * Removes the given callback from the filter list. See
11185 * elm_entry_text_filter_append() for more information.
11187 * @param obj The entry object
11188 * @param func The filter function to remove
11189 * @param data The user data passed when adding the function
11191 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11193 * This converts a markup (HTML-like) string into UTF-8.
11195 * The returned string is a malloc'ed buffer and it should be freed when
11196 * not needed anymore.
11198 * @param s The string (in markup) to be converted
11199 * @return The converted string (in UTF-8). It should be freed.
11201 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11203 * This converts a UTF-8 string into markup (HTML-like).
11205 * The returned string is a malloc'ed buffer and it should be freed when
11206 * not needed anymore.
11208 * @param s The string (in UTF-8) to be converted
11209 * @return The converted string (in markup). It should be freed.
11211 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11213 * This sets the file (and implicitly loads it) for the text to display and
11214 * then edit. All changes are written back to the file after a short delay if
11215 * the entry object is set to autosave (which is the default).
11217 * If the entry had any other file set previously, any changes made to it
11218 * will be saved if the autosave feature is enabled, otherwise, the file
11219 * will be silently discarded and any non-saved changes will be lost.
11221 * @param obj The entry object
11222 * @param file The path to the file to load and save
11223 * @param format The file format
11225 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11227 * Gets the file being edited by the entry.
11229 * This function can be used to retrieve any file set on the entry for
11230 * edition, along with the format used to load and save it.
11232 * @param obj The entry object
11233 * @param file The path to the file to load and save
11234 * @param format The file format
11236 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11238 * This function writes any changes made to the file set with
11239 * elm_entry_file_set()
11241 * @param obj The entry object
11243 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11245 * This sets the entry object to 'autosave' the loaded text file or not.
11247 * @param obj The entry object
11248 * @param autosave Autosave the loaded file or not
11250 * @see elm_entry_file_set()
11252 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11254 * This gets the entry object's 'autosave' status.
11256 * @param obj The entry object
11257 * @return Autosave the loaded file or not
11259 * @see elm_entry_file_set()
11261 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11263 * Control pasting of text and images for the widget.
11265 * Normally the entry allows both text and images to be pasted. By setting
11266 * textonly to be true, this prevents images from being pasted.
11268 * Note this only changes the behaviour of text.
11270 * @param obj The entry object
11271 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11272 * text+image+other.
11274 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11276 * Getting elm_entry text paste/drop mode.
11278 * In textonly mode, only text may be pasted or dropped into the widget.
11280 * @param obj The entry object
11281 * @return If the widget only accepts text from pastes.
11283 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11285 * Enable or disable scrolling in entry
11287 * Normally the entry is not scrollable unless you enable it with this call.
11289 * @param obj The entry object
11290 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11292 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11294 * Get the scrollable state of the entry
11296 * Normally the entry is not scrollable. This gets the scrollable state
11297 * of the entry. See elm_entry_scrollable_set() for more information.
11299 * @param obj The entry object
11300 * @return The scrollable state
11302 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
11304 * This sets a widget to be displayed to the left of a scrolled entry.
11306 * @param obj The scrolled entry object
11307 * @param icon The widget to display on the left side of the scrolled
11310 * @note A previously set widget will be destroyed.
11311 * @note If the object being set does not have minimum size hints set,
11312 * it won't get properly displayed.
11314 * @see elm_entry_end_set()
11316 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11318 * Gets the leftmost widget of the scrolled entry. This object is
11319 * owned by the scrolled entry and should not be modified.
11321 * @param obj The scrolled entry object
11322 * @return the left widget inside the scroller
11324 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11326 * Unset the leftmost widget of the scrolled entry, unparenting and
11329 * @param obj The scrolled entry object
11330 * @return the previously set icon sub-object of this entry, on
11333 * @see elm_entry_icon_set()
11335 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11337 * Sets the visibility of the left-side widget of the scrolled entry,
11338 * set by elm_entry_icon_set().
11340 * @param obj The scrolled entry object
11341 * @param setting EINA_TRUE if the object should be displayed,
11342 * EINA_FALSE if not.
11344 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11346 * This sets a widget to be displayed to the end of a scrolled entry.
11348 * @param obj The scrolled entry object
11349 * @param end The widget to display on the right side of the scrolled
11352 * @note A previously set widget will be destroyed.
11353 * @note If the object being set does not have minimum size hints set,
11354 * it won't get properly displayed.
11356 * @see elm_entry_icon_set
11358 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11360 * Gets the endmost widget of the scrolled entry. This object is owned
11361 * by the scrolled entry and should not be modified.
11363 * @param obj The scrolled entry object
11364 * @return the right widget inside the scroller
11366 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11368 * Unset the endmost widget of the scrolled entry, unparenting and
11371 * @param obj The scrolled entry object
11372 * @return the previously set icon sub-object of this entry, on
11375 * @see elm_entry_icon_set()
11377 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11379 * Sets the visibility of the end widget of the scrolled entry, set by
11380 * elm_entry_end_set().
11382 * @param obj The scrolled entry object
11383 * @param setting EINA_TRUE if the object should be displayed,
11384 * EINA_FALSE if not.
11386 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11388 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11391 * Setting an entry to single-line mode with elm_entry_single_line_set()
11392 * will automatically disable the display of scrollbars when the entry
11393 * moves inside its scroller.
11395 * @param obj The scrolled entry object
11396 * @param h The horizontal scrollbar policy to apply
11397 * @param v The vertical scrollbar policy to apply
11399 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11401 * This enables/disables bouncing within the entry.
11403 * This function sets whether the entry will bounce when scrolling reaches
11404 * the end of the contained entry.
11406 * @param obj The scrolled entry object
11407 * @param h The horizontal bounce state
11408 * @param v The vertical bounce state
11410 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11412 * Get the bounce mode
11414 * @param obj The Entry object
11415 * @param h_bounce Allow bounce horizontally
11416 * @param v_bounce Allow bounce vertically
11418 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11420 /* pre-made filters for entries */
11422 * @typedef Elm_Entry_Filter_Limit_Size
11424 * Data for the elm_entry_filter_limit_size() entry filter.
11426 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11428 * @struct _Elm_Entry_Filter_Limit_Size
11430 * Data for the elm_entry_filter_limit_size() entry filter.
11432 struct _Elm_Entry_Filter_Limit_Size
11434 int max_char_count; /**< The maximum number of characters allowed. */
11435 int max_byte_count; /**< The maximum number of bytes allowed*/
11438 * Filter inserted text based on user defined character and byte limits
11440 * Add this filter to an entry to limit the characters that it will accept
11441 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11442 * The funtion works on the UTF-8 representation of the string, converting
11443 * it from the set markup, thus not accounting for any format in it.
11445 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11446 * it as data when setting the filter. In it, it's possible to set limits
11447 * by character count or bytes (any of them is disabled if 0), and both can
11448 * be set at the same time. In that case, it first checks for characters,
11451 * The function will cut the inserted text in order to allow only the first
11452 * number of characters that are still allowed. The cut is made in
11453 * characters, even when limiting by bytes, in order to always contain
11454 * valid ones and avoid half unicode characters making it in.
11456 * This filter, like any others, does not apply when setting the entry text
11457 * directly with elm_object_text_set() (or the deprecated
11458 * elm_entry_entry_set()).
11460 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11462 * @typedef Elm_Entry_Filter_Accept_Set
11464 * Data for the elm_entry_filter_accept_set() entry filter.
11466 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11468 * @struct _Elm_Entry_Filter_Accept_Set
11470 * Data for the elm_entry_filter_accept_set() entry filter.
11472 struct _Elm_Entry_Filter_Accept_Set
11474 const char *accepted; /**< Set of characters accepted in the entry. */
11475 const char *rejected; /**< Set of characters rejected from the entry. */
11478 * Filter inserted text based on accepted or rejected sets of characters
11480 * Add this filter to an entry to restrict the set of accepted characters
11481 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11482 * This structure contains both accepted and rejected sets, but they are
11483 * mutually exclusive.
11485 * The @c accepted set takes preference, so if it is set, the filter will
11486 * only work based on the accepted characters, ignoring anything in the
11487 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11489 * In both cases, the function filters by matching utf8 characters to the
11490 * raw markup text, so it can be used to remove formatting tags.
11492 * This filter, like any others, does not apply when setting the entry text
11493 * directly with elm_object_text_set() (or the deprecated
11494 * elm_entry_entry_set()).
11496 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11498 * Set the input panel layout of the entry
11500 * @param obj The entry object
11501 * @param layout layout type
11503 EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
11505 * Get the input panel layout of the entry
11507 * @param obj The entry object
11508 * @return layout type
11510 * @see elm_entry_input_panel_layout_set
11512 EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11514 * Set the autocapitalization type on the immodule.
11516 * @param obj The entry object
11517 * @param autocapital_type The type of autocapitalization
11519 EAPI void elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type) EINA_ARG_NONNULL(1);
11521 * Retrieve the autocapitalization type on the immodule.
11523 * @param obj The entry object
11524 * @return autocapitalization type
11526 EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11528 * Sets the attribute to show the input panel automatically.
11530 * @param obj The entry object
11531 * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
11533 EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
11535 * Retrieve the attribute to show the input panel automatically.
11537 * @param obj The entry object
11538 * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
11540 EAPI Eina_Bool elm_entry_input_panel_enabled_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11542 EAPI void elm_entry_background_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
11543 EAPI void elm_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
11544 EAPI void elm_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
11545 EAPI void elm_entry_autoenable_returnkey_set(Evas_Object *obj, Eina_Bool on);
11546 EAPI Ecore_IMF_Context *elm_entry_imf_context_get(Evas_Object *obj);
11547 EAPI void elm_entry_matchlist_set(Evas_Object *obj, Eina_List *match_list, Eina_Bool case_sensitive);
11548 EAPI void elm_entry_magnifier_type_set(Evas_Object *obj, int type) EINA_ARG_NONNULL(1);
11550 EINA_DEPRECATED EAPI void elm_entry_wrap_width_set(Evas_Object *obj, Evas_Coord w);
11551 EINA_DEPRECATED EAPI Evas_Coord elm_entry_wrap_width_get(const Evas_Object *obj);
11552 EINA_DEPRECATED EAPI void elm_entry_fontsize_set(Evas_Object *obj, int fontsize);
11553 EINA_DEPRECATED EAPI void elm_entry_text_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
11554 EINA_DEPRECATED EAPI void elm_entry_text_align_set(Evas_Object *obj, const char *alignmode);
11562 * @defgroup Anchorview Anchorview
11564 * Anchorview is for displaying text that contains markup with anchors
11565 * like <c>\<a href=1234\>something\</\></c> in it.
11567 * Besides being styled differently, the anchorview widget provides the
11568 * necessary functionality so that clicking on these anchors brings up a
11569 * popup with user defined content such as "call", "add to contacts" or
11570 * "open web page". This popup is provided using the @ref Hover widget.
11572 * This widget is very similar to @ref Anchorblock, so refer to that
11573 * widget for an example. The only difference Anchorview has is that the
11574 * widget is already provided with scrolling functionality, so if the
11575 * text set to it is too large to fit in the given space, it will scroll,
11576 * whereas the @ref Anchorblock widget will keep growing to ensure all the
11577 * text can be displayed.
11579 * This widget emits the following signals:
11580 * @li "anchor,clicked": will be called when an anchor is clicked. The
11581 * @p event_info parameter on the callback will be a pointer of type
11582 * ::Elm_Entry_Anchorview_Info.
11584 * See @ref Anchorblock for an example on how to use both of them.
11593 * @typedef Elm_Entry_Anchorview_Info
11595 * The info sent in the callback for "anchor,clicked" signals emitted by
11596 * the Anchorview widget.
11598 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
11600 * @struct _Elm_Entry_Anchorview_Info
11602 * The info sent in the callback for "anchor,clicked" signals emitted by
11603 * the Anchorview widget.
11605 struct _Elm_Entry_Anchorview_Info
11607 const char *name; /**< Name of the anchor, as indicated in its href
11609 int button; /**< The mouse button used to click on it */
11610 Evas_Object *hover; /**< The hover object to use for the popup */
11612 Evas_Coord x, y, w, h;
11613 } anchor, /**< Geometry selection of text used as anchor */
11614 hover_parent; /**< Geometry of the object used as parent by the
11616 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
11617 for content on the left side of
11618 the hover. Before calling the
11619 callback, the widget will make the
11620 necessary calculations to check
11621 which sides are fit to be set with
11622 content, based on the position the
11623 hover is activated and its distance
11624 to the edges of its parent object
11626 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
11627 the right side of the hover.
11628 See @ref hover_left */
11629 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
11630 of the hover. See @ref hover_left */
11631 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
11632 below the hover. See @ref
11636 * Add a new Anchorview object
11638 * @param parent The parent object
11639 * @return The new object or NULL if it cannot be created
11641 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11643 * Set the text to show in the anchorview
11645 * Sets the text of the anchorview to @p text. This text can include markup
11646 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
11647 * text that will be specially styled and react to click events, ended with
11648 * either of \</a\> or \</\>. When clicked, the anchor will emit an
11649 * "anchor,clicked" signal that you can attach a callback to with
11650 * evas_object_smart_callback_add(). The name of the anchor given in the
11651 * event info struct will be the one set in the href attribute, in this
11652 * case, anchorname.
11654 * Other markup can be used to style the text in different ways, but it's
11655 * up to the style defined in the theme which tags do what.
11656 * @deprecated use elm_object_text_set() instead.
11658 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11660 * Get the markup text set for the anchorview
11662 * Retrieves the text set on the anchorview, with markup tags included.
11664 * @param obj The anchorview object
11665 * @return The markup text set or @c NULL if nothing was set or an error
11667 * @deprecated use elm_object_text_set() instead.
11669 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11671 * Set the parent of the hover popup
11673 * Sets the parent object to use by the hover created by the anchorview
11674 * when an anchor is clicked. See @ref Hover for more details on this.
11675 * If no parent is set, the same anchorview object will be used.
11677 * @param obj The anchorview object
11678 * @param parent The object to use as parent for the hover
11680 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11682 * Get the parent of the hover popup
11684 * Get the object used as parent for the hover created by the anchorview
11685 * widget. See @ref Hover for more details on this.
11687 * @param obj The anchorview object
11688 * @return The object used as parent for the hover, NULL if none is set.
11690 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11692 * Set the style that the hover should use
11694 * When creating the popup hover, anchorview will request that it's
11695 * themed according to @p style.
11697 * @param obj The anchorview object
11698 * @param style The style to use for the underlying hover
11700 * @see elm_object_style_set()
11702 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11704 * Get the style that the hover should use
11706 * Get the style the hover created by anchorview will use.
11708 * @param obj The anchorview object
11709 * @return The style to use by the hover. NULL means the default is used.
11711 * @see elm_object_style_set()
11713 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11715 * Ends the hover popup in the anchorview
11717 * When an anchor is clicked, the anchorview widget will create a hover
11718 * object to use as a popup with user provided content. This function
11719 * terminates this popup, returning the anchorview to its normal state.
11721 * @param obj The anchorview object
11723 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11725 * Set bouncing behaviour when the scrolled content reaches an edge
11727 * Tell the internal scroller object whether it should bounce or not
11728 * when it reaches the respective edges for each axis.
11730 * @param obj The anchorview object
11731 * @param h_bounce Whether to bounce or not in the horizontal axis
11732 * @param v_bounce Whether to bounce or not in the vertical axis
11734 * @see elm_scroller_bounce_set()
11736 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
11738 * Get the set bouncing behaviour of the internal scroller
11740 * Get whether the internal scroller should bounce when the edge of each
11741 * axis is reached scrolling.
11743 * @param obj The anchorview object
11744 * @param h_bounce Pointer where to store the bounce state of the horizontal
11746 * @param v_bounce Pointer where to store the bounce state of the vertical
11749 * @see elm_scroller_bounce_get()
11751 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
11753 * Appends a custom item provider to the given anchorview
11755 * Appends the given function to the list of items providers. This list is
11756 * called, one function at a time, with the given @p data pointer, the
11757 * anchorview object and, in the @p item parameter, the item name as
11758 * referenced in its href string. Following functions in the list will be
11759 * called in order until one of them returns something different to NULL,
11760 * which should be an Evas_Object which will be used in place of the item
11763 * Items in the markup text take the form \<item relsize=16x16 vsize=full
11764 * href=item/name\>\</item\>
11766 * @param obj The anchorview object
11767 * @param func The function to add to the list of providers
11768 * @param data User data that will be passed to the callback function
11770 * @see elm_entry_item_provider_append()
11772 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);
11774 * Prepend a custom item provider to the given anchorview
11776 * Like elm_anchorview_item_provider_append(), but it adds the function
11777 * @p func to the beginning of the list, instead of the end.
11779 * @param obj The anchorview object
11780 * @param func The function to add to the list of providers
11781 * @param data User data that will be passed to the callback function
11783 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);
11785 * Remove a custom item provider from the list of the given anchorview
11787 * Removes the function and data pairing that matches @p func and @p data.
11788 * That is, unless the same function and same user data are given, the
11789 * function will not be removed from the list. This allows us to add the
11790 * same callback several times, with different @p data pointers and be
11791 * able to remove them later without conflicts.
11793 * @param obj The anchorview object
11794 * @param func The function to remove from the list
11795 * @param data The data matching the function to remove from the list
11797 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);
11804 * @defgroup Anchorblock Anchorblock
11806 * @image html img/widget/anchorblock/preview-00.png
11807 * @image latex img/widget/anchorblock/preview-00.eps
11809 * Anchorblock is for displaying text that contains markup with anchors
11810 * like <c>\<a href=1234\>something\</\></c> in it.
11812 * Besides being styled differently, the anchorblock widget provides the
11813 * necessary functionality so that clicking on these anchors brings up a
11814 * popup with user defined content such as "call", "add to contacts" or
11815 * "open web page". This popup is provided using the @ref Hover widget.
11817 * This widget emits the following signals:
11818 * @li "anchor,clicked": will be called when an anchor is clicked. The
11819 * @p event_info parameter on the callback will be a pointer of type
11820 * ::Elm_Entry_Anchorblock_Info.
11826 * Since examples are usually better than plain words, we might as well
11827 * try @ref tutorial_anchorblock_example "one".
11830 * @addtogroup Anchorblock
11834 * @typedef Elm_Entry_Anchorblock_Info
11836 * The info sent in the callback for "anchor,clicked" signals emitted by
11837 * the Anchorblock widget.
11839 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
11841 * @struct _Elm_Entry_Anchorblock_Info
11843 * The info sent in the callback for "anchor,clicked" signals emitted by
11844 * the Anchorblock widget.
11846 struct _Elm_Entry_Anchorblock_Info
11848 const char *name; /**< Name of the anchor, as indicated in its href
11850 int button; /**< The mouse button used to click on it */
11851 Evas_Object *hover; /**< The hover object to use for the popup */
11853 Evas_Coord x, y, w, h;
11854 } anchor, /**< Geometry selection of text used as anchor */
11855 hover_parent; /**< Geometry of the object used as parent by the
11857 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
11858 for content on the left side of
11859 the hover. Before calling the
11860 callback, the widget will make the
11861 necessary calculations to check
11862 which sides are fit to be set with
11863 content, based on the position the
11864 hover is activated and its distance
11865 to the edges of its parent object
11867 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
11868 the right side of the hover.
11869 See @ref hover_left */
11870 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
11871 of the hover. See @ref hover_left */
11872 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
11873 below the hover. See @ref
11877 * Add a new Anchorblock object
11879 * @param parent The parent object
11880 * @return The new object or NULL if it cannot be created
11882 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11884 * Set the text to show in the anchorblock
11886 * Sets the text of the anchorblock to @p text. This text can include markup
11887 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
11888 * of text that will be specially styled and react to click events, ended
11889 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
11890 * "anchor,clicked" signal that you can attach a callback to with
11891 * evas_object_smart_callback_add(). The name of the anchor given in the
11892 * event info struct will be the one set in the href attribute, in this
11893 * case, anchorname.
11895 * Other markup can be used to style the text in different ways, but it's
11896 * up to the style defined in the theme which tags do what.
11897 * @deprecated use elm_object_text_set() instead.
11899 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11901 * Get the markup text set for the anchorblock
11903 * Retrieves the text set on the anchorblock, with markup tags included.
11905 * @param obj The anchorblock object
11906 * @return The markup text set or @c NULL if nothing was set or an error
11908 * @deprecated use elm_object_text_set() instead.
11910 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11912 * Set the parent of the hover popup
11914 * Sets the parent object to use by the hover created by the anchorblock
11915 * when an anchor is clicked. See @ref Hover for more details on this.
11917 * @param obj The anchorblock object
11918 * @param parent The object to use as parent for the hover
11920 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11922 * Get the parent of the hover popup
11924 * Get the object used as parent for the hover created by the anchorblock
11925 * widget. See @ref Hover for more details on this.
11926 * If no parent is set, the same anchorblock object will be used.
11928 * @param obj The anchorblock object
11929 * @return The object used as parent for the hover, NULL if none is set.
11931 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11933 * Set the style that the hover should use
11935 * When creating the popup hover, anchorblock will request that it's
11936 * themed according to @p style.
11938 * @param obj The anchorblock object
11939 * @param style The style to use for the underlying hover
11941 * @see elm_object_style_set()
11943 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11945 * Get the style that the hover should use
11947 * Get the style, the hover created by anchorblock will use.
11949 * @param obj The anchorblock object
11950 * @return The style to use by the hover. NULL means the default is used.
11952 * @see elm_object_style_set()
11954 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11956 * Ends the hover popup in the anchorblock
11958 * When an anchor is clicked, the anchorblock widget will create a hover
11959 * object to use as a popup with user provided content. This function
11960 * terminates this popup, returning the anchorblock to its normal state.
11962 * @param obj The anchorblock object
11964 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11966 * Appends a custom item provider to the given anchorblock
11968 * Appends the given function to the list of items providers. This list is
11969 * called, one function at a time, with the given @p data pointer, the
11970 * anchorblock object and, in the @p item parameter, the item name as
11971 * referenced in its href string. Following functions in the list will be
11972 * called in order until one of them returns something different to NULL,
11973 * which should be an Evas_Object which will be used in place of the item
11976 * Items in the markup text take the form \<item relsize=16x16 vsize=full
11977 * href=item/name\>\</item\>
11979 * @param obj The anchorblock object
11980 * @param func The function to add to the list of providers
11981 * @param data User data that will be passed to the callback function
11983 * @see elm_entry_item_provider_append()
11985 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);
11987 * Prepend a custom item provider to the given anchorblock
11989 * Like elm_anchorblock_item_provider_append(), but it adds the function
11990 * @p func to the beginning of the list, instead of the end.
11992 * @param obj The anchorblock object
11993 * @param func The function to add to the list of providers
11994 * @param data User data that will be passed to the callback function
11996 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);
11998 * Remove a custom item provider from the list of the given anchorblock
12000 * Removes the function and data pairing that matches @p func and @p data.
12001 * That is, unless the same function and same user data are given, the
12002 * function will not be removed from the list. This allows us to add the
12003 * same callback several times, with different @p data pointers and be
12004 * able to remove them later without conflicts.
12006 * @param obj The anchorblock object
12007 * @param func The function to remove from the list
12008 * @param data The data matching the function to remove from the list
12010 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);
12016 * @defgroup Bubble Bubble
12018 * @image html img/widget/bubble/preview-00.png
12019 * @image latex img/widget/bubble/preview-00.eps
12020 * @image html img/widget/bubble/preview-01.png
12021 * @image latex img/widget/bubble/preview-01.eps
12022 * @image html img/widget/bubble/preview-02.png
12023 * @image latex img/widget/bubble/preview-02.eps
12025 * @brief The Bubble is a widget to show text similar to how speech is
12026 * represented in comics.
12028 * The bubble widget contains 5 important visual elements:
12029 * @li The frame is a rectangle with rounded edjes and an "arrow".
12030 * @li The @p icon is an image to which the frame's arrow points to.
12031 * @li The @p label is a text which appears to the right of the icon if the
12032 * corner is "top_left" or "bottom_left" and is right aligned to the frame
12034 * @li The @p info is a text which appears to the right of the label. Info's
12035 * font is of a ligther color than label.
12036 * @li The @p content is an evas object that is shown inside the frame.
12038 * The position of the arrow, icon, label and info depends on which corner is
12039 * selected. The four available corners are:
12040 * @li "top_left" - Default
12042 * @li "bottom_left"
12043 * @li "bottom_right"
12045 * Signals that you can add callbacks for are:
12046 * @li "clicked" - This is called when a user has clicked the bubble.
12048 * For an example of using a buble see @ref bubble_01_example_page "this".
12053 * Add a new bubble to the parent
12055 * @param parent The parent object
12056 * @return The new object or NULL if it cannot be created
12058 * This function adds a text bubble to the given parent evas object.
12060 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12062 * Set the label of the bubble
12064 * @param obj The bubble object
12065 * @param label The string to set in the label
12067 * This function sets the title of the bubble. Where this appears depends on
12068 * the selected corner.
12069 * @deprecated use elm_object_text_set() instead.
12071 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12073 * Get the label of the bubble
12075 * @param obj The bubble object
12076 * @return The string of set in the label
12078 * This function gets the title of the bubble.
12079 * @deprecated use elm_object_text_get() instead.
12081 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12083 * Set the info of the bubble
12085 * @param obj The bubble object
12086 * @param info The given info about the bubble
12088 * This function sets the info of the bubble. Where this appears depends on
12089 * the selected corner.
12090 * @deprecated use elm_object_text_part_set() instead. (with "info" as the parameter).
12092 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
12094 * Get the info of the bubble
12096 * @param obj The bubble object
12098 * @return The "info" string of the bubble
12100 * This function gets the info text.
12101 * @deprecated use elm_object_text_part_get() instead. (with "info" as the parameter).
12103 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12105 * Set the content to be shown in the bubble
12107 * Once the content object is set, a previously set one will be deleted.
12108 * If you want to keep the old content object, use the
12109 * elm_bubble_content_unset() function.
12111 * @param obj The bubble object
12112 * @param content The given content of the bubble
12114 * This function sets the content shown on the middle of the bubble.
12116 EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12118 * Get the content shown in the bubble
12120 * Return the content object which is set for this widget.
12122 * @param obj The bubble object
12123 * @return The content that is being used
12125 EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12127 * Unset the content shown in the bubble
12129 * Unparent and return the content object which was set for this widget.
12131 * @param obj The bubble object
12132 * @return The content that was being used
12134 EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12136 * Set the icon of the bubble
12138 * Once the icon object is set, a previously set one will be deleted.
12139 * If you want to keep the old content object, use the
12140 * elm_icon_content_unset() function.
12142 * @param obj The bubble object
12143 * @param icon The given icon for the bubble
12145 EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12147 * Get the icon of the bubble
12149 * @param obj The bubble object
12150 * @return The icon for the bubble
12152 * This function gets the icon shown on the top left of bubble.
12154 EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12156 * Unset the icon of the bubble
12158 * Unparent and return the icon object which was set for this widget.
12160 * @param obj The bubble object
12161 * @return The icon that was being used
12163 EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12165 * Set the corner of the bubble
12167 * @param obj The bubble object.
12168 * @param corner The given corner for the bubble.
12170 * This function sets the corner of the bubble. The corner will be used to
12171 * determine where the arrow in the frame points to and where label, icon and
12174 * Possible values for corner are:
12175 * @li "top_left" - Default
12177 * @li "bottom_left"
12178 * @li "bottom_right"
12180 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
12182 * Get the corner of the bubble
12184 * @param obj The bubble object.
12185 * @return The given corner for the bubble.
12187 * This function gets the selected corner of the bubble.
12189 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12191 EINA_DEPRECATED EAPI void elm_bubble_sweep_layout_set(Evas_Object *obj, Evas_Object *sweep) EINA_ARG_NONNULL(1);
12192 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_sweep_layout_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12199 * @defgroup Photo Photo
12201 * For displaying the photo of a person (contact). Simple, yet
12202 * with a very specific purpose.
12204 * Signals that you can add callbacks for are:
12206 * "clicked" - This is called when a user has clicked the photo
12207 * "drag,start" - Someone started dragging the image out of the object
12208 * "drag,end" - Dragged item was dropped (somewhere)
12214 * Add a new photo to the parent
12216 * @param parent The parent object
12217 * @return The new object or NULL if it cannot be created
12221 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12224 * Set the file that will be used as photo
12226 * @param obj The photo object
12227 * @param file The path to file that will be used as photo
12229 * @return (1 = success, 0 = error)
12233 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12236 * Set the size that will be used on the photo
12238 * @param obj The photo object
12239 * @param size The size that the photo will be
12243 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12246 * Set if the photo should be completely visible or not.
12248 * @param obj The photo object
12249 * @param fill if true the photo will be completely visible
12253 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12256 * Set editability of the photo.
12258 * An editable photo can be dragged to or from, and can be cut or
12259 * pasted too. Note that pasting an image or dropping an item on
12260 * the image will delete the existing content.
12262 * @param obj The photo object.
12263 * @param set To set of clear editablity.
12265 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12271 /* gesture layer */
12273 * @defgroup Elm_Gesture_Layer Gesture Layer
12274 * Gesture Layer Usage:
12276 * Use Gesture Layer to detect gestures.
12277 * The advantage is that you don't have to implement
12278 * gesture detection, just set callbacks of gesture state.
12279 * By using gesture layer we make standard interface.
12281 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12282 * with a parent object parameter.
12283 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12284 * call. Usually with same object as target (2nd parameter).
12286 * Now you need to tell gesture layer what gestures you follow.
12287 * This is done with @ref elm_gesture_layer_cb_set call.
12288 * By setting the callback you actually saying to gesture layer:
12289 * I would like to know when the gesture @ref Elm_Gesture_Types
12290 * switches to state @ref Elm_Gesture_State.
12292 * Next, you need to implement the actual action that follows the input
12293 * in your callback.
12295 * Note that if you like to stop being reported about a gesture, just set
12296 * all callbacks referring this gesture to NULL.
12297 * (again with @ref elm_gesture_layer_cb_set)
12299 * The information reported by gesture layer to your callback is depending
12300 * on @ref Elm_Gesture_Types:
12301 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12302 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12303 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12305 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12306 * @ref ELM_GESTURE_MOMENTUM.
12308 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12309 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12310 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12311 * Note that we consider a flick as a line-gesture that should be completed
12312 * in flick-time-limit as defined in @ref Config.
12314 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12316 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12319 * Gesture Layer Tweaks:
12321 * Note that line, flick, gestures can start without the need to remove fingers from surface.
12322 * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
12324 * Setting glayer_continues_enable to false in @ref Config will change this behavior
12325 * so gesture starts when user touches (a *DOWN event) touch-surface
12326 * and ends when no fingers touches surface (a *UP event).
12330 * @enum _Elm_Gesture_Types
12331 * Enum of supported gesture types.
12332 * @ingroup Elm_Gesture_Layer
12334 enum _Elm_Gesture_Types
12336 ELM_GESTURE_FIRST = 0,
12338 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12339 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12340 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12341 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12343 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12345 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12346 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12348 ELM_GESTURE_ZOOM, /**< Zoom */
12349 ELM_GESTURE_ROTATE, /**< Rotate */
12355 * @typedef Elm_Gesture_Types
12356 * gesture types enum
12357 * @ingroup Elm_Gesture_Layer
12359 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12362 * @enum _Elm_Gesture_State
12363 * Enum of gesture states.
12364 * @ingroup Elm_Gesture_Layer
12366 enum _Elm_Gesture_State
12368 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12369 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
12370 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
12371 ELM_GESTURE_STATE_END, /**< Gesture completed */
12372 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
12376 * @typedef Elm_Gesture_State
12377 * gesture states enum
12378 * @ingroup Elm_Gesture_Layer
12380 typedef enum _Elm_Gesture_State Elm_Gesture_State;
12383 * @struct _Elm_Gesture_Taps_Info
12384 * Struct holds taps info for user
12385 * @ingroup Elm_Gesture_Layer
12387 struct _Elm_Gesture_Taps_Info
12389 Evas_Coord x, y; /**< Holds center point between fingers */
12390 unsigned int n; /**< Number of fingers tapped */
12391 unsigned int timestamp; /**< event timestamp */
12395 * @typedef Elm_Gesture_Taps_Info
12396 * holds taps info for user
12397 * @ingroup Elm_Gesture_Layer
12399 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12402 * @struct _Elm_Gesture_Momentum_Info
12403 * Struct holds momentum info for user
12404 * x1 and y1 are not necessarily in sync
12405 * x1 holds x value of x direction starting point
12406 * and same holds for y1.
12407 * This is noticeable when doing V-shape movement
12408 * @ingroup Elm_Gesture_Layer
12410 struct _Elm_Gesture_Momentum_Info
12411 { /* Report line ends, timestamps, and momentum computed */
12412 Evas_Coord x1; /**< Final-swipe direction starting point on X */
12413 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12414 Evas_Coord x2; /**< Final-swipe direction ending point on X */
12415 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
12417 unsigned int tx; /**< Timestamp of start of final x-swipe */
12418 unsigned int ty; /**< Timestamp of start of final y-swipe */
12420 Evas_Coord mx; /**< Momentum on X */
12421 Evas_Coord my; /**< Momentum on Y */
12423 unsigned int n; /**< Number of fingers */
12427 * @typedef Elm_Gesture_Momentum_Info
12428 * holds momentum info for user
12429 * @ingroup Elm_Gesture_Layer
12431 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12434 * @struct _Elm_Gesture_Line_Info
12435 * Struct holds line info for user
12436 * @ingroup Elm_Gesture_Layer
12438 struct _Elm_Gesture_Line_Info
12439 { /* Report line ends, timestamps, and momentum computed */
12440 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12441 /* FIXME should be radians, bot degrees */
12442 double angle; /**< Angle (direction) of lines */
12446 * @typedef Elm_Gesture_Line_Info
12447 * Holds line info for user
12448 * @ingroup Elm_Gesture_Layer
12450 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12453 * @struct _Elm_Gesture_Zoom_Info
12454 * Struct holds zoom info for user
12455 * @ingroup Elm_Gesture_Layer
12457 struct _Elm_Gesture_Zoom_Info
12459 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12460 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12461 double zoom; /**< Zoom value: 1.0 means no zoom */
12462 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12466 * @typedef Elm_Gesture_Zoom_Info
12467 * Holds zoom info for user
12468 * @ingroup Elm_Gesture_Layer
12470 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12473 * @struct _Elm_Gesture_Rotate_Info
12474 * Struct holds rotation info for user
12475 * @ingroup Elm_Gesture_Layer
12477 struct _Elm_Gesture_Rotate_Info
12479 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12480 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12481 double base_angle; /**< Holds start-angle */
12482 double angle; /**< Rotation value: 0.0 means no rotation */
12483 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12487 * @typedef Elm_Gesture_Rotate_Info
12488 * Holds rotation info for user
12489 * @ingroup Elm_Gesture_Layer
12491 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12494 * @typedef Elm_Gesture_Event_Cb
12495 * User callback used to stream gesture info from gesture layer
12496 * @param data user data
12497 * @param event_info gesture report info
12498 * Returns a flag field to be applied on the causing event.
12499 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12500 * upon the event, in an irreversible way.
12502 * @ingroup Elm_Gesture_Layer
12504 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12507 * Use function to set callbacks to be notified about
12508 * change of state of gesture.
12509 * When a user registers a callback with this function
12510 * this means this gesture has to be tested.
12512 * When ALL callbacks for a gesture are set to NULL
12513 * it means user isn't interested in gesture-state
12514 * and it will not be tested.
12516 * @param obj Pointer to gesture-layer.
12517 * @param idx The gesture you would like to track its state.
12518 * @param cb callback function pointer.
12519 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
12520 * @param data user info to be sent to callback (usually, Smart Data)
12522 * @ingroup Elm_Gesture_Layer
12524 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);
12527 * Call this function to get repeat-events settings.
12529 * @param obj Pointer to gesture-layer.
12531 * @return repeat events settings.
12532 * @see elm_gesture_layer_hold_events_set()
12533 * @ingroup Elm_Gesture_Layer
12535 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12538 * This function called in order to make gesture-layer repeat events.
12539 * Set this of you like to get the raw events only if gestures were not detected.
12540 * Clear this if you like gesture layer to fwd events as testing gestures.
12542 * @param obj Pointer to gesture-layer.
12543 * @param r Repeat: TRUE/FALSE
12545 * @ingroup Elm_Gesture_Layer
12547 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
12550 * This function sets step-value for zoom action.
12551 * Set step to any positive value.
12552 * Cancel step setting by setting to 0.0
12554 * @param obj Pointer to gesture-layer.
12555 * @param s new zoom step value.
12557 * @ingroup Elm_Gesture_Layer
12559 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12562 * This function sets step-value for rotate action.
12563 * Set step to any positive value.
12564 * Cancel step setting by setting to 0.0
12566 * @param obj Pointer to gesture-layer.
12567 * @param s new roatate step value.
12569 * @ingroup Elm_Gesture_Layer
12571 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12574 * This function called to attach gesture-layer to an Evas_Object.
12575 * @param obj Pointer to gesture-layer.
12576 * @param t Pointer to underlying object (AKA Target)
12578 * @return TRUE, FALSE on success, failure.
12580 * @ingroup Elm_Gesture_Layer
12582 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
12585 * Call this function to construct a new gesture-layer object.
12586 * This does not activate the gesture layer. You have to
12587 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
12589 * @param parent the parent object.
12591 * @return Pointer to new gesture-layer object.
12593 * @ingroup Elm_Gesture_Layer
12595 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12598 * @defgroup Thumb Thumb
12600 * @image html img/widget/thumb/preview-00.png
12601 * @image latex img/widget/thumb/preview-00.eps
12603 * A thumb object is used for displaying the thumbnail of an image or video.
12604 * You must have compiled Elementary with Ethumb_Client support and the DBus
12605 * service must be present and auto-activated in order to have thumbnails to
12608 * Once the thumbnail object becomes visible, it will check if there is a
12609 * previously generated thumbnail image for the file set on it. If not, it
12610 * will start generating this thumbnail.
12612 * Different config settings will cause different thumbnails to be generated
12613 * even on the same file.
12615 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
12616 * Ethumb documentation to change this path, and to see other configuration
12619 * Signals that you can add callbacks for are:
12621 * - "clicked" - This is called when a user has clicked the thumb without dragging
12623 * - "clicked,double" - This is called when a user has double-clicked the thumb.
12624 * - "press" - This is called when a user has pressed down the thumb.
12625 * - "generate,start" - The thumbnail generation started.
12626 * - "generate,stop" - The generation process stopped.
12627 * - "generate,error" - The generation failed.
12628 * - "load,error" - The thumbnail image loading failed.
12630 * available styles:
12634 * An example of use of thumbnail:
12636 * - @ref thumb_example_01
12640 * @addtogroup Thumb
12645 * @enum _Elm_Thumb_Animation_Setting
12646 * @typedef Elm_Thumb_Animation_Setting
12648 * Used to set if a video thumbnail is animating or not.
12652 typedef enum _Elm_Thumb_Animation_Setting
12654 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
12655 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
12656 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
12657 ELM_THUMB_ANIMATION_LAST
12658 } Elm_Thumb_Animation_Setting;
12661 * Add a new thumb object to the parent.
12663 * @param parent The parent object.
12664 * @return The new object or NULL if it cannot be created.
12666 * @see elm_thumb_file_set()
12667 * @see elm_thumb_ethumb_client_get()
12671 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12673 * Reload thumbnail if it was generated before.
12675 * @param obj The thumb object to reload
12677 * This is useful if the ethumb client configuration changed, like its
12678 * size, aspect or any other property one set in the handle returned
12679 * by elm_thumb_ethumb_client_get().
12681 * If the options didn't change, the thumbnail won't be generated again, but
12682 * the old one will still be used.
12684 * @see elm_thumb_file_set()
12688 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
12690 * Set the file that will be used as thumbnail.
12692 * @param obj The thumb object.
12693 * @param file The path to file that will be used as thumb.
12694 * @param key The key used in case of an EET file.
12696 * The file can be an image or a video (in that case, acceptable extensions are:
12697 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
12698 * function elm_thumb_animate().
12700 * @see elm_thumb_file_get()
12701 * @see elm_thumb_reload()
12702 * @see elm_thumb_animate()
12706 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
12708 * Get the image or video path and key used to generate the thumbnail.
12710 * @param obj The thumb object.
12711 * @param file Pointer to filename.
12712 * @param key Pointer to key.
12714 * @see elm_thumb_file_set()
12715 * @see elm_thumb_path_get()
12719 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12721 * Get the path and key to the image or video generated by ethumb.
12723 * One just need to make sure that the thumbnail was generated before getting
12724 * its path; otherwise, the path will be NULL. One way to do that is by asking
12725 * for the path when/after the "generate,stop" smart callback is called.
12727 * @param obj The thumb object.
12728 * @param file Pointer to thumb path.
12729 * @param key Pointer to thumb key.
12731 * @see elm_thumb_file_get()
12735 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12737 * Set the animation state for the thumb object. If its content is an animated
12738 * video, you may start/stop the animation or tell it to play continuously and
12741 * @param obj The thumb object.
12742 * @param setting The animation setting.
12744 * @see elm_thumb_file_set()
12748 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
12750 * Get the animation state for the thumb object.
12752 * @param obj The thumb object.
12753 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
12756 * @see elm_thumb_animate_set()
12760 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12762 * Get the ethumb_client handle so custom configuration can be made.
12764 * @return Ethumb_Client instance or NULL.
12766 * This must be called before the objects are created to be sure no object is
12767 * visible and no generation started.
12769 * Example of usage:
12772 * #include <Elementary.h>
12773 * #ifndef ELM_LIB_QUICKLAUNCH
12775 * elm_main(int argc, char **argv)
12777 * Ethumb_Client *client;
12779 * elm_need_ethumb();
12783 * client = elm_thumb_ethumb_client_get();
12786 * ERR("could not get ethumb_client");
12789 * ethumb_client_size_set(client, 100, 100);
12790 * ethumb_client_crop_align_set(client, 0.5, 0.5);
12793 * // Create elm_thumb objects here
12803 * @note There's only one client handle for Ethumb, so once a configuration
12804 * change is done to it, any other request for thumbnails (for any thumbnail
12805 * object) will use that configuration. Thus, this configuration is global.
12809 EAPI void *elm_thumb_ethumb_client_get(void);
12811 * Get the ethumb_client connection state.
12813 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
12816 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
12818 * Make the thumbnail 'editable'.
12820 * @param obj Thumb object.
12821 * @param set Turn on or off editability. Default is @c EINA_FALSE.
12823 * This means the thumbnail is a valid drag target for drag and drop, and can be
12824 * cut or pasted too.
12826 * @see elm_thumb_editable_get()
12830 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
12831 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12833 * Make the thumbnail 'editable'.
12835 * @param obj Thumb object.
12836 * @return Editability.
12838 * This means the thumbnail is a valid drag target for drag and drop, and can be
12839 * cut or pasted too.
12841 * @see elm_thumb_editable_set()
12845 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12853 * @defgroup Web Web
12855 * @image html img/widget/web/preview-00.png
12856 * @image latex img/widget/web/preview-00.eps
12858 * A web object is used for displaying web pages (HTML/CSS/JS)
12859 * using WebKit-EFL. You must have compiled Elementary with
12862 * Signals that you can add callbacks for are:
12863 * @li "download,request": A file download has been requested. Event info is
12864 * a pointer to a Elm_Web_Download
12865 * @li "editorclient,contents,changed": Editor client's contents changed
12866 * @li "editorclient,selection,changed": Editor client's selection changed
12867 * @li "frame,created": A new frame was created. Event info is an
12868 * Evas_Object which can be handled with WebKit's ewk_frame API
12869 * @li "icon,received": An icon was received by the main frame
12870 * @li "inputmethod,changed": Input method changed. Event info is an
12871 * Eina_Bool indicating whether it's enabled or not
12872 * @li "js,windowobject,clear": JS window object has been cleared
12873 * @li "link,hover,in": Mouse cursor is hovering over a link. Event info
12874 * is a char *link[2], where the first string contains the URL the link
12875 * points to, and the second one the title of the link
12876 * @li "link,hover,out": Mouse cursor left the link
12877 * @li "load,document,finished": Loading of a document finished. Event info
12878 * is the frame that finished loading
12879 * @li "load,error": Load failed. Event info is a pointer to
12880 * Elm_Web_Frame_Load_Error
12881 * @li "load,finished": Load finished. Event info is NULL on success, on
12882 * error it's a pointer to Elm_Web_Frame_Load_Error
12883 * @li "load,newwindow,show": A new window was created and is ready to be
12885 * @li "load,progress": Overall load progress. Event info is a pointer to
12886 * a double containing a value between 0.0 and 1.0
12887 * @li "load,provisional": Started provisional load
12888 * @li "load,started": Loading of a document started
12889 * @li "menubar,visible,get": Queries if the menubar is visible. Event info
12890 * is a pointer to Eina_Bool where the callback should set EINA_TRUE if
12891 * the menubar is visible, or EINA_FALSE in case it's not
12892 * @li "menubar,visible,set": Informs menubar visibility. Event info is
12893 * an Eina_Bool indicating the visibility
12894 * @li "popup,created": A dropdown widget was activated, requesting its
12895 * popup menu to be created. Event info is a pointer to Elm_Web_Menu
12896 * @li "popup,willdelete": The web object is ready to destroy the popup
12897 * object created. Event info is a pointer to Elm_Web_Menu
12898 * @li "ready": Page is fully loaded
12899 * @li "scrollbars,visible,get": Queries visibility of scrollbars. Event
12900 * info is a pointer to Eina_Bool where the visibility state should be set
12901 * @li "scrollbars,visible,set": Informs scrollbars visibility. Event info
12902 * is an Eina_Bool with the visibility state set
12903 * @li "statusbar,text,set": Text of the statusbar changed. Even info is
12904 * a string with the new text
12905 * @li "statusbar,visible,get": Queries visibility of the status bar.
12906 * Event info is a pointer to Eina_Bool where the visibility state should be
12908 * @li "statusbar,visible,set": Informs statusbar visibility. Event info is
12909 * an Eina_Bool with the visibility value
12910 * @li "title,changed": Title of the main frame changed. Event info is a
12911 * string with the new title
12912 * @li "toolbars,visible,get": Queries visibility of toolbars. Event info
12913 * is a pointer to Eina_Bool where the visibility state should be set
12914 * @li "toolbars,visible,set": Informs the visibility of toolbars. Event
12915 * info is an Eina_Bool with the visibility state
12916 * @li "tooltip,text,set": Show and set text of a tooltip. Event info is
12917 * a string with the text to show
12918 * @li "uri,changed": URI of the main frame changed. Event info is a string
12920 * @li "view,resized": The web object internal's view changed sized
12921 * @li "windows,close,request": A JavaScript request to close the current
12922 * window was requested
12923 * @li "zoom,animated,end": Animated zoom finished
12925 * available styles:
12928 * An example of use of web:
12930 * - @ref web_example_01 TBD
12939 * Structure used to report load errors.
12941 * Load errors are reported as signal by elm_web. All the strings are
12942 * temporary references and should @b not be used after the signal
12943 * callback returns. If it's required, make copies with strdup() or
12944 * eina_stringshare_add() (they are not even guaranteed to be
12945 * stringshared, so must use eina_stringshare_add() and not
12946 * eina_stringshare_ref()).
12948 typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
12950 * Structure used to report load errors.
12952 * Load errors are reported as signal by elm_web. All the strings are
12953 * temporary references and should @b not be used after the signal
12954 * callback returns. If it's required, make copies with strdup() or
12955 * eina_stringshare_add() (they are not even guaranteed to be
12956 * stringshared, so must use eina_stringshare_add() and not
12957 * eina_stringshare_ref()).
12959 struct _Elm_Web_Frame_Load_Error
12961 int code; /**< Numeric error code */
12962 Eina_Bool is_cancellation; /**< Error produced by cancelling a request */
12963 const char *domain; /**< Error domain name */
12964 const char *description; /**< Error description (already localized) */
12965 const char *failing_url; /**< The URL that failed to load */
12966 Evas_Object *frame; /**< Frame object that produced the error */
12970 * The possibles types that the items in a menu can be
12972 typedef enum _Elm_Web_Menu_Item_Type
12974 ELM_WEB_MENU_SEPARATOR,
12975 ELM_WEB_MENU_GROUP,
12976 ELM_WEB_MENU_OPTION
12977 } Elm_Web_Menu_Item_Type;
12980 * Structure describing the items in a menu
12982 typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item;
12984 * Structure describing the items in a menu
12986 struct _Elm_Web_Menu_Item
12988 const char *text; /**< The text for the item */
12989 Elm_Web_Menu_Item_Type type; /**< The type of the item */
12993 * Structure describing the menu of a popup
12995 * This structure will be passed as the @c event_info for the "popup,create"
12996 * signal, which is emitted when a dropdown menu is opened. Users wanting
12997 * to handle these popups by themselves should listen to this signal and
12998 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
12999 * property as @c EINA_FALSE means that the user will not handle the popup
13000 * and the default implementation will be used.
13002 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13003 * will be emitted to notify the user that it can destroy any objects and
13004 * free all data related to it.
13006 * @see elm_web_popup_selected_set()
13007 * @see elm_web_popup_destroy()
13009 typedef struct _Elm_Web_Menu Elm_Web_Menu;
13011 * Structure describing the menu of a popup
13013 * This structure will be passed as the @c event_info for the "popup,create"
13014 * signal, which is emitted when a dropdown menu is opened. Users wanting
13015 * to handle these popups by themselves should listen to this signal and
13016 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13017 * property as @c EINA_FALSE means that the user will not handle the popup
13018 * and the default implementation will be used.
13020 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13021 * will be emitted to notify the user that it can destroy any objects and
13022 * free all data related to it.
13024 * @see elm_web_popup_selected_set()
13025 * @see elm_web_popup_destroy()
13027 struct _Elm_Web_Menu
13029 Eina_List *items; /**< List of #Elm_Web_Menu_Item */
13030 int x; /**< The X position of the popup, relative to the elm_web object */
13031 int y; /**< The Y position of the popup, relative to the elm_web object */
13032 int width; /**< Width of the popup menu */
13033 int height; /**< Height of the popup menu */
13035 Eina_Bool handled : 1; /**< Set to @c EINA_TRUE by the user to indicate that the popup has been handled and the default implementation should be ignored. Leave as @c EINA_FALSE otherwise. */
13038 typedef struct _Elm_Web_Download Elm_Web_Download;
13039 struct _Elm_Web_Download
13045 * Types of zoom available.
13047 typedef enum _Elm_Web_Zoom_Mode
13049 ELM_WEB_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_web_zoom_set */
13050 ELM_WEB_ZOOM_MODE_AUTO_FIT, /**< Zoom until content fits in web object */
13051 ELM_WEB_ZOOM_MODE_AUTO_FILL, /**< Zoom until content fills web object */
13052 ELM_WEB_ZOOM_MODE_LAST
13053 } Elm_Web_Zoom_Mode;
13055 * Opaque handler containing the features (such as statusbar, menubar, etc)
13056 * that are to be set on a newly requested window.
13058 typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
13060 * Callback type for the create_window hook.
13062 * The function parameters are:
13063 * @li @p data User data pointer set when setting the hook function
13064 * @li @p obj The elm_web object requesting the new window
13065 * @li @p js Set to @c EINA_TRUE if the request was originated from
13066 * JavaScript. @c EINA_FALSE otherwise.
13067 * @li @p window_features A pointer of #Elm_Web_Window_Features indicating
13068 * the features requested for the new window.
13070 * The returned value of the function should be the @c elm_web widget where
13071 * the request will be loaded. That is, if a new window or tab is created,
13072 * the elm_web widget in it should be returned, and @b NOT the window
13074 * Returning @c NULL should cancel the request.
13076 * @see elm_web_window_create_hook_set()
13078 typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
13080 * Callback type for the JS alert hook.
13082 * The function parameters are:
13083 * @li @p data User data pointer set when setting the hook function
13084 * @li @p obj The elm_web object requesting the new window
13085 * @li @p message The message to show in the alert dialog
13087 * The function should return the object representing the alert dialog.
13088 * Elm_Web will run a second main loop to handle the dialog and normal
13089 * flow of the application will be restored when the object is deleted, so
13090 * the user should handle the popup properly in order to delete the object
13091 * when the action is finished.
13092 * If the function returns @c NULL the popup will be ignored.
13094 * @see elm_web_dialog_alert_hook_set()
13096 typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
13098 * Callback type for the JS confirm hook.
13100 * The function parameters are:
13101 * @li @p data User data pointer set when setting the hook function
13102 * @li @p obj The elm_web object requesting the new window
13103 * @li @p message The message to show in the confirm dialog
13104 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13105 * the user selected @c Ok, @c EINA_FALSE otherwise.
13107 * The function should return the object representing the confirm dialog.
13108 * Elm_Web will run a second main loop to handle the dialog and normal
13109 * flow of the application will be restored when the object is deleted, so
13110 * the user should handle the popup properly in order to delete the object
13111 * when the action is finished.
13112 * If the function returns @c NULL the popup will be ignored.
13114 * @see elm_web_dialog_confirm_hook_set()
13116 typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
13118 * Callback type for the JS prompt hook.
13120 * The function parameters are:
13121 * @li @p data User data pointer set when setting the hook function
13122 * @li @p obj The elm_web object requesting the new window
13123 * @li @p message The message to show in the prompt dialog
13124 * @li @p def_value The default value to present the user in the entry
13125 * @li @p value Pointer where to store the value given by the user. Must
13126 * be a malloc'ed string or @c NULL if the user cancelled the popup.
13127 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13128 * the user selected @c Ok, @c EINA_FALSE otherwise.
13130 * The function should return the object representing the prompt dialog.
13131 * Elm_Web will run a second main loop to handle the dialog and normal
13132 * flow of the application will be restored when the object is deleted, so
13133 * the user should handle the popup properly in order to delete the object
13134 * when the action is finished.
13135 * If the function returns @c NULL the popup will be ignored.
13137 * @see elm_web_dialog_prompt_hook_set()
13139 typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret);
13141 * Callback type for the JS file selector hook.
13143 * The function parameters are:
13144 * @li @p data User data pointer set when setting the hook function
13145 * @li @p obj The elm_web object requesting the new window
13146 * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
13147 * @li @p accept_types Mime types accepted
13148 * @li @p selected Pointer where to store the list of malloc'ed strings
13149 * containing the path to each file selected. Must be @c NULL if the file
13150 * dialog is cancelled
13151 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13152 * the user selected @c Ok, @c EINA_FALSE otherwise.
13154 * The function should return the object representing the file selector
13156 * Elm_Web will run a second main loop to handle the dialog and normal
13157 * flow of the application will be restored when the object is deleted, so
13158 * the user should handle the popup properly in order to delete the object
13159 * when the action is finished.
13160 * If the function returns @c NULL the popup will be ignored.
13162 * @see elm_web_dialog_file selector_hook_set()
13164 typedef Evas_Object *(*Elm_Web_Dialog_File_Selector)(void *data, Evas_Object *obj, Eina_Bool allows_multiple, Eina_List *accept_types, Eina_List **selected, Eina_Bool *ret);
13166 * Callback type for the JS console message hook.
13168 * When a console message is added from JavaScript, any set function to the
13169 * console message hook will be called for the user to handle. There is no
13170 * default implementation of this hook.
13172 * The function parameters are:
13173 * @li @p data User data pointer set when setting the hook function
13174 * @li @p obj The elm_web object that originated the message
13175 * @li @p message The message sent
13176 * @li @p line_number The line number
13177 * @li @p source_id Source id
13179 * @see elm_web_console_message_hook_set()
13181 typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
13183 * Add a new web object to the parent.
13185 * @param parent The parent object.
13186 * @return The new object or NULL if it cannot be created.
13188 * @see elm_web_uri_set()
13189 * @see elm_web_webkit_view_get()
13191 EAPI Evas_Object *elm_web_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13194 * Get internal ewk_view object from web object.
13196 * Elementary may not provide some low level features of EWebKit,
13197 * instead of cluttering the API with proxy methods we opted to
13198 * return the internal reference. Be careful using it as it may
13199 * interfere with elm_web behavior.
13201 * @param obj The web object.
13202 * @return The internal ewk_view object or NULL if it does not
13203 * exist. (Failure to create or Elementary compiled without
13206 * @see elm_web_add()
13208 EAPI Evas_Object *elm_web_webkit_view_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13211 * Sets the function to call when a new window is requested
13213 * This hook will be called when a request to create a new window is
13214 * issued from the web page loaded.
13215 * There is no default implementation for this feature, so leaving this
13216 * unset or passing @c NULL in @p func will prevent new windows from
13219 * @param obj The web object where to set the hook function
13220 * @param func The hook function to be called when a window is requested
13221 * @param data User data
13223 EAPI void elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data);
13225 * Sets the function to call when an alert dialog
13227 * This hook will be called when a JavaScript alert dialog is requested.
13228 * If no function is set or @c NULL is passed in @p func, the default
13229 * implementation will take place.
13231 * @param obj The web object where to set the hook function
13232 * @param func The callback function to be used
13233 * @param data User data
13235 * @see elm_web_inwin_mode_set()
13237 EAPI void elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data);
13239 * Sets the function to call when an confirm dialog
13241 * This hook will be called when a JavaScript confirm dialog is requested.
13242 * If no function is set or @c NULL is passed in @p func, the default
13243 * implementation will take place.
13245 * @param obj The web object where to set the hook function
13246 * @param func The callback function to be used
13247 * @param data User data
13249 * @see elm_web_inwin_mode_set()
13251 EAPI void elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data);
13253 * Sets the function to call when an prompt dialog
13255 * This hook will be called when a JavaScript prompt dialog is requested.
13256 * If no function is set or @c NULL is passed in @p func, the default
13257 * implementation will take place.
13259 * @param obj The web object where to set the hook function
13260 * @param func The callback function to be used
13261 * @param data User data
13263 * @see elm_web_inwin_mode_set()
13265 EAPI void elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data);
13267 * Sets the function to call when an file selector dialog
13269 * This hook will be called when a JavaScript file selector dialog is
13271 * If no function is set or @c NULL is passed in @p func, the default
13272 * implementation will take place.
13274 * @param obj The web object where to set the hook function
13275 * @param func The callback function to be used
13276 * @param data User data
13278 * @see elm_web_inwin_mode_set()
13280 EAPI void elm_web_dialog_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data);
13282 * Sets the function to call when a console message is emitted from JS
13284 * This hook will be called when a console message is emitted from
13285 * JavaScript. There is no default implementation for this feature.
13287 * @param obj The web object where to set the hook function
13288 * @param func The callback function to be used
13289 * @param data User data
13291 EAPI void elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data);
13293 * Gets the status of the tab propagation
13295 * @param obj The web object to query
13296 * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
13298 * @see elm_web_tab_propagate_set()
13300 EAPI Eina_Bool elm_web_tab_propagate_get(const Evas_Object *obj);
13302 * Sets whether to use tab propagation
13304 * If tab propagation is enabled, whenever the user presses the Tab key,
13305 * Elementary will handle it and switch focus to the next widget.
13306 * The default value is disabled, where WebKit will handle the Tab key to
13307 * cycle focus though its internal objects, jumping to the next widget
13308 * only when that cycle ends.
13310 * @param obj The web object
13311 * @param propagate Whether to propagate Tab keys to Elementary or not
13313 EAPI void elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate);
13315 * Sets the URI for the web object
13317 * It must be a full URI, with resource included, in the form
13318 * http://www.enlightenment.org or file:///tmp/something.html
13320 * @param obj The web object
13321 * @param uri The URI to set
13322 * @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
13324 EAPI Eina_Bool elm_web_uri_set(Evas_Object *obj, const char *uri);
13326 * Gets the current URI for the object
13328 * The returned string must not be freed and is guaranteed to be
13331 * @param obj The web object
13332 * @return A stringshared internal string with the current URI, or NULL on
13335 EAPI const char *elm_web_uri_get(const Evas_Object *obj);
13337 * Gets the current title
13339 * The returned string must not be freed and is guaranteed to be
13342 * @param obj The web object
13343 * @return A stringshared internal string with the current title, or NULL on
13346 EAPI const char *elm_web_title_get(const Evas_Object *obj);
13348 * Sets the background color to be used by the web object
13350 * This is the color that will be used by default when the loaded page
13351 * does not set it's own. Color values are pre-multiplied.
13353 * @param obj The web object
13354 * @param r Red component
13355 * @param g Green component
13356 * @param b Blue component
13357 * @param a Alpha component
13359 EAPI void elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a);
13361 * Gets the background color to be used by the web object
13363 * This is the color that will be used by default when the loaded page
13364 * does not set it's own. Color values are pre-multiplied.
13366 * @param obj The web object
13367 * @param r Red component
13368 * @param g Green component
13369 * @param b Blue component
13370 * @param a Alpha component
13372 EAPI void elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
13374 * Gets a copy of the currently selected text
13376 * The string returned must be freed by the user when it's done with it.
13378 * @param obj The web object
13379 * @return A newly allocated string, or NULL if nothing is selected or an
13382 EAPI char *elm_view_selection_get(const Evas_Object *obj);
13384 * Tells the web object which index in the currently open popup was selected
13386 * When the user handles the popup creation from the "popup,created" signal,
13387 * it needs to tell the web object which item was selected by calling this
13388 * function with the index corresponding to the item.
13390 * @param obj The web object
13391 * @param index The index selected
13393 * @see elm_web_popup_destroy()
13395 EAPI void elm_web_popup_selected_set(Evas_Object *obj, int index);
13397 * Dismisses an open dropdown popup
13399 * When the popup from a dropdown widget is to be dismissed, either after
13400 * selecting an option or to cancel it, this function must be called, which
13401 * will later emit an "popup,willdelete" signal to notify the user that
13402 * any memory and objects related to this popup can be freed.
13404 * @param obj The web object
13405 * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE
13406 * if there was no menu to destroy
13408 EAPI Eina_Bool elm_web_popup_destroy(Evas_Object *obj);
13410 * Searches the given string in a document.
13412 * @param obj The web object where to search the text
13413 * @param string String to search
13414 * @param case_sensitive If search should be case sensitive or not
13415 * @param forward If search is from cursor and on or backwards
13416 * @param wrap If search should wrap at the end
13418 * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not
13421 EAPI Eina_Bool elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
13423 * Marks matches of the given string in a document.
13425 * @param obj The web object where to search text
13426 * @param string String to match
13427 * @param case_sensitive If match should be case sensitive or not
13428 * @param highlight If matches should be highlighted
13429 * @param limit Maximum amount of matches, or zero to unlimited
13431 * @return number of matched @a string
13433 EAPI unsigned int elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
13435 * Clears all marked matches in the document
13437 * @param obj The web object
13439 * @return EINA_TRUE on success, EINA_FALSE otherwise
13441 EAPI Eina_Bool elm_web_text_matches_unmark_all(Evas_Object *obj);
13443 * Sets whether to highlight the matched marks
13445 * If enabled, marks set with elm_web_text_matches_mark() will be
13448 * @param obj The web object
13449 * @param highlight Whether to highlight the marks or not
13451 * @return EINA_TRUE on success, EINA_FALSE otherwise
13453 EAPI Eina_Bool elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight);
13455 * Gets whether highlighting marks is enabled
13457 * @param The web object
13459 * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
13462 EAPI Eina_Bool elm_web_text_matches_highlight_get(const Evas_Object *obj);
13464 * Gets the overall loading progress of the page
13466 * Returns the estimated loading progress of the page, with a value between
13467 * 0.0 and 1.0. This is an estimated progress accounting for all the frames
13468 * included in the page.
13470 * @param The web object
13472 * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
13475 EAPI double elm_web_load_progress_get(const Evas_Object *obj);
13477 * Stops loading the current page
13479 * Cancels the loading of the current page in the web object. This will
13480 * cause a "load,error" signal to be emitted, with the is_cancellation
13481 * flag set to EINA_TRUE.
13483 * @param obj The web object
13485 * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
13487 EAPI Eina_Bool elm_web_stop(Evas_Object *obj);
13489 * Requests a reload of the current document in the object
13491 * @param obj The web object
13493 * @return EINA_TRUE on success, EINA_FALSE otherwise
13495 EAPI Eina_Bool elm_web_reload(Evas_Object *obj);
13497 * Requests a reload of the current document, avoiding any existing caches
13499 * @param obj The web object
13501 * @return EINA_TRUE on success, EINA_FALSE otherwise
13503 EAPI Eina_Bool elm_web_reload_full(Evas_Object *obj);
13505 * Goes back one step in the browsing history
13507 * This is equivalent to calling elm_web_object_navigate(obj, -1);
13509 * @param obj The web object
13511 * @return EINA_TRUE on success, EINA_FALSE otherwise
13513 * @see elm_web_history_enable_set()
13514 * @see elm_web_back_possible()
13515 * @see elm_web_forward()
13516 * @see elm_web_navigate()
13518 EAPI Eina_Bool elm_web_back(Evas_Object *obj);
13520 * Goes forward one step in the browsing history
13522 * This is equivalent to calling elm_web_object_navigate(obj, 1);
13524 * @param obj The web object
13526 * @return EINA_TRUE on success, EINA_FALSE otherwise
13528 * @see elm_web_history_enable_set()
13529 * @see elm_web_forward_possible()
13530 * @see elm_web_back()
13531 * @see elm_web_navigate()
13533 EAPI Eina_Bool elm_web_forward(Evas_Object *obj);
13535 * Jumps the given number of steps in the browsing history
13537 * The @p steps value can be a negative integer to back in history, or a
13538 * positive to move forward.
13540 * @param obj The web object
13541 * @param steps The number of steps to jump
13543 * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
13544 * history exists to jump the given number of steps
13546 * @see elm_web_history_enable_set()
13547 * @see elm_web_navigate_possible()
13548 * @see elm_web_back()
13549 * @see elm_web_forward()
13551 EAPI Eina_Bool elm_web_navigate(Evas_Object *obj, int steps);
13553 * Queries whether it's possible to go back in history
13555 * @param obj The web object
13557 * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
13560 EAPI Eina_Bool elm_web_back_possible(Evas_Object *obj);
13562 * Queries whether it's possible to go forward in history
13564 * @param obj The web object
13566 * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
13569 EAPI Eina_Bool elm_web_forward_possible(Evas_Object *obj);
13571 * Queries whether it's possible to jump the given number of steps
13573 * The @p steps value can be a negative integer to back in history, or a
13574 * positive to move forward.
13576 * @param obj The web object
13577 * @param steps The number of steps to check for
13579 * @return EINA_TRUE if enough history exists to perform the given jump,
13580 * EINA_FALSE otherwise
13582 EAPI Eina_Bool elm_web_navigate_possible(Evas_Object *obj, int steps);
13584 * Gets whether browsing history is enabled for the given object
13586 * @param obj The web object
13588 * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
13590 EAPI Eina_Bool elm_web_history_enable_get(const Evas_Object *obj);
13592 * Enables or disables the browsing history
13594 * @param obj The web object
13595 * @param enable Whether to enable or disable the browsing history
13597 EAPI void elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
13599 * Sets the zoom level of the web object
13601 * Zoom level matches the Webkit API, so 1.0 means normal zoom, with higher
13602 * values meaning zoom in and lower meaning zoom out. This function will
13603 * only affect the zoom level if the mode set with elm_web_zoom_mode_set()
13604 * is ::ELM_WEB_ZOOM_MODE_MANUAL.
13606 * @param obj The web object
13607 * @param zoom The zoom level to set
13609 EAPI void elm_web_zoom_set(Evas_Object *obj, double zoom);
13611 * Gets the current zoom level set on the web object
13613 * Note that this is the zoom level set on the web object and not that
13614 * of the underlying Webkit one. In the ::ELM_WEB_ZOOM_MODE_MANUAL mode,
13615 * the two zoom levels should match, but for the other two modes the
13616 * Webkit zoom is calculated internally to match the chosen mode without
13617 * changing the zoom level set for the web object.
13619 * @param obj The web object
13621 * @return The zoom level set on the object
13623 EAPI double elm_web_zoom_get(const Evas_Object *obj);
13625 * Sets the zoom mode to use
13627 * The modes can be any of those defined in ::Elm_Web_Zoom_Mode, except
13628 * ::ELM_WEB_ZOOM_MODE_LAST. The default is ::ELM_WEB_ZOOM_MODE_MANUAL.
13630 * ::ELM_WEB_ZOOM_MODE_MANUAL means the zoom level will be controlled
13631 * with the elm_web_zoom_set() function.
13632 * ::ELM_WEB_ZOOM_MODE_AUTO_FIT will calculate the needed zoom level to
13633 * make sure the entirety of the web object's contents are shown.
13634 * ::ELM_WEB_ZOOM_MODE_AUTO_FILL will calculate the needed zoom level to
13635 * fit the contents in the web object's size, without leaving any space
13638 * @param obj The web object
13639 * @param mode The mode to set
13641 EAPI void elm_web_zoom_mode_set(Evas_Object *obj, Elm_Web_Zoom_Mode mode);
13643 * Gets the currently set zoom mode
13645 * @param obj The web object
13647 * @return The current zoom mode set for the object, or
13648 * ::ELM_WEB_ZOOM_MODE_LAST on error
13650 EAPI Elm_Web_Zoom_Mode elm_web_zoom_mode_get(const Evas_Object *obj);
13652 * Shows the given region in the web object
13654 * @param obj The web object
13655 * @param x The x coordinate of the region to show
13656 * @param y The y coordinate of the region to show
13657 * @param w The width of the region to show
13658 * @param h The height of the region to show
13660 EAPI void elm_web_region_show(Evas_Object *obj, int x, int y, int w, int h);
13662 * Brings in the region to the visible area
13664 * Like elm_web_region_show(), but it animates the scrolling of the object
13667 * @param obj The web object
13668 * @param x The x coordinate of the region to show
13669 * @param y The y coordinate of the region to show
13670 * @param w The width of the region to show
13671 * @param h The height of the region to show
13673 EAPI void elm_web_region_bring_in(Evas_Object *obj, int x, int y, int w, int h);
13675 * Sets the default dialogs to use an Inwin instead of a normal window
13677 * If set, then the default implementation for the JavaScript dialogs and
13678 * file selector will be opened in an Inwin. Otherwise they will use a
13679 * normal separated window.
13681 * @param obj The web object
13682 * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
13684 EAPI void elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
13686 * Gets whether Inwin mode is set for the current object
13688 * @param obj The web object
13690 * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
13692 EAPI Eina_Bool elm_web_inwin_mode_get(const Evas_Object *obj);
13694 EAPI void elm_web_window_features_ref(Elm_Web_Window_Features *wf);
13695 EAPI void elm_web_window_features_unref(Elm_Web_Window_Features *wf);
13696 EAPI void elm_web_window_features_bool_property_get(const Elm_Web_Window_Features *wf, Eina_Bool *toolbar_visible, Eina_Bool *statusbar_visible, Eina_Bool *scrollbars_visible, Eina_Bool *menubar_visible, Eina_Bool *locationbar_visble, Eina_Bool *fullscreen);
13697 EAPI void elm_web_window_features_int_property_get(const Elm_Web_Window_Features *wf, int *x, int *y, int *w, int *h);
13705 * @defgroup Hoversel Hoversel
13707 * @image html img/widget/hoversel/preview-00.png
13708 * @image latex img/widget/hoversel/preview-00.eps
13710 * A hoversel is a button that pops up a list of items (automatically
13711 * choosing the direction to display) that have a label and, optionally, an
13712 * icon to select from. It is a convenience widget to avoid the need to do
13713 * all the piecing together yourself. It is intended for a small number of
13714 * items in the hoversel menu (no more than 8), though is capable of many
13717 * Signals that you can add callbacks for are:
13718 * "clicked" - the user clicked the hoversel button and popped up the sel
13719 * "selected" - an item in the hoversel list is selected. event_info is the item
13720 * "dismissed" - the hover is dismissed
13722 * See @ref tutorial_hoversel for an example.
13725 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
13727 * @brief Add a new Hoversel object
13729 * @param parent The parent object
13730 * @return The new object or NULL if it cannot be created
13732 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13734 * @brief This sets the hoversel to expand horizontally.
13736 * @param obj The hoversel object
13737 * @param horizontal If true, the hover will expand horizontally to the
13740 * @note The initial button will display horizontally regardless of this
13743 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
13745 * @brief This returns whether the hoversel is set to expand horizontally.
13747 * @param obj The hoversel object
13748 * @return If true, the hover will expand horizontally to the right.
13750 * @see elm_hoversel_horizontal_set()
13752 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13754 * @brief Set the Hover parent
13756 * @param obj The hoversel object
13757 * @param parent The parent to use
13759 * Sets the hover parent object, the area that will be darkened when the
13760 * hoversel is clicked. Should probably be the window that the hoversel is
13761 * in. See @ref Hover objects for more information.
13763 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
13765 * @brief Get the Hover parent
13767 * @param obj The hoversel object
13768 * @return The used parent
13770 * Gets the hover parent object.
13772 * @see elm_hoversel_hover_parent_set()
13774 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13776 * @brief Set the hoversel button label
13778 * @param obj The hoversel object
13779 * @param label The label text.
13781 * This sets the label of the button that is always visible (before it is
13782 * clicked and expanded).
13784 * @deprecated elm_object_text_set()
13786 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13788 * @brief Get the hoversel button label
13790 * @param obj The hoversel object
13791 * @return The label text.
13793 * @deprecated elm_object_text_get()
13795 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13797 * @brief Set the icon of the hoversel button
13799 * @param obj The hoversel object
13800 * @param icon The icon object
13802 * Sets the icon of the button that is always visible (before it is clicked
13803 * and expanded). Once the icon object is set, a previously set one will be
13804 * deleted, if you want to keep that old content object, use the
13805 * elm_hoversel_icon_unset() function.
13807 * @see elm_object_content_set() for the button widget
13809 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
13811 * @brief Get the icon of the hoversel button
13813 * @param obj The hoversel object
13814 * @return The icon object
13816 * Get the icon of the button that is always visible (before it is clicked
13817 * and expanded). Also see elm_object_content_get() for the button widget.
13819 * @see elm_hoversel_icon_set()
13821 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13823 * @brief Get and unparent the icon of the hoversel button
13825 * @param obj The hoversel object
13826 * @return The icon object that was being used
13828 * Unparent and return the icon of the button that is always visible
13829 * (before it is clicked and expanded).
13831 * @see elm_hoversel_icon_set()
13832 * @see elm_object_content_unset() for the button widget
13834 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13836 * @brief This triggers the hoversel popup from code, the same as if the user
13837 * had clicked the button.
13839 * @param obj The hoversel object
13841 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
13843 * @brief This dismisses the hoversel popup as if the user had clicked
13844 * outside the hover.
13846 * @param obj The hoversel object
13848 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
13850 * @brief Returns whether the hoversel is expanded.
13852 * @param obj The hoversel object
13853 * @return This will return EINA_TRUE if the hoversel is expanded or
13854 * EINA_FALSE if it is not expanded.
13856 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13858 * @brief This will remove all the children items from the hoversel.
13860 * @param obj The hoversel object
13862 * @warning Should @b not be called while the hoversel is active; use
13863 * elm_hoversel_expanded_get() to check first.
13865 * @see elm_hoversel_item_del_cb_set()
13866 * @see elm_hoversel_item_del()
13868 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
13870 * @brief Get the list of items within the given hoversel.
13872 * @param obj The hoversel object
13873 * @return Returns a list of Elm_Hoversel_Item*
13875 * @see elm_hoversel_item_add()
13877 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13879 * @brief Add an item to the hoversel button
13881 * @param obj The hoversel object
13882 * @param label The text label to use for the item (NULL if not desired)
13883 * @param icon_file An image file path on disk to use for the icon or standard
13884 * icon name (NULL if not desired)
13885 * @param icon_type The icon type if relevant
13886 * @param func Convenience function to call when this item is selected
13887 * @param data Data to pass to item-related functions
13888 * @return A handle to the item added.
13890 * This adds an item to the hoversel to show when it is clicked. Note: if you
13891 * need to use an icon from an edje file then use
13892 * elm_hoversel_item_icon_set() right after the this function, and set
13893 * icon_file to NULL here.
13895 * For more information on what @p icon_file and @p icon_type are see the
13896 * @ref Icon "icon documentation".
13898 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);
13900 * @brief Delete an item from the hoversel
13902 * @param item The item to delete
13904 * This deletes the item from the hoversel (should not be called while the
13905 * hoversel is active; use elm_hoversel_expanded_get() to check first).
13907 * @see elm_hoversel_item_add()
13908 * @see elm_hoversel_item_del_cb_set()
13910 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
13912 * @brief Set the function to be called when an item from the hoversel is
13915 * @param item The item to set the callback on
13916 * @param func The function called
13918 * That function will receive these parameters:
13919 * @li void *item_data
13920 * @li Evas_Object *the_item_object
13921 * @li Elm_Hoversel_Item *the_object_struct
13923 * @see elm_hoversel_item_add()
13925 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
13927 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
13928 * that will be passed to associated function callbacks.
13930 * @param item The item to get the data from
13931 * @return The data pointer set with elm_hoversel_item_add()
13933 * @see elm_hoversel_item_add()
13935 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
13937 * @brief This returns the label text of the given hoversel item.
13939 * @param item The item to get the label
13940 * @return The label text of the hoversel item
13942 * @see elm_hoversel_item_add()
13944 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
13946 * @brief This sets the icon for the given hoversel item.
13948 * @param item The item to set the icon
13949 * @param icon_file An image file path on disk to use for the icon or standard
13951 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
13952 * to NULL if the icon is not an edje file
13953 * @param icon_type The icon type
13955 * The icon can be loaded from the standard set, from an image file, or from
13958 * @see elm_hoversel_item_add()
13960 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);
13962 * @brief Get the icon object of the hoversel item
13964 * @param item The item to get the icon from
13965 * @param icon_file The image file path on disk used for the icon or standard
13967 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
13968 * if the icon is not an edje file
13969 * @param icon_type The icon type
13971 * @see elm_hoversel_item_icon_set()
13972 * @see elm_hoversel_item_add()
13974 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);
13980 * @defgroup Toolbar Toolbar
13981 * @ingroup Elementary
13983 * @image html img/widget/toolbar/preview-00.png
13984 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
13986 * @image html img/toolbar.png
13987 * @image latex img/toolbar.eps width=\textwidth
13989 * A toolbar is a widget that displays a list of items inside
13990 * a box. It can be scrollable, show a menu with items that don't fit
13991 * to toolbar size or even crop them.
13993 * Only one item can be selected at a time.
13995 * Items can have multiple states, or show menus when selected by the user.
13997 * Smart callbacks one can listen to:
13998 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
13999 * - "language,changed" - when the program language changes
14001 * Available styles for it:
14003 * - @c "transparent" - no background or shadow, just show the content
14005 * List of examples:
14006 * @li @ref toolbar_example_01
14007 * @li @ref toolbar_example_02
14008 * @li @ref toolbar_example_03
14012 * @addtogroup Toolbar
14017 * @enum _Elm_Toolbar_Shrink_Mode
14018 * @typedef Elm_Toolbar_Shrink_Mode
14020 * Set toolbar's items display behavior, it can be scrollabel,
14021 * show a menu with exceeding items, or simply hide them.
14023 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
14026 * Values <b> don't </b> work as bitmask, only one can be choosen.
14028 * @see elm_toolbar_mode_shrink_set()
14029 * @see elm_toolbar_mode_shrink_get()
14033 typedef enum _Elm_Toolbar_Shrink_Mode
14035 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
14036 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
14037 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
14038 ELM_TOOLBAR_SHRINK_MENU, /**< Inserts a button to pop up a menu with exceeding items. */
14039 } Elm_Toolbar_Shrink_Mode;
14041 typedef struct _Elm_Toolbar_Item Elm_Toolbar_Item; /**< Item of Elm_Toolbar. Sub-type of Elm_Widget_Item. Can be created with elm_toolbar_item_append(), elm_toolbar_item_prepend() and functions to add items in relative positions, like elm_toolbar_item_insert_before(), and deleted with elm_toolbar_item_del(). */
14043 typedef struct _Elm_Toolbar_Item_State Elm_Toolbar_Item_State; /**< State of a Elm_Toolbar_Item. Can be created with elm_toolbar_item_state_add() and removed with elm_toolbar_item_state_del(). */
14046 * Add a new toolbar widget to the given parent Elementary
14047 * (container) object.
14049 * @param parent The parent object.
14050 * @return a new toolbar widget handle or @c NULL, on errors.
14052 * This function inserts a new toolbar widget on the canvas.
14056 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14059 * Set the icon size, in pixels, to be used by toolbar items.
14061 * @param obj The toolbar object
14062 * @param icon_size The icon size in pixels
14064 * @note Default value is @c 32. It reads value from elm config.
14066 * @see elm_toolbar_icon_size_get()
14070 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
14073 * Get the icon size, in pixels, to be used by toolbar items.
14075 * @param obj The toolbar object.
14076 * @return The icon size in pixels.
14078 * @see elm_toolbar_icon_size_set() for details.
14082 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14085 * Sets icon lookup order, for toolbar items' icons.
14087 * @param obj The toolbar object.
14088 * @param order The icon lookup order.
14090 * Icons added before calling this function will not be affected.
14091 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
14093 * @see elm_toolbar_icon_order_lookup_get()
14097 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
14100 * Gets the icon lookup order.
14102 * @param obj The toolbar object.
14103 * @return The icon lookup order.
14105 * @see elm_toolbar_icon_order_lookup_set() for details.
14109 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14112 * Set whether the toolbar items' should be selected by the user or not.
14114 * @param obj The toolbar object.
14115 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
14118 * This will turn off the ability to select items entirely and they will
14119 * neither appear selected nor emit selected signals. The clicked
14120 * callback function will still be called.
14122 * Selection is enabled by default.
14124 * @see elm_toolbar_no_select_mode_get().
14128 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14131 * Set whether the toolbar items' should be selected by the user or not.
14133 * @param obj The toolbar object.
14134 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
14135 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
14137 * @see elm_toolbar_no_select_mode_set() for details.
14141 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14144 * Append item to the toolbar.
14146 * @param obj The toolbar object.
14147 * @param icon A string with icon name or the absolute path of an image file.
14148 * @param label The label of the item.
14149 * @param func The function to call when the item is clicked.
14150 * @param data The data to associate with the item for related callbacks.
14151 * @return The created item or @c NULL upon failure.
14153 * A new item will be created and appended to the toolbar, i.e., will
14154 * be set as @b last item.
14156 * Items created with this method can be deleted with
14157 * elm_toolbar_item_del().
14159 * Associated @p data can be properly freed when item is deleted if a
14160 * callback function is set with elm_toolbar_item_del_cb_set().
14162 * If a function is passed as argument, it will be called everytime this item
14163 * is selected, i.e., the user clicks over an unselected item.
14164 * If such function isn't needed, just passing
14165 * @c NULL as @p func is enough. The same should be done for @p data.
14167 * Toolbar will load icon image from fdo or current theme.
14168 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14169 * If an absolute path is provided it will load it direct from a file.
14171 * @see elm_toolbar_item_icon_set()
14172 * @see elm_toolbar_item_del()
14173 * @see elm_toolbar_item_del_cb_set()
14177 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);
14180 * Prepend item to the toolbar.
14182 * @param obj The toolbar object.
14183 * @param icon A string with icon name or the absolute path of an image file.
14184 * @param label The label of the item.
14185 * @param func The function to call when the item is clicked.
14186 * @param data The data to associate with the item for related callbacks.
14187 * @return The created item or @c NULL upon failure.
14189 * A new item will be created and prepended to the toolbar, i.e., will
14190 * be set as @b first item.
14192 * Items created with this method can be deleted with
14193 * elm_toolbar_item_del().
14195 * Associated @p data can be properly freed when item is deleted if a
14196 * callback function is set with elm_toolbar_item_del_cb_set().
14198 * If a function is passed as argument, it will be called everytime this item
14199 * is selected, i.e., the user clicks over an unselected item.
14200 * If such function isn't needed, just passing
14201 * @c NULL as @p func is enough. The same should be done for @p data.
14203 * Toolbar will load icon image from fdo or current theme.
14204 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14205 * If an absolute path is provided it will load it direct from a file.
14207 * @see elm_toolbar_item_icon_set()
14208 * @see elm_toolbar_item_del()
14209 * @see elm_toolbar_item_del_cb_set()
14213 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);
14216 * Insert a new item into the toolbar object before item @p before.
14218 * @param obj The toolbar object.
14219 * @param before The toolbar item to insert before.
14220 * @param icon A string with icon name or the absolute path of an image file.
14221 * @param label The label of the item.
14222 * @param func The function to call when the item is clicked.
14223 * @param data The data to associate with the item for related callbacks.
14224 * @return The created item or @c NULL upon failure.
14226 * A new item will be created and added to the toolbar. Its position in
14227 * this toolbar will be just before item @p before.
14229 * Items created with this method can be deleted with
14230 * elm_toolbar_item_del().
14232 * Associated @p data can be properly freed when item is deleted if a
14233 * callback function is set with elm_toolbar_item_del_cb_set().
14235 * If a function is passed as argument, it will be called everytime this item
14236 * is selected, i.e., the user clicks over an unselected item.
14237 * If such function isn't needed, just passing
14238 * @c NULL as @p func is enough. The same should be done for @p data.
14240 * Toolbar will load icon image from fdo or current theme.
14241 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14242 * If an absolute path is provided it will load it direct from a file.
14244 * @see elm_toolbar_item_icon_set()
14245 * @see elm_toolbar_item_del()
14246 * @see elm_toolbar_item_del_cb_set()
14250 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);
14253 * Insert a new item into the toolbar object after item @p after.
14255 * @param obj The toolbar object.
14256 * @param after The toolbar item to insert after.
14257 * @param icon A string with icon name or the absolute path of an image file.
14258 * @param label The label of the item.
14259 * @param func The function to call when the item is clicked.
14260 * @param data The data to associate with the item for related callbacks.
14261 * @return The created item or @c NULL upon failure.
14263 * A new item will be created and added to the toolbar. Its position in
14264 * this toolbar will be just after item @p after.
14266 * Items created with this method can be deleted with
14267 * elm_toolbar_item_del().
14269 * Associated @p data can be properly freed when item is deleted if a
14270 * callback function is set with elm_toolbar_item_del_cb_set().
14272 * If a function is passed as argument, it will be called everytime this item
14273 * is selected, i.e., the user clicks over an unselected item.
14274 * If such function isn't needed, just passing
14275 * @c NULL as @p func is enough. The same should be done for @p data.
14277 * Toolbar will load icon image from fdo or current theme.
14278 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14279 * If an absolute path is provided it will load it direct from a file.
14281 * @see elm_toolbar_item_icon_set()
14282 * @see elm_toolbar_item_del()
14283 * @see elm_toolbar_item_del_cb_set()
14287 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);
14290 * Get the first item in the given toolbar widget's list of
14293 * @param obj The toolbar object
14294 * @return The first item or @c NULL, if it has no items (and on
14297 * @see elm_toolbar_item_append()
14298 * @see elm_toolbar_last_item_get()
14302 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14305 * Get the last item in the given toolbar widget's list of
14308 * @param obj The toolbar object
14309 * @return The last item or @c NULL, if it has no items (and on
14312 * @see elm_toolbar_item_prepend()
14313 * @see elm_toolbar_first_item_get()
14317 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14320 * Get the item after @p item in toolbar.
14322 * @param item The toolbar item.
14323 * @return The item after @p item, or @c NULL if none or on failure.
14325 * @note If it is the last item, @c NULL will be returned.
14327 * @see elm_toolbar_item_append()
14331 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14334 * Get the item before @p item in toolbar.
14336 * @param item The toolbar item.
14337 * @return The item before @p item, or @c NULL if none or on failure.
14339 * @note If it is the first item, @c NULL will be returned.
14341 * @see elm_toolbar_item_prepend()
14345 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14348 * Get the toolbar object from an item.
14350 * @param item The item.
14351 * @return The toolbar object.
14353 * This returns the toolbar object itself that an item belongs to.
14357 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14360 * Set the priority of a toolbar item.
14362 * @param item The toolbar item.
14363 * @param priority The item priority. The default is zero.
14365 * This is used only when the toolbar shrink mode is set to
14366 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
14367 * When space is less than required, items with low priority
14368 * will be removed from the toolbar and added to a dynamically-created menu,
14369 * while items with higher priority will remain on the toolbar,
14370 * with the same order they were added.
14372 * @see elm_toolbar_item_priority_get()
14376 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
14379 * Get the priority of a toolbar item.
14381 * @param item The toolbar item.
14382 * @return The @p item priority, or @c 0 on failure.
14384 * @see elm_toolbar_item_priority_set() for details.
14388 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14391 * Get the label of item.
14393 * @param item The item of toolbar.
14394 * @return The label of item.
14396 * The return value is a pointer to the label associated to @p item when
14397 * it was created, with function elm_toolbar_item_append() or similar,
14399 * with function elm_toolbar_item_label_set. If no label
14400 * was passed as argument, it will return @c NULL.
14402 * @see elm_toolbar_item_label_set() for more details.
14403 * @see elm_toolbar_item_append()
14407 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14410 * Set the label of item.
14412 * @param item The item of toolbar.
14413 * @param text The label of item.
14415 * The label to be displayed by the item.
14416 * Label will be placed at icons bottom (if set).
14418 * If a label was passed as argument on item creation, with function
14419 * elm_toolbar_item_append() or similar, it will be already
14420 * displayed by the item.
14422 * @see elm_toolbar_item_label_get()
14423 * @see elm_toolbar_item_append()
14427 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
14430 * Return the data associated with a given toolbar widget item.
14432 * @param item The toolbar widget item handle.
14433 * @return The data associated with @p item.
14435 * @see elm_toolbar_item_data_set()
14439 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14442 * Set the data associated with a given toolbar widget item.
14444 * @param item The toolbar widget item handle.
14445 * @param data The new data pointer to set to @p item.
14447 * This sets new item data on @p item.
14449 * @warning The old data pointer won't be touched by this function, so
14450 * the user had better to free that old data himself/herself.
14454 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
14457 * Returns a pointer to a toolbar item by its label.
14459 * @param obj The toolbar object.
14460 * @param label The label of the item to find.
14462 * @return The pointer to the toolbar item matching @p label or @c NULL
14467 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14470 * Get whether the @p item is selected or not.
14472 * @param item The toolbar item.
14473 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
14474 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
14476 * @see elm_toolbar_selected_item_set() for details.
14477 * @see elm_toolbar_item_selected_get()
14481 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14484 * Set the selected state of an item.
14486 * @param item The toolbar item
14487 * @param selected The selected state
14489 * This sets the selected state of the given item @p it.
14490 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
14492 * If a new item is selected the previosly selected will be unselected.
14493 * Previoulsy selected item can be get with function
14494 * elm_toolbar_selected_item_get().
14496 * Selected items will be highlighted.
14498 * @see elm_toolbar_item_selected_get()
14499 * @see elm_toolbar_selected_item_get()
14503 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14506 * Get the selected item.
14508 * @param obj The toolbar object.
14509 * @return The selected toolbar item.
14511 * The selected item can be unselected with function
14512 * elm_toolbar_item_selected_set().
14514 * The selected item always will be highlighted on toolbar.
14516 * @see elm_toolbar_selected_items_get()
14520 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14523 * Set the icon associated with @p item.
14525 * @param obj The parent of this item.
14526 * @param item The toolbar item.
14527 * @param icon A string with icon name or the absolute path of an image file.
14529 * Toolbar will load icon image from fdo or current theme.
14530 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14531 * If an absolute path is provided it will load it direct from a file.
14533 * @see elm_toolbar_icon_order_lookup_set()
14534 * @see elm_toolbar_icon_order_lookup_get()
14538 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
14541 * Get the string used to set the icon of @p item.
14543 * @param item The toolbar item.
14544 * @return The string associated with the icon object.
14546 * @see elm_toolbar_item_icon_set() for details.
14550 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14553 * Get the object of @p item.
14555 * @param item The toolbar item.
14556 * @return The object
14560 EAPI Evas_Object *elm_toolbar_item_object_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14563 * Get the icon object of @p item.
14565 * @param item The toolbar item.
14566 * @return The icon object
14568 * @see elm_toolbar_item_icon_set() or elm_toolbar_item_icon_memfile_set() for details.
14572 EAPI Evas_Object *elm_toolbar_item_icon_object_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14575 * Set the icon associated with @p item to an image in a binary buffer.
14577 * @param item The toolbar item.
14578 * @param img The binary data that will be used as an image
14579 * @param size The size of binary data @p img
14580 * @param format Optional format of @p img to pass to the image loader
14581 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
14583 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
14585 * @note The icon image set by this function can be changed by
14586 * elm_toolbar_item_icon_set().
14590 EAPI Eina_Bool elm_toolbar_item_icon_memfile_set(Elm_Toolbar_Item *item, const void *img, size_t size, const char *format, const char *key) EINA_ARG_NONNULL(1);
14593 * Delete them item from the toolbar.
14595 * @param item The item of toolbar to be deleted.
14597 * @see elm_toolbar_item_append()
14598 * @see elm_toolbar_item_del_cb_set()
14602 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14605 * Set the function called when a toolbar item is freed.
14607 * @param item The item to set the callback on.
14608 * @param func The function called.
14610 * If there is a @p func, then it will be called prior item's memory release.
14611 * That will be called with the following arguments:
14613 * @li item's Evas object;
14616 * This way, a data associated to a toolbar item could be properly freed.
14620 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14623 * Get a value whether toolbar item is disabled or not.
14625 * @param item The item.
14626 * @return The disabled state.
14628 * @see elm_toolbar_item_disabled_set() for more details.
14632 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14635 * Sets the disabled/enabled state of a toolbar item.
14637 * @param item The item.
14638 * @param disabled The disabled state.
14640 * A disabled item cannot be selected or unselected. It will also
14641 * change its appearance (generally greyed out). This sets the
14642 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
14647 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
14650 * Set or unset item as a separator.
14652 * @param item The toolbar item.
14653 * @param setting @c EINA_TRUE to set item @p item as separator or
14654 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
14656 * Items aren't set as separator by default.
14658 * If set as separator it will display separator theme, so won't display
14661 * @see elm_toolbar_item_separator_get()
14665 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
14668 * Get a value whether item is a separator or not.
14670 * @param item The toolbar item.
14671 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
14672 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
14674 * @see elm_toolbar_item_separator_set() for details.
14678 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14681 * Set the shrink state of toolbar @p obj.
14683 * @param obj The toolbar object.
14684 * @param shrink_mode Toolbar's items display behavior.
14686 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
14687 * but will enforce a minimun size so all the items will fit, won't scroll
14688 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
14689 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
14690 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
14694 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
14697 * Get the shrink mode of toolbar @p obj.
14699 * @param obj The toolbar object.
14700 * @return Toolbar's items display behavior.
14702 * @see elm_toolbar_mode_shrink_set() for details.
14706 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14709 * Enable/disable homogenous mode.
14711 * @param obj The toolbar object
14712 * @param homogeneous Assume the items within the toolbar are of the
14713 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
14715 * This will enable the homogeneous mode where items are of the same size.
14716 * @see elm_toolbar_homogeneous_get()
14720 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
14723 * Get whether the homogenous mode is enabled.
14725 * @param obj The toolbar object.
14726 * @return Assume the items within the toolbar are of the same height
14727 * and width (EINA_TRUE = on, EINA_FALSE = off).
14729 * @see elm_toolbar_homogeneous_set()
14733 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14736 * Enable/disable homogenous mode.
14738 * @param obj The toolbar object
14739 * @param homogeneous Assume the items within the toolbar are of the
14740 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
14742 * This will enable the homogeneous mode where items are of the same size.
14743 * @see elm_toolbar_homogeneous_get()
14745 * @deprecated use elm_toolbar_homogeneous_set() instead.
14749 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
14752 * Get whether the homogenous mode is enabled.
14754 * @param obj The toolbar object.
14755 * @return Assume the items within the toolbar are of the same height
14756 * and width (EINA_TRUE = on, EINA_FALSE = off).
14758 * @see elm_toolbar_homogeneous_set()
14759 * @deprecated use elm_toolbar_homogeneous_get() instead.
14763 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14766 * Set the parent object of the toolbar items' menus.
14768 * @param obj The toolbar object.
14769 * @param parent The parent of the menu objects.
14771 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
14773 * For more details about setting the parent for toolbar menus, see
14774 * elm_menu_parent_set().
14776 * @see elm_menu_parent_set() for details.
14777 * @see elm_toolbar_item_menu_set() for details.
14781 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14784 * Get the parent object of the toolbar items' menus.
14786 * @param obj The toolbar object.
14787 * @return The parent of the menu objects.
14789 * @see elm_toolbar_menu_parent_set() for details.
14793 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14796 * Set the alignment of the items.
14798 * @param obj The toolbar object.
14799 * @param align The new alignment, a float between <tt> 0.0 </tt>
14800 * and <tt> 1.0 </tt>.
14802 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
14803 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
14806 * Centered items by default.
14808 * @see elm_toolbar_align_get()
14812 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
14815 * Get the alignment of the items.
14817 * @param obj The toolbar object.
14818 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
14821 * @see elm_toolbar_align_set() for details.
14825 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14828 * Set whether the toolbar item opens a menu.
14830 * @param item The toolbar item.
14831 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
14833 * A toolbar item can be set to be a menu, using this function.
14835 * Once it is set to be a menu, it can be manipulated through the
14836 * menu-like function elm_toolbar_menu_parent_set() and the other
14837 * elm_menu functions, using the Evas_Object @c menu returned by
14838 * elm_toolbar_item_menu_get().
14840 * So, items to be displayed in this item's menu should be added with
14841 * elm_menu_item_add().
14843 * The following code exemplifies the most basic usage:
14845 * tb = elm_toolbar_add(win)
14846 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
14847 * elm_toolbar_item_menu_set(item, EINA_TRUE);
14848 * elm_toolbar_menu_parent_set(tb, win);
14849 * menu = elm_toolbar_item_menu_get(item);
14850 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
14851 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
14855 * @see elm_toolbar_item_menu_get()
14859 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
14862 * Get toolbar item's menu.
14864 * @param item The toolbar item.
14865 * @return Item's menu object or @c NULL on failure.
14867 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
14868 * this function will set it.
14870 * @see elm_toolbar_item_menu_set() for details.
14874 EAPI Evas_Object *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14877 * Add a new state to @p item.
14879 * @param item The item.
14880 * @param icon A string with icon name or the absolute path of an image file.
14881 * @param label The label of the new state.
14882 * @param func The function to call when the item is clicked when this
14883 * state is selected.
14884 * @param data The data to associate with the state.
14885 * @return The toolbar item state, or @c NULL upon failure.
14887 * Toolbar will load icon image from fdo or current theme.
14888 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14889 * If an absolute path is provided it will load it direct from a file.
14891 * States created with this function can be removed with
14892 * elm_toolbar_item_state_del().
14894 * @see elm_toolbar_item_state_del()
14895 * @see elm_toolbar_item_state_sel()
14896 * @see elm_toolbar_item_state_get()
14900 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);
14903 * Delete a previoulsy added state to @p item.
14905 * @param item The toolbar item.
14906 * @param state The state to be deleted.
14907 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
14909 * @see elm_toolbar_item_state_add()
14911 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
14914 * Set @p state as the current state of @p it.
14916 * @param it The item.
14917 * @param state The state to use.
14918 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
14920 * If @p state is @c NULL, it won't select any state and the default item's
14921 * icon and label will be used. It's the same behaviour than
14922 * elm_toolbar_item_state_unser().
14924 * @see elm_toolbar_item_state_unset()
14928 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
14931 * Unset the state of @p it.
14933 * @param it The item.
14935 * The default icon and label from this item will be displayed.
14937 * @see elm_toolbar_item_state_set() for more details.
14941 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
14944 * Get the current state of @p it.
14946 * @param item The item.
14947 * @return The selected state or @c NULL if none is selected or on failure.
14949 * @see elm_toolbar_item_state_set() for details.
14950 * @see elm_toolbar_item_state_unset()
14951 * @see elm_toolbar_item_state_add()
14955 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
14958 * Get the state after selected state in toolbar's @p item.
14960 * @param it The toolbar item to change state.
14961 * @return The state after current state, or @c NULL on failure.
14963 * If last state is selected, this function will return first state.
14965 * @see elm_toolbar_item_state_set()
14966 * @see elm_toolbar_item_state_add()
14970 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
14973 * Get the state before selected state in toolbar's @p item.
14975 * @param it The toolbar item to change state.
14976 * @return The state before current state, or @c NULL on failure.
14978 * If first state is selected, this function will return last state.
14980 * @see elm_toolbar_item_state_set()
14981 * @see elm_toolbar_item_state_add()
14985 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
14988 * Set the text to be shown in a given toolbar item's tooltips.
14990 * @param item Target item.
14991 * @param text The text to set in the content.
14993 * Setup the text as tooltip to object. The item can have only one tooltip,
14994 * so any previous tooltip data - set with this function or
14995 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
14997 * @see elm_object_tooltip_text_set() for more details.
15001 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
15004 * Set the content to be shown in the tooltip item.
15006 * Setup the tooltip to item. The item can have only one tooltip,
15007 * so any previous tooltip data is removed. @p func(with @p data) will
15008 * be called every time that need show the tooltip and it should
15009 * return a valid Evas_Object. This object is then managed fully by
15010 * tooltip system and is deleted when the tooltip is gone.
15012 * @param item the toolbar item being attached a tooltip.
15013 * @param func the function used to create the tooltip contents.
15014 * @param data what to provide to @a func as callback data/context.
15015 * @param del_cb called when data is not needed anymore, either when
15016 * another callback replaces @a func, the tooltip is unset with
15017 * elm_toolbar_item_tooltip_unset() or the owner @a item
15018 * dies. This callback receives as the first parameter the
15019 * given @a data, and @c event_info is the item.
15021 * @see elm_object_tooltip_content_cb_set() for more details.
15025 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);
15028 * Unset tooltip from item.
15030 * @param item toolbar item to remove previously set tooltip.
15032 * Remove tooltip from item. The callback provided as del_cb to
15033 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
15034 * it is not used anymore.
15036 * @see elm_object_tooltip_unset() for more details.
15037 * @see elm_toolbar_item_tooltip_content_cb_set()
15041 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15044 * Sets a different style for this item tooltip.
15046 * @note before you set a style you should define a tooltip with
15047 * elm_toolbar_item_tooltip_content_cb_set() or
15048 * elm_toolbar_item_tooltip_text_set()
15050 * @param item toolbar item with tooltip already set.
15051 * @param style the theme style to use (default, transparent, ...)
15053 * @see elm_object_tooltip_style_set() for more details.
15057 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15060 * Get the style for this item tooltip.
15062 * @param item toolbar item with tooltip already set.
15063 * @return style the theme style in use, defaults to "default". If the
15064 * object does not have a tooltip set, then NULL is returned.
15066 * @see elm_object_tooltip_style_get() for more details.
15067 * @see elm_toolbar_item_tooltip_style_set()
15071 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15074 * Set the type of mouse pointer/cursor decoration to be shown,
15075 * when the mouse pointer is over the given toolbar widget item
15077 * @param item toolbar item to customize cursor on
15078 * @param cursor the cursor type's name
15080 * This function works analogously as elm_object_cursor_set(), but
15081 * here the cursor's changing area is restricted to the item's
15082 * area, and not the whole widget's. Note that that item cursors
15083 * have precedence over widget cursors, so that a mouse over an
15084 * item with custom cursor set will always show @b that cursor.
15086 * If this function is called twice for an object, a previously set
15087 * cursor will be unset on the second call.
15089 * @see elm_object_cursor_set()
15090 * @see elm_toolbar_item_cursor_get()
15091 * @see elm_toolbar_item_cursor_unset()
15095 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15098 * Get the type of mouse pointer/cursor decoration set to be shown,
15099 * when the mouse pointer is over the given toolbar widget item
15101 * @param item toolbar item with custom cursor set
15102 * @return the cursor type's name or @c NULL, if no custom cursors
15103 * were set to @p item (and on errors)
15105 * @see elm_object_cursor_get()
15106 * @see elm_toolbar_item_cursor_set()
15107 * @see elm_toolbar_item_cursor_unset()
15111 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15114 * Unset any custom mouse pointer/cursor decoration set to be
15115 * shown, when the mouse pointer is over the given toolbar widget
15116 * item, thus making it show the @b default cursor again.
15118 * @param item a toolbar item
15120 * Use this call to undo any custom settings on this item's cursor
15121 * decoration, bringing it back to defaults (no custom style set).
15123 * @see elm_object_cursor_unset()
15124 * @see elm_toolbar_item_cursor_set()
15128 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15131 * Set a different @b style for a given custom cursor set for a
15134 * @param item toolbar item with custom cursor set
15135 * @param style the <b>theme style</b> to use (e.g. @c "default",
15136 * @c "transparent", etc)
15138 * This function only makes sense when one is using custom mouse
15139 * cursor decorations <b>defined in a theme file</b>, which can have,
15140 * given a cursor name/type, <b>alternate styles</b> on it. It
15141 * works analogously as elm_object_cursor_style_set(), but here
15142 * applyed only to toolbar item objects.
15144 * @warning Before you set a cursor style you should have definen a
15145 * custom cursor previously on the item, with
15146 * elm_toolbar_item_cursor_set()
15148 * @see elm_toolbar_item_cursor_engine_only_set()
15149 * @see elm_toolbar_item_cursor_style_get()
15153 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15156 * Get the current @b style set for a given toolbar item's custom
15159 * @param item toolbar item with custom cursor set.
15160 * @return style the cursor style in use. If the object does not
15161 * have a cursor set, then @c NULL is returned.
15163 * @see elm_toolbar_item_cursor_style_set() for more details
15167 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15170 * Set if the (custom)cursor for a given toolbar item should be
15171 * searched in its theme, also, or should only rely on the
15172 * rendering engine.
15174 * @param item item with custom (custom) cursor already set on
15175 * @param engine_only Use @c EINA_TRUE to have cursors looked for
15176 * only on those provided by the rendering engine, @c EINA_FALSE to
15177 * have them searched on the widget's theme, as well.
15179 * @note This call is of use only if you've set a custom cursor
15180 * for toolbar items, with elm_toolbar_item_cursor_set().
15182 * @note By default, cursors will only be looked for between those
15183 * provided by the rendering engine.
15187 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15190 * Get if the (custom) cursor for a given toolbar item is being
15191 * searched in its theme, also, or is only relying on the rendering
15194 * @param item a toolbar item
15195 * @return @c EINA_TRUE, if cursors are being looked for only on
15196 * those provided by the rendering engine, @c EINA_FALSE if they
15197 * are being searched on the widget's theme, as well.
15199 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
15203 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15206 * Change a toolbar's orientation
15207 * @param obj The toolbar object
15208 * @param vertical If @c EINA_TRUE, the toolbar is vertical
15209 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15211 * @deprecated use elm_toolbar_horizontal_set() instead.
15213 EINA_DEPRECATED EAPI void elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
15216 * Change a toolbar's orientation
15217 * @param obj The toolbar object
15218 * @param horizontal If @c EINA_TRUE, the toolbar is horizontal
15219 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15222 EAPI void elm_toolbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15225 * Get a toolbar's orientation
15226 * @param obj The toolbar object
15227 * @return If @c EINA_TRUE, the toolbar is vertical
15228 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15230 * @deprecated use elm_toolbar_horizontal_get() instead.
15232 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_orientation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15235 * Get a toolbar's orientation
15236 * @param obj The toolbar object
15237 * @return If @c EINA_TRUE, the toolbar is horizontal
15238 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15241 EAPI Eina_Bool elm_toolbar_horizontal_get(const Evas_Object *obj);
15247 EAPI double elm_tooltip_delay_get(void);
15248 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
15249 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
15250 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
15251 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
15252 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);
15253 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15254 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15255 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15258 * @defgroup Cursors Cursors
15260 * The Elementary cursor is an internal smart object used to
15261 * customize the mouse cursor displayed over objects (or
15262 * widgets). In the most common scenario, the cursor decoration
15263 * comes from the graphical @b engine Elementary is running
15264 * on. Those engines may provide different decorations for cursors,
15265 * and Elementary provides functions to choose them (think of X11
15266 * cursors, as an example).
15268 * There's also the possibility of, besides using engine provided
15269 * cursors, also use ones coming from Edje theming files. Both
15270 * globally and per widget, Elementary makes it possible for one to
15271 * make the cursors lookup to be held on engines only or on
15272 * Elementary's theme file, too. To set cursor's hot spot,
15273 * two data items should be added to cursor's theme: "hot_x" and
15274 * "hot_y", that are the offset from upper-left corner of the cursor
15275 * (coordinates 0,0).
15281 * Set the cursor to be shown when mouse is over the object
15283 * Set the cursor that will be displayed when mouse is over the
15284 * object. The object can have only one cursor set to it, so if
15285 * this function is called twice for an object, the previous set
15287 * If using X cursors, a definition of all the valid cursor names
15288 * is listed on Elementary_Cursors.h. If an invalid name is set
15289 * the default cursor will be used.
15291 * @param obj the object being set a cursor.
15292 * @param cursor the cursor name to be used.
15296 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
15299 * Get the cursor to be shown when mouse is over the object
15301 * @param obj an object with cursor already set.
15302 * @return the cursor name.
15306 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15309 * Unset cursor for object
15311 * Unset cursor for object, and set the cursor to default if the mouse
15312 * was over this object.
15314 * @param obj Target object
15315 * @see elm_object_cursor_set()
15319 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15322 * Sets a different style for this object cursor.
15324 * @note before you set a style you should define a cursor with
15325 * elm_object_cursor_set()
15327 * @param obj an object with cursor already set.
15328 * @param style the theme style to use (default, transparent, ...)
15332 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15335 * Get the style for this object cursor.
15337 * @param obj an object with cursor already set.
15338 * @return style the theme style in use, defaults to "default". If the
15339 * object does not have a cursor set, then NULL is returned.
15343 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15346 * Set if the cursor set should be searched on the theme or should use
15347 * the provided by the engine, only.
15349 * @note before you set if should look on theme you should define a cursor
15350 * with elm_object_cursor_set(). By default it will only look for cursors
15351 * provided by the engine.
15353 * @param obj an object with cursor already set.
15354 * @param engine_only boolean to define it cursors should be looked only
15355 * between the provided by the engine or searched on widget's theme as well.
15359 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15362 * Get the cursor engine only usage for this object cursor.
15364 * @param obj an object with cursor already set.
15365 * @return engine_only boolean to define it cursors should be
15366 * looked only between the provided by the engine or searched on
15367 * widget's theme as well. If the object does not have a cursor
15368 * set, then EINA_FALSE is returned.
15372 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15375 * Get the configured cursor engine only usage
15377 * This gets the globally configured exclusive usage of engine cursors.
15379 * @return 1 if only engine cursors should be used
15382 EAPI int elm_cursor_engine_only_get(void);
15385 * Set the configured cursor engine only usage
15387 * This sets the globally configured exclusive usage of engine cursors.
15388 * It won't affect cursors set before changing this value.
15390 * @param engine_only If 1 only engine cursors will be enabled, if 0 will
15391 * look for them on theme before.
15392 * @return EINA_TRUE if value is valid and setted (0 or 1)
15395 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
15402 * @defgroup Menu Menu
15404 * @image html img/widget/menu/preview-00.png
15405 * @image latex img/widget/menu/preview-00.eps
15407 * A menu is a list of items displayed above its parent. When the menu is
15408 * showing its parent is darkened. Each item can have a sub-menu. The menu
15409 * object can be used to display a menu on a right click event, in a toolbar,
15412 * Signals that you can add callbacks for are:
15413 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
15414 * event_info is NULL.
15416 * @see @ref tutorial_menu
15419 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
15421 * @brief Add a new menu to the parent
15423 * @param parent The parent object.
15424 * @return The new object or NULL if it cannot be created.
15426 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15428 * @brief Set the parent for the given menu widget
15430 * @param obj The menu object.
15431 * @param parent The new parent.
15433 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15435 * @brief Get the parent for the given menu widget
15437 * @param obj The menu object.
15438 * @return The parent.
15440 * @see elm_menu_parent_set()
15442 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15444 * @brief Move the menu to a new position
15446 * @param obj The menu object.
15447 * @param x The new position.
15448 * @param y The new position.
15450 * Sets the top-left position of the menu to (@p x,@p y).
15452 * @note @p x and @p y coordinates are relative to parent.
15454 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
15456 * @brief Close a opened menu
15458 * @param obj the menu object
15461 * Hides the menu and all it's sub-menus.
15463 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
15465 * @brief Returns a list of @p item's items.
15467 * @param obj The menu object
15468 * @return An Eina_List* of @p item's items
15470 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15472 * @brief Get the Evas_Object of an Elm_Menu_Item
15474 * @param item The menu item object.
15475 * @return The edje object containing the swallowed content
15477 * @warning Don't manipulate this object!
15479 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15481 * @brief Add an item at the end of the given menu widget
15483 * @param obj The menu object.
15484 * @param parent The parent menu item (optional)
15485 * @param icon A icon display on the item. The icon will be destryed by the menu.
15486 * @param label The label of the item.
15487 * @param func Function called when the user select the item.
15488 * @param data Data sent by the callback.
15489 * @return Returns the new item.
15491 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);
15493 * @brief Set the label of a menu item
15495 * @param item The menu item object.
15496 * @param label The label to set for @p item
15498 * @warning Don't use this funcion on items created with
15499 * elm_menu_item_add_object() or elm_menu_item_separator_add().
15501 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
15503 * @brief Get the label of a menu item
15505 * @param item The menu item object.
15506 * @return The label of @p item
15508 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15509 EAPI void elm_menu_item_icon_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
15510 EAPI const char *elm_menu_item_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15511 EAPI const Evas_Object *elm_menu_item_object_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15514 * @brief Set the selected state of @p item.
15516 * @param item The menu item object.
15517 * @param selected The selected/unselected state of the item
15519 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15521 * @brief Get the selected state of @p item.
15523 * @param item The menu item object.
15524 * @return The selected/unselected state of the item
15526 * @see elm_menu_item_selected_set()
15528 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15530 * @brief Set the disabled state of @p item.
15532 * @param item The menu item object.
15533 * @param disabled The enabled/disabled state of the item
15535 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15537 * @brief Get the disabled state of @p item.
15539 * @param item The menu item object.
15540 * @return The enabled/disabled state of the item
15542 * @see elm_menu_item_disabled_set()
15544 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15546 * @brief Add a separator item to menu @p obj under @p parent.
15548 * @param obj The menu object
15549 * @param parent The item to add the separator under
15550 * @return The created item or NULL on failure
15552 * This is item is a @ref Separator.
15554 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
15556 * @brief Returns whether @p item is a separator.
15558 * @param item The item to check
15559 * @return If true, @p item is a separator
15561 * @see elm_menu_item_separator_add()
15563 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15565 * @brief Deletes an item from the menu.
15567 * @param item The item to delete.
15569 * @see elm_menu_item_add()
15571 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15573 * @brief Set the function called when a menu item is deleted.
15575 * @param item The item to set the callback on
15576 * @param func The function called
15578 * @see elm_menu_item_add()
15579 * @see elm_menu_item_del()
15581 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15583 * @brief Returns the data associated with menu item @p item.
15585 * @param item The item
15586 * @return The data associated with @p item or NULL if none was set.
15588 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
15590 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15592 * @brief Sets the data to be associated with menu item @p item.
15594 * @param item The item
15595 * @param data The data to be associated with @p item
15597 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
15599 * @brief Returns a list of @p item's subitems.
15601 * @param item The item
15602 * @return An Eina_List* of @p item's subitems
15604 * @see elm_menu_add()
15606 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15607 EAPI const Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
15608 EAPI const Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
15609 EAPI const Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
15610 EAPI const Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15611 EAPI const Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15618 * @defgroup List List
15619 * @ingroup Elementary
15621 * @image html img/widget/list/preview-00.png
15622 * @image latex img/widget/list/preview-00.eps width=\textwidth
15624 * @image html img/list.png
15625 * @image latex img/list.eps width=\textwidth
15627 * A list widget is a container whose children are displayed vertically or
15628 * horizontally, in order, and can be selected.
15629 * The list can accept only one or multiple items selection. Also has many
15630 * modes of items displaying.
15632 * A list is a very simple type of list widget. For more robust
15633 * lists, @ref Genlist should probably be used.
15635 * Smart callbacks one can listen to:
15636 * - @c "activated" - The user has double-clicked or pressed
15637 * (enter|return|spacebar) on an item. The @c event_info parameter
15638 * is the item that was activated.
15639 * - @c "clicked,double" - The user has double-clicked an item.
15640 * The @c event_info parameter is the item that was double-clicked.
15641 * - "selected" - when the user selected an item
15642 * - "unselected" - when the user unselected an item
15643 * - "longpressed" - an item in the list is long-pressed
15644 * - "edge,top" - the list is scrolled until the top edge
15645 * - "edge,bottom" - the list is scrolled until the bottom edge
15646 * - "edge,left" - the list is scrolled until the left edge
15647 * - "edge,right" - the list is scrolled until the right edge
15648 * - "language,changed" - the program's language changed
15650 * Available styles for it:
15653 * List of examples:
15654 * @li @ref list_example_01
15655 * @li @ref list_example_02
15656 * @li @ref list_example_03
15665 * @enum _Elm_List_Mode
15666 * @typedef Elm_List_Mode
15668 * Set list's resize behavior, transverse axis scroll and
15669 * items cropping. See each mode's description for more details.
15671 * @note Default value is #ELM_LIST_SCROLL.
15673 * Values <b> don't </b> work as bitmask, only one can be choosen.
15675 * @see elm_list_mode_set()
15676 * @see elm_list_mode_get()
15680 typedef enum _Elm_List_Mode
15682 ELM_LIST_COMPRESS = 0, /**< Won't set any of its size hints to inform how a possible container should resize it. Then, if it's not created as a "resize object", it might end with zero dimensions. The list will respect the container's geometry and, if any of its items won't fit into its transverse axis, one won't be able to scroll it in that direction. */
15683 ELM_LIST_SCROLL, /**< Default value. Won't set any of its size hints to inform how a possible container should resize it. Then, if it's not created as a "resize object", it might end with zero dimensions. The list will respect the container's geometry and, if any of its items won't fit into its transverse axis, one will be able to scroll it in that direction (large items will get cropped). */
15684 ELM_LIST_LIMIT, /**< Set a minimun size hint on the list object, so that containers may respect it (and resize itself to fit the child properly). More specifically, a minimum size hint will be set for its transverse axis, so that the @b largest item in that direction fits well. Can have effects bounded by setting the list object's maximum size hints. */
15685 ELM_LIST_EXPAND, /**< Besides setting a minimum size on the transverse axis, just like the previous mode, will set a minimum size on the longitudinal axis too, trying to reserve space to all its children to be visible at a time. Can have effects bounded by setting the list object's maximum size hints. */
15686 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
15689 typedef struct _Elm_List_Item Elm_List_Item; /**< Item of Elm_List. Sub-type of Elm_Widget_Item. Can be created with elm_list_item_append(), elm_list_item_prepend() and functions to add items in relative positions, like elm_list_item_insert_before(), and deleted with elm_list_item_del(). */
15692 * Add a new list widget to the given parent Elementary
15693 * (container) object.
15695 * @param parent The parent object.
15696 * @return a new list widget handle or @c NULL, on errors.
15698 * This function inserts a new list widget on the canvas.
15702 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15707 * @param obj The list object
15709 * @note Call before running show() on the list object.
15710 * @warning If not called, it won't display the list properly.
15713 * li = elm_list_add(win);
15714 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
15715 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
15717 * evas_object_show(li);
15722 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
15725 * Enable or disable multiple items selection on the list object.
15727 * @param obj The list object
15728 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
15731 * Disabled by default. If disabled, the user can select a single item of
15732 * the list each time. Selected items are highlighted on list.
15733 * If enabled, many items can be selected.
15735 * If a selected item is selected again, it will be unselected.
15737 * @see elm_list_multi_select_get()
15741 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
15744 * Get a value whether multiple items selection is enabled or not.
15746 * @see elm_list_multi_select_set() for details.
15748 * @param obj The list object.
15749 * @return @c EINA_TRUE means multiple items selection is enabled.
15750 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
15751 * @c EINA_FALSE is returned.
15755 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15758 * Set which mode to use for the list object.
15760 * @param obj The list object
15761 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
15762 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
15764 * Set list's resize behavior, transverse axis scroll and
15765 * items cropping. See each mode's description for more details.
15767 * @note Default value is #ELM_LIST_SCROLL.
15769 * Only one can be set, if a previous one was set, it will be changed
15770 * by the new mode set. Bitmask won't work as well.
15772 * @see elm_list_mode_get()
15776 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
15779 * Get the mode the list is at.
15781 * @param obj The list object
15782 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
15783 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
15785 * @note see elm_list_mode_set() for more information.
15789 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15792 * Enable or disable horizontal mode on the list object.
15794 * @param obj The list object.
15795 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
15796 * disable it, i.e., to enable vertical mode.
15798 * @note Vertical mode is set by default.
15800 * On horizontal mode items are displayed on list from left to right,
15801 * instead of from top to bottom. Also, the list will scroll horizontally.
15802 * Each item will presents left icon on top and right icon, or end, at
15805 * @see elm_list_horizontal_get()
15809 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15812 * Get a value whether horizontal mode is enabled or not.
15814 * @param obj The list object.
15815 * @return @c EINA_TRUE means horizontal mode selection is enabled.
15816 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
15817 * @c EINA_FALSE is returned.
15819 * @see elm_list_horizontal_set() for details.
15823 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15826 * Enable or disable always select mode on the list object.
15828 * @param obj The list object
15829 * @param always_select @c EINA_TRUE to enable always select mode or
15830 * @c EINA_FALSE to disable it.
15832 * @note Always select mode is disabled by default.
15834 * Default behavior of list items is to only call its callback function
15835 * the first time it's pressed, i.e., when it is selected. If a selected
15836 * item is pressed again, and multi-select is disabled, it won't call
15837 * this function (if multi-select is enabled it will unselect the item).
15839 * If always select is enabled, it will call the callback function
15840 * everytime a item is pressed, so it will call when the item is selected,
15841 * and again when a selected item is pressed.
15843 * @see elm_list_always_select_mode_get()
15844 * @see elm_list_multi_select_set()
15848 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
15851 * Get a value whether always select mode is enabled or not, meaning that
15852 * an item will always call its callback function, even if already selected.
15854 * @param obj The list object
15855 * @return @c EINA_TRUE means horizontal mode selection is enabled.
15856 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
15857 * @c EINA_FALSE is returned.
15859 * @see elm_list_always_select_mode_set() for details.
15863 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15866 * Set bouncing behaviour when the scrolled content reaches an edge.
15868 * Tell the internal scroller object whether it should bounce or not
15869 * when it reaches the respective edges for each axis.
15871 * @param obj The list object
15872 * @param h_bounce Whether to bounce or not in the horizontal axis.
15873 * @param v_bounce Whether to bounce or not in the vertical axis.
15875 * @see elm_scroller_bounce_set()
15879 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
15882 * Get the bouncing behaviour of the internal scroller.
15884 * Get whether the internal scroller should bounce when the edge of each
15885 * axis is reached scrolling.
15887 * @param obj The list object.
15888 * @param h_bounce Pointer where to store the bounce state of the horizontal
15890 * @param v_bounce Pointer where to store the bounce state of the vertical
15893 * @see elm_scroller_bounce_get()
15894 * @see elm_list_bounce_set()
15898 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
15901 * Set the scrollbar policy.
15903 * @param obj The list object
15904 * @param policy_h Horizontal scrollbar policy.
15905 * @param policy_v Vertical scrollbar policy.
15907 * This sets the scrollbar visibility policy for the given scroller.
15908 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
15909 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
15910 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
15911 * This applies respectively for the horizontal and vertical scrollbars.
15913 * The both are disabled by default, i.e., are set to
15914 * #ELM_SCROLLER_POLICY_OFF.
15918 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
15921 * Get the scrollbar policy.
15923 * @see elm_list_scroller_policy_get() for details.
15925 * @param obj The list object.
15926 * @param policy_h Pointer where to store horizontal scrollbar policy.
15927 * @param policy_v Pointer where to store vertical scrollbar policy.
15931 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);
15934 * Append a new item to the list object.
15936 * @param obj The list object.
15937 * @param label The label of the list item.
15938 * @param icon The icon object to use for the left side of the item. An
15939 * icon can be any Evas object, but usually it is an icon created
15940 * with elm_icon_add().
15941 * @param end The icon object to use for the right side of the item. An
15942 * icon can be any Evas object.
15943 * @param func The function to call when the item is clicked.
15944 * @param data The data to associate with the item for related callbacks.
15946 * @return The created item or @c NULL upon failure.
15948 * A new item will be created and appended to the list, i.e., will
15949 * be set as @b last item.
15951 * Items created with this method can be deleted with
15952 * elm_list_item_del().
15954 * Associated @p data can be properly freed when item is deleted if a
15955 * callback function is set with elm_list_item_del_cb_set().
15957 * If a function is passed as argument, it will be called everytime this item
15958 * is selected, i.e., the user clicks over an unselected item.
15959 * If always select is enabled it will call this function every time
15960 * user clicks over an item (already selected or not).
15961 * If such function isn't needed, just passing
15962 * @c NULL as @p func is enough. The same should be done for @p data.
15964 * Simple example (with no function callback or data associated):
15966 * li = elm_list_add(win);
15967 * ic = elm_icon_add(win);
15968 * elm_icon_file_set(ic, "path/to/image", NULL);
15969 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
15970 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
15972 * evas_object_show(li);
15975 * @see elm_list_always_select_mode_set()
15976 * @see elm_list_item_del()
15977 * @see elm_list_item_del_cb_set()
15978 * @see elm_list_clear()
15979 * @see elm_icon_add()
15983 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);
15986 * Prepend a new item to the list object.
15988 * @param obj The list object.
15989 * @param label The label of the list item.
15990 * @param icon The icon object to use for the left side of the item. An
15991 * icon can be any Evas object, but usually it is an icon created
15992 * with elm_icon_add().
15993 * @param end The icon object to use for the right side of the item. An
15994 * icon can be any Evas object.
15995 * @param func The function to call when the item is clicked.
15996 * @param data The data to associate with the item for related callbacks.
15998 * @return The created item or @c NULL upon failure.
16000 * A new item will be created and prepended to the list, i.e., will
16001 * be set as @b first item.
16003 * Items created with this method can be deleted with
16004 * elm_list_item_del().
16006 * Associated @p data can be properly freed when item is deleted if a
16007 * callback function is set with elm_list_item_del_cb_set().
16009 * If a function is passed as argument, it will be called everytime this item
16010 * is selected, i.e., the user clicks over an unselected item.
16011 * If always select is enabled it will call this function every time
16012 * user clicks over an item (already selected or not).
16013 * If such function isn't needed, just passing
16014 * @c NULL as @p func is enough. The same should be done for @p data.
16016 * @see elm_list_item_append() for a simple code example.
16017 * @see elm_list_always_select_mode_set()
16018 * @see elm_list_item_del()
16019 * @see elm_list_item_del_cb_set()
16020 * @see elm_list_clear()
16021 * @see elm_icon_add()
16025 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);
16028 * Insert a new item into the list object before item @p before.
16030 * @param obj The list object.
16031 * @param before The list item to insert before.
16032 * @param label The label of the list item.
16033 * @param icon The icon object to use for the left side of the item. An
16034 * icon can be any Evas object, but usually it is an icon created
16035 * with elm_icon_add().
16036 * @param end The icon object to use for the right side of the item. An
16037 * icon can be any Evas object.
16038 * @param func The function to call when the item is clicked.
16039 * @param data The data to associate with the item for related callbacks.
16041 * @return The created item or @c NULL upon failure.
16043 * A new item will be created and added to the list. Its position in
16044 * this list will be just before item @p before.
16046 * Items created with this method can be deleted with
16047 * elm_list_item_del().
16049 * Associated @p data can be properly freed when item is deleted if a
16050 * callback function is set with elm_list_item_del_cb_set().
16052 * If a function is passed as argument, it will be called everytime this item
16053 * is selected, i.e., the user clicks over an unselected item.
16054 * If always select is enabled it will call this function every time
16055 * user clicks over an item (already selected or not).
16056 * If such function isn't needed, just passing
16057 * @c NULL as @p func is enough. The same should be done for @p data.
16059 * @see elm_list_item_append() for a simple code example.
16060 * @see elm_list_always_select_mode_set()
16061 * @see elm_list_item_del()
16062 * @see elm_list_item_del_cb_set()
16063 * @see elm_list_clear()
16064 * @see elm_icon_add()
16068 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);
16071 * Insert a new item into the list object after item @p after.
16073 * @param obj The list object.
16074 * @param after The list item to insert after.
16075 * @param label The label of the list item.
16076 * @param icon The icon object to use for the left side of the item. An
16077 * icon can be any Evas object, but usually it is an icon created
16078 * with elm_icon_add().
16079 * @param end The icon object to use for the right side of the item. An
16080 * icon can be any Evas object.
16081 * @param func The function to call when the item is clicked.
16082 * @param data The data to associate with the item for related callbacks.
16084 * @return The created item or @c NULL upon failure.
16086 * A new item will be created and added to the list. Its position in
16087 * this list will be just after item @p after.
16089 * Items created with this method can be deleted with
16090 * elm_list_item_del().
16092 * Associated @p data can be properly freed when item is deleted if a
16093 * callback function is set with elm_list_item_del_cb_set().
16095 * If a function is passed as argument, it will be called everytime this item
16096 * is selected, i.e., the user clicks over an unselected item.
16097 * If always select is enabled it will call this function every time
16098 * user clicks over an item (already selected or not).
16099 * If such function isn't needed, just passing
16100 * @c NULL as @p func is enough. The same should be done for @p data.
16102 * @see elm_list_item_append() for a simple code example.
16103 * @see elm_list_always_select_mode_set()
16104 * @see elm_list_item_del()
16105 * @see elm_list_item_del_cb_set()
16106 * @see elm_list_clear()
16107 * @see elm_icon_add()
16111 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);
16114 * Insert a new item into the sorted list object.
16116 * @param obj The list object.
16117 * @param label The label of the list item.
16118 * @param icon The icon object to use for the left side of the item. An
16119 * icon can be any Evas object, but usually it is an icon created
16120 * with elm_icon_add().
16121 * @param end The icon object to use for the right side of the item. An
16122 * icon can be any Evas object.
16123 * @param func The function to call when the item is clicked.
16124 * @param data The data to associate with the item for related callbacks.
16125 * @param cmp_func The comparing function to be used to sort list
16126 * items <b>by #Elm_List_Item item handles</b>. This function will
16127 * receive two items and compare them, returning a non-negative integer
16128 * if the second item should be place after the first, or negative value
16129 * if should be placed before.
16131 * @return The created item or @c NULL upon failure.
16133 * @note This function inserts values into a list object assuming it was
16134 * sorted and the result will be sorted.
16136 * A new item will be created and added to the list. Its position in
16137 * this list will be found comparing the new item with previously inserted
16138 * items using function @p cmp_func.
16140 * Items created with this method can be deleted with
16141 * elm_list_item_del().
16143 * Associated @p data can be properly freed when item is deleted if a
16144 * callback function is set with elm_list_item_del_cb_set().
16146 * If a function is passed as argument, it will be called everytime this item
16147 * is selected, i.e., the user clicks over an unselected item.
16148 * If always select is enabled it will call this function every time
16149 * user clicks over an item (already selected or not).
16150 * If such function isn't needed, just passing
16151 * @c NULL as @p func is enough. The same should be done for @p data.
16153 * @see elm_list_item_append() for a simple code example.
16154 * @see elm_list_always_select_mode_set()
16155 * @see elm_list_item_del()
16156 * @see elm_list_item_del_cb_set()
16157 * @see elm_list_clear()
16158 * @see elm_icon_add()
16162 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);
16165 * Remove all list's items.
16167 * @param obj The list object
16169 * @see elm_list_item_del()
16170 * @see elm_list_item_append()
16174 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16177 * Get a list of all the list items.
16179 * @param obj The list object
16180 * @return An @c Eina_List of list items, #Elm_List_Item,
16181 * or @c NULL on failure.
16183 * @see elm_list_item_append()
16184 * @see elm_list_item_del()
16185 * @see elm_list_clear()
16189 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16192 * Get the selected item.
16194 * @param obj The list object.
16195 * @return The selected list item.
16197 * The selected item can be unselected with function
16198 * elm_list_item_selected_set().
16200 * The selected item always will be highlighted on list.
16202 * @see elm_list_selected_items_get()
16206 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16209 * Return a list of the currently selected list items.
16211 * @param obj The list object.
16212 * @return An @c Eina_List of list items, #Elm_List_Item,
16213 * or @c NULL on failure.
16215 * Multiple items can be selected if multi select is enabled. It can be
16216 * done with elm_list_multi_select_set().
16218 * @see elm_list_selected_item_get()
16219 * @see elm_list_multi_select_set()
16223 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16226 * Set the selected state of an item.
16228 * @param item The list item
16229 * @param selected The selected state
16231 * This sets the selected state of the given item @p it.
16232 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
16234 * If a new item is selected the previosly selected will be unselected,
16235 * unless multiple selection is enabled with elm_list_multi_select_set().
16236 * Previoulsy selected item can be get with function
16237 * elm_list_selected_item_get().
16239 * Selected items will be highlighted.
16241 * @see elm_list_item_selected_get()
16242 * @see elm_list_selected_item_get()
16243 * @see elm_list_multi_select_set()
16247 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16250 * Get whether the @p item is selected or not.
16252 * @param item The list item.
16253 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
16254 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
16256 * @see elm_list_selected_item_set() for details.
16257 * @see elm_list_item_selected_get()
16261 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16264 * Set or unset item as a separator.
16266 * @param it The list item.
16267 * @param setting @c EINA_TRUE to set item @p it as separator or
16268 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
16270 * Items aren't set as separator by default.
16272 * If set as separator it will display separator theme, so won't display
16275 * @see elm_list_item_separator_get()
16279 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
16282 * Get a value whether item is a separator or not.
16284 * @see elm_list_item_separator_set() for details.
16286 * @param it The list item.
16287 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
16288 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
16292 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16295 * Show @p item in the list view.
16297 * @param item The list item to be shown.
16299 * It won't animate list until item is visible. If such behavior is wanted,
16300 * use elm_list_bring_in() intead.
16304 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16307 * Bring in the given item to list view.
16309 * @param item The item.
16311 * This causes list to jump to the given item @p item and show it
16312 * (by scrolling), if it is not fully visible.
16314 * This may use animation to do so and take a period of time.
16316 * If animation isn't wanted, elm_list_item_show() can be used.
16320 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16323 * Delete them item from the list.
16325 * @param item The item of list to be deleted.
16327 * If deleting all list items is required, elm_list_clear()
16328 * should be used instead of getting items list and deleting each one.
16330 * @see elm_list_clear()
16331 * @see elm_list_item_append()
16332 * @see elm_list_item_del_cb_set()
16336 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16339 * Set the function called when a list item is freed.
16341 * @param item The item to set the callback on
16342 * @param func The function called
16344 * If there is a @p func, then it will be called prior item's memory release.
16345 * That will be called with the following arguments:
16347 * @li item's Evas object;
16350 * This way, a data associated to a list item could be properly freed.
16354 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16357 * Get the data associated to the item.
16359 * @param item The list item
16360 * @return The data associated to @p item
16362 * The return value is a pointer to data associated to @p item when it was
16363 * created, with function elm_list_item_append() or similar. If no data
16364 * was passed as argument, it will return @c NULL.
16366 * @see elm_list_item_append()
16370 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16373 * Get the left side icon associated to the item.
16375 * @param item The list item
16376 * @return The left side icon associated to @p item
16378 * The return value is a pointer to the icon associated to @p item when
16380 * created, with function elm_list_item_append() or similar, or later
16381 * with function elm_list_item_icon_set(). If no icon
16382 * was passed as argument, it will return @c NULL.
16384 * @see elm_list_item_append()
16385 * @see elm_list_item_icon_set()
16389 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16392 * Set the left side icon associated to the item.
16394 * @param item The list item
16395 * @param icon The left side icon object to associate with @p item
16397 * The icon object to use at left side of the item. An
16398 * icon can be any Evas object, but usually it is an icon created
16399 * with elm_icon_add().
16401 * Once the icon object is set, a previously set one will be deleted.
16402 * @warning Setting the same icon for two items will cause the icon to
16403 * dissapear from the first item.
16405 * If an icon was passed as argument on item creation, with function
16406 * elm_list_item_append() or similar, it will be already
16407 * associated to the item.
16409 * @see elm_list_item_append()
16410 * @see elm_list_item_icon_get()
16414 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
16417 * Get the right side icon associated to the item.
16419 * @param item The list item
16420 * @return The right side icon associated to @p item
16422 * The return value is a pointer to the icon associated to @p item when
16424 * created, with function elm_list_item_append() or similar, or later
16425 * with function elm_list_item_icon_set(). If no icon
16426 * was passed as argument, it will return @c NULL.
16428 * @see elm_list_item_append()
16429 * @see elm_list_item_icon_set()
16433 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16436 * Set the right side icon associated to the item.
16438 * @param item The list item
16439 * @param end The right side icon object to associate with @p item
16441 * The icon object to use at right side of the item. An
16442 * icon can be any Evas object, but usually it is an icon created
16443 * with elm_icon_add().
16445 * Once the icon object is set, a previously set one will be deleted.
16446 * @warning Setting the same icon for two items will cause the icon to
16447 * dissapear from the first item.
16449 * If an icon was passed as argument on item creation, with function
16450 * elm_list_item_append() or similar, it will be already
16451 * associated to the item.
16453 * @see elm_list_item_append()
16454 * @see elm_list_item_end_get()
16458 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
16459 EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16462 * Gets the base object of the item.
16464 * @param item The list item
16465 * @return The base object associated with @p item
16467 * Base object is the @c Evas_Object that represents that item.
16471 EAPI Evas_Object *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16474 * Get the label of item.
16476 * @param item The item of list.
16477 * @return The label of item.
16479 * The return value is a pointer to the label associated to @p item when
16480 * it was created, with function elm_list_item_append(), or later
16481 * with function elm_list_item_label_set. If no label
16482 * was passed as argument, it will return @c NULL.
16484 * @see elm_list_item_label_set() for more details.
16485 * @see elm_list_item_append()
16489 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16492 * Set the label of item.
16494 * @param item The item of list.
16495 * @param text The label of item.
16497 * The label to be displayed by the item.
16498 * Label will be placed between left and right side icons (if set).
16500 * If a label was passed as argument on item creation, with function
16501 * elm_list_item_append() or similar, it will be already
16502 * displayed by the item.
16504 * @see elm_list_item_label_get()
16505 * @see elm_list_item_append()
16509 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
16513 * Get the item before @p it in list.
16515 * @param it The list item.
16516 * @return The item before @p it, or @c NULL if none or on failure.
16518 * @note If it is the first item, @c NULL will be returned.
16520 * @see elm_list_item_append()
16521 * @see elm_list_items_get()
16525 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16528 * Get the item after @p it in list.
16530 * @param it The list item.
16531 * @return The item after @p it, or @c NULL if none or on failure.
16533 * @note If it is the last item, @c NULL will be returned.
16535 * @see elm_list_item_append()
16536 * @see elm_list_items_get()
16540 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16543 * Sets the disabled/enabled state of a list item.
16545 * @param it The item.
16546 * @param disabled The disabled state.
16548 * A disabled item cannot be selected or unselected. It will also
16549 * change its appearance (generally greyed out). This sets the
16550 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
16555 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
16558 * Get a value whether list item is disabled or not.
16560 * @param it The item.
16561 * @return The disabled state.
16563 * @see elm_list_item_disabled_set() for more details.
16567 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16570 * Set the text to be shown in a given list item's tooltips.
16572 * @param item Target item.
16573 * @param text The text to set in the content.
16575 * Setup the text as tooltip to object. The item can have only one tooltip,
16576 * so any previous tooltip data - set with this function or
16577 * elm_list_item_tooltip_content_cb_set() - is removed.
16579 * @see elm_object_tooltip_text_set() for more details.
16583 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
16587 * @brief Disable size restrictions on an object's tooltip
16588 * @param item The tooltip's anchor object
16589 * @param disable If EINA_TRUE, size restrictions are disabled
16590 * @return EINA_FALSE on failure, EINA_TRUE on success
16592 * This function allows a tooltip to expand beyond its parant window's canvas.
16593 * It will instead be limited only by the size of the display.
16595 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
16597 * @brief Retrieve size restriction state of an object's tooltip
16598 * @param obj The tooltip's anchor object
16599 * @return If EINA_TRUE, size restrictions are disabled
16601 * This function returns whether a tooltip is allowed to expand beyond
16602 * its parant window's canvas.
16603 * It will instead be limited only by the size of the display.
16605 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16608 * Set the content to be shown in the tooltip item.
16610 * Setup the tooltip to item. The item can have only one tooltip,
16611 * so any previous tooltip data is removed. @p func(with @p data) will
16612 * be called every time that need show the tooltip and it should
16613 * return a valid Evas_Object. This object is then managed fully by
16614 * tooltip system and is deleted when the tooltip is gone.
16616 * @param item the list item being attached a tooltip.
16617 * @param func the function used to create the tooltip contents.
16618 * @param data what to provide to @a func as callback data/context.
16619 * @param del_cb called when data is not needed anymore, either when
16620 * another callback replaces @a func, the tooltip is unset with
16621 * elm_list_item_tooltip_unset() or the owner @a item
16622 * dies. This callback receives as the first parameter the
16623 * given @a data, and @c event_info is the item.
16625 * @see elm_object_tooltip_content_cb_set() for more details.
16629 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);
16632 * Unset tooltip from item.
16634 * @param item list item to remove previously set tooltip.
16636 * Remove tooltip from item. The callback provided as del_cb to
16637 * elm_list_item_tooltip_content_cb_set() will be called to notify
16638 * it is not used anymore.
16640 * @see elm_object_tooltip_unset() for more details.
16641 * @see elm_list_item_tooltip_content_cb_set()
16645 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16648 * Sets a different style for this item tooltip.
16650 * @note before you set a style you should define a tooltip with
16651 * elm_list_item_tooltip_content_cb_set() or
16652 * elm_list_item_tooltip_text_set()
16654 * @param item list item with tooltip already set.
16655 * @param style the theme style to use (default, transparent, ...)
16657 * @see elm_object_tooltip_style_set() for more details.
16661 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
16664 * Get the style for this item tooltip.
16666 * @param item list item with tooltip already set.
16667 * @return style the theme style in use, defaults to "default". If the
16668 * object does not have a tooltip set, then NULL is returned.
16670 * @see elm_object_tooltip_style_get() for more details.
16671 * @see elm_list_item_tooltip_style_set()
16675 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16678 * Set the type of mouse pointer/cursor decoration to be shown,
16679 * when the mouse pointer is over the given list widget item
16681 * @param item list item to customize cursor on
16682 * @param cursor the cursor type's name
16684 * This function works analogously as elm_object_cursor_set(), but
16685 * here the cursor's changing area is restricted to the item's
16686 * area, and not the whole widget's. Note that that item cursors
16687 * have precedence over widget cursors, so that a mouse over an
16688 * item with custom cursor set will always show @b that cursor.
16690 * If this function is called twice for an object, a previously set
16691 * cursor will be unset on the second call.
16693 * @see elm_object_cursor_set()
16694 * @see elm_list_item_cursor_get()
16695 * @see elm_list_item_cursor_unset()
16699 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
16702 * Get the type of mouse pointer/cursor decoration set to be shown,
16703 * when the mouse pointer is over the given list widget item
16705 * @param item list item with custom cursor set
16706 * @return the cursor type's name or @c NULL, if no custom cursors
16707 * were set to @p item (and on errors)
16709 * @see elm_object_cursor_get()
16710 * @see elm_list_item_cursor_set()
16711 * @see elm_list_item_cursor_unset()
16715 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16718 * Unset any custom mouse pointer/cursor decoration set to be
16719 * shown, when the mouse pointer is over the given list widget
16720 * item, thus making it show the @b default cursor again.
16722 * @param item a list item
16724 * Use this call to undo any custom settings on this item's cursor
16725 * decoration, bringing it back to defaults (no custom style set).
16727 * @see elm_object_cursor_unset()
16728 * @see elm_list_item_cursor_set()
16732 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16735 * Set a different @b style for a given custom cursor set for a
16738 * @param item list item with custom cursor set
16739 * @param style the <b>theme style</b> to use (e.g. @c "default",
16740 * @c "transparent", etc)
16742 * This function only makes sense when one is using custom mouse
16743 * cursor decorations <b>defined in a theme file</b>, which can have,
16744 * given a cursor name/type, <b>alternate styles</b> on it. It
16745 * works analogously as elm_object_cursor_style_set(), but here
16746 * applyed only to list item objects.
16748 * @warning Before you set a cursor style you should have definen a
16749 * custom cursor previously on the item, with
16750 * elm_list_item_cursor_set()
16752 * @see elm_list_item_cursor_engine_only_set()
16753 * @see elm_list_item_cursor_style_get()
16757 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
16760 * Get the current @b style set for a given list item's custom
16763 * @param item list item with custom cursor set.
16764 * @return style the cursor style in use. If the object does not
16765 * have a cursor set, then @c NULL is returned.
16767 * @see elm_list_item_cursor_style_set() for more details
16771 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16774 * Set if the (custom)cursor for a given list item should be
16775 * searched in its theme, also, or should only rely on the
16776 * rendering engine.
16778 * @param item item with custom (custom) cursor already set on
16779 * @param engine_only Use @c EINA_TRUE to have cursors looked for
16780 * only on those provided by the rendering engine, @c EINA_FALSE to
16781 * have them searched on the widget's theme, as well.
16783 * @note This call is of use only if you've set a custom cursor
16784 * for list items, with elm_list_item_cursor_set().
16786 * @note By default, cursors will only be looked for between those
16787 * provided by the rendering engine.
16791 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
16794 * Get if the (custom) cursor for a given list item is being
16795 * searched in its theme, also, or is only relying on the rendering
16798 * @param item a list item
16799 * @return @c EINA_TRUE, if cursors are being looked for only on
16800 * those provided by the rendering engine, @c EINA_FALSE if they
16801 * are being searched on the widget's theme, as well.
16803 * @see elm_list_item_cursor_engine_only_set(), for more details
16807 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16814 * @defgroup Slider Slider
16815 * @ingroup Elementary
16817 * @image html img/widget/slider/preview-00.png
16818 * @image latex img/widget/slider/preview-00.eps width=\textwidth
16820 * The slider adds a dragable āsliderā widget for selecting the value of
16821 * something within a range.
16823 * A slider can be horizontal or vertical. It can contain an Icon and has a
16824 * primary label as well as a units label (that is formatted with floating
16825 * point values and thus accepts a printf-style format string, like
16826 * ā%1.2f unitsā. There is also an indicator string that may be somewhere
16827 * else (like on the slider itself) that also accepts a format string like
16828 * units. Label, Icon Unit and Indicator strings/objects are optional.
16830 * A slider may be inverted which means values invert, with high vales being
16831 * on the left or top and low values on the right or bottom (as opposed to
16832 * normally being low on the left or top and high on the bottom and right).
16834 * The slider should have its minimum and maximum values set by the
16835 * application with elm_slider_min_max_set() and value should also be set by
16836 * the application before use with elm_slider_value_set(). The span of the
16837 * slider is its length (horizontally or vertically). This will be scaled by
16838 * the object or applications scaling factor. At any point code can query the
16839 * slider for its value with elm_slider_value_get().
16841 * Smart callbacks one can listen to:
16842 * - "changed" - Whenever the slider value is changed by the user.
16843 * - "slider,drag,start" - dragging the slider indicator around has started.
16844 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
16845 * - "delay,changed" - A short time after the value is changed by the user.
16846 * This will be called only when the user stops dragging for
16847 * a very short period or when they release their
16848 * finger/mouse, so it avoids possibly expensive reactions to
16849 * the value change.
16851 * Available styles for it:
16854 * Default contents parts of the slider widget that you can use for are:
16855 * @li "elm.swallow.icon" - A icon of the slider
16856 * @li "elm.swallow.end" - A end part content of the slider
16858 * Here is an example on its usage:
16859 * @li @ref slider_example
16862 #define ELM_SLIDER_CONTENT_ICON "elm.swallow.icon"
16863 #define ELM_SLIDER_CONTENT_END "elm.swallow.end"
16866 * @addtogroup Slider
16871 * Add a new slider widget to the given parent Elementary
16872 * (container) object.
16874 * @param parent The parent object.
16875 * @return a new slider widget handle or @c NULL, on errors.
16877 * This function inserts a new slider widget on the canvas.
16881 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16884 * Set the label of a given slider widget
16886 * @param obj The progress bar object
16887 * @param label The text label string, in UTF-8
16890 * @deprecated use elm_object_text_set() instead.
16892 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
16895 * Get the label of a given slider widget
16897 * @param obj The progressbar object
16898 * @return The text label string, in UTF-8
16901 * @deprecated use elm_object_text_get() instead.
16903 EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16906 * Set the icon object of the slider object.
16908 * @param obj The slider object.
16909 * @param icon The icon object.
16911 * On horizontal mode, icon is placed at left, and on vertical mode,
16914 * @note Once the icon object is set, a previously set one will be deleted.
16915 * If you want to keep that old content object, use the
16916 * elm_slider_icon_unset() function.
16918 * @warning If the object being set does not have minimum size hints set,
16919 * it won't get properly displayed.
16922 * @deprecated use elm_object_content_set() instead.
16924 EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
16927 * Unset an icon set on a given slider widget.
16929 * @param obj The slider object.
16930 * @return The icon object that was being used, if any was set, or
16931 * @c NULL, otherwise (and on errors).
16933 * On horizontal mode, icon is placed at left, and on vertical mode,
16936 * This call will unparent and return the icon object which was set
16937 * for this widget, previously, on success.
16939 * @see elm_slider_icon_set() for more details
16940 * @see elm_slider_icon_get()
16941 * @deprecated use elm_object_content_unset() instead.
16945 EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
16948 * Retrieve the icon object set for a given slider widget.
16950 * @param obj The slider object.
16951 * @return The icon object's handle, if @p obj had one set, or @c NULL,
16952 * otherwise (and on errors).
16954 * On horizontal mode, icon is placed at left, and on vertical mode,
16957 * @see elm_slider_icon_set() for more details
16958 * @see elm_slider_icon_unset()
16962 EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16965 * Set the end object of the slider object.
16967 * @param obj The slider object.
16968 * @param end The end object.
16970 * On horizontal mode, end is placed at left, and on vertical mode,
16971 * placed at bottom.
16973 * @note Once the icon object is set, a previously set one will be deleted.
16974 * If you want to keep that old content object, use the
16975 * elm_slider_end_unset() function.
16977 * @warning If the object being set does not have minimum size hints set,
16978 * it won't get properly displayed.
16982 EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
16985 * Unset an end object set on a given slider widget.
16987 * @param obj The slider object.
16988 * @return The end object that was being used, if any was set, or
16989 * @c NULL, otherwise (and on errors).
16991 * On horizontal mode, end is placed at left, and on vertical mode,
16992 * placed at bottom.
16994 * This call will unparent and return the icon object which was set
16995 * for this widget, previously, on success.
16997 * @see elm_slider_end_set() for more details.
16998 * @see elm_slider_end_get()
17002 EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17005 * Retrieve the end object set for a given slider widget.
17007 * @param obj The slider object.
17008 * @return The end object's handle, if @p obj had one set, or @c NULL,
17009 * otherwise (and on errors).
17011 * On horizontal mode, icon is placed at right, and on vertical mode,
17012 * placed at bottom.
17014 * @see elm_slider_end_set() for more details.
17015 * @see elm_slider_end_unset()
17019 EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17022 * Set the (exact) length of the bar region of a given slider widget.
17024 * @param obj The slider object.
17025 * @param size The length of the slider's bar region.
17027 * This sets the minimum width (when in horizontal mode) or height
17028 * (when in vertical mode) of the actual bar area of the slider
17029 * @p obj. This in turn affects the object's minimum size. Use
17030 * this when you're not setting other size hints expanding on the
17031 * given direction (like weight and alignment hints) and you would
17032 * like it to have a specific size.
17034 * @note Icon, end, label, indicator and unit text around @p obj
17035 * will require their
17036 * own space, which will make @p obj to require more the @p size,
17039 * @see elm_slider_span_size_get()
17043 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17046 * Get the length set for the bar region of a given slider widget
17048 * @param obj The slider object.
17049 * @return The length of the slider's bar region.
17051 * If that size was not set previously, with
17052 * elm_slider_span_size_set(), this call will return @c 0.
17056 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17059 * Set the format string for the unit label.
17061 * @param obj The slider object.
17062 * @param format The format string for the unit display.
17064 * Unit label is displayed all the time, if set, after slider's bar.
17065 * In horizontal mode, at right and in vertical mode, at bottom.
17067 * If @c NULL, unit label won't be visible. If not it sets the format
17068 * string for the label text. To the label text is provided a floating point
17069 * value, so the label text can display up to 1 floating point value.
17070 * Note that this is optional.
17072 * Use a format string such as "%1.2f meters" for example, and it will
17073 * display values like: "3.14 meters" for a value equal to 3.14159.
17075 * Default is unit label disabled.
17077 * @see elm_slider_indicator_format_get()
17081 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17084 * Get the unit label format of the slider.
17086 * @param obj The slider object.
17087 * @return The unit label format string in UTF-8.
17089 * Unit label is displayed all the time, if set, after slider's bar.
17090 * In horizontal mode, at right and in vertical mode, at bottom.
17092 * @see elm_slider_unit_format_set() for more
17093 * information on how this works.
17097 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17100 * Set the format string for the indicator label.
17102 * @param obj The slider object.
17103 * @param indicator The format string for the indicator display.
17105 * The slider may display its value somewhere else then unit label,
17106 * for example, above the slider knob that is dragged around. This function
17107 * sets the format string used for this.
17109 * If @c NULL, indicator label won't be visible. If not it sets the format
17110 * string for the label text. To the label text is provided a floating point
17111 * value, so the label text can display up to 1 floating point value.
17112 * Note that this is optional.
17114 * Use a format string such as "%1.2f meters" for example, and it will
17115 * display values like: "3.14 meters" for a value equal to 3.14159.
17117 * Default is indicator label disabled.
17119 * @see elm_slider_indicator_format_get()
17123 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
17126 * Get the indicator label format of the slider.
17128 * @param obj The slider object.
17129 * @return The indicator label format string in UTF-8.
17131 * The slider may display its value somewhere else then unit label,
17132 * for example, above the slider knob that is dragged around. This function
17133 * gets the format string used for this.
17135 * @see elm_slider_indicator_format_set() for more
17136 * information on how this works.
17140 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17143 * Set the format function pointer for the indicator label
17145 * @param obj The slider object.
17146 * @param func The indicator format function.
17147 * @param free_func The freeing function for the format string.
17149 * Set the callback function to format the indicator string.
17151 * @see elm_slider_indicator_format_set() for more info on how this works.
17155 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);
17158 * Set the format function pointer for the units label
17160 * @param obj The slider object.
17161 * @param func The units format function.
17162 * @param free_func The freeing function for the format string.
17164 * Set the callback function to format the indicator string.
17166 * @see elm_slider_units_format_set() for more info on how this works.
17170 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);
17173 * Set the orientation of a given slider widget.
17175 * @param obj The slider object.
17176 * @param horizontal Use @c EINA_TRUE to make @p obj to be
17177 * @b horizontal, @c EINA_FALSE to make it @b vertical.
17179 * Use this function to change how your slider is to be
17180 * disposed: vertically or horizontally.
17182 * By default it's displayed horizontally.
17184 * @see elm_slider_horizontal_get()
17188 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17191 * Retrieve the orientation of a given slider widget
17193 * @param obj The slider object.
17194 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17195 * @c EINA_FALSE if it's @b vertical (and on errors).
17197 * @see elm_slider_horizontal_set() for more details.
17201 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17204 * Set the minimum and maximum values for the slider.
17206 * @param obj The slider object.
17207 * @param min The minimum value.
17208 * @param max The maximum value.
17210 * Define the allowed range of values to be selected by the user.
17212 * If actual value is less than @p min, it will be updated to @p min. If it
17213 * is bigger then @p max, will be updated to @p max. Actual value can be
17214 * get with elm_slider_value_get().
17216 * By default, min is equal to 0.0, and max is equal to 1.0.
17218 * @warning Maximum must be greater than minimum, otherwise behavior
17221 * @see elm_slider_min_max_get()
17225 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17228 * Get the minimum and maximum values of the slider.
17230 * @param obj The slider object.
17231 * @param min Pointer where to store the minimum value.
17232 * @param max Pointer where to store the maximum value.
17234 * @note If only one value is needed, the other pointer can be passed
17237 * @see elm_slider_min_max_set() for details.
17241 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17244 * Set the value the slider displays.
17246 * @param obj The slider object.
17247 * @param val The value to be displayed.
17249 * Value will be presented on the unit label following format specified with
17250 * elm_slider_unit_format_set() and on indicator with
17251 * elm_slider_indicator_format_set().
17253 * @warning The value must to be between min and max values. This values
17254 * are set by elm_slider_min_max_set().
17256 * @see elm_slider_value_get()
17257 * @see elm_slider_unit_format_set()
17258 * @see elm_slider_indicator_format_set()
17259 * @see elm_slider_min_max_set()
17263 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17266 * Get the value displayed by the spinner.
17268 * @param obj The spinner object.
17269 * @return The value displayed.
17271 * @see elm_spinner_value_set() for details.
17275 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17278 * Invert a given slider widget's displaying values order
17280 * @param obj The slider object.
17281 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17282 * @c EINA_FALSE to bring it back to default, non-inverted values.
17284 * A slider may be @b inverted, in which state it gets its
17285 * values inverted, with high vales being on the left or top and
17286 * low values on the right or bottom, as opposed to normally have
17287 * the low values on the former and high values on the latter,
17288 * respectively, for horizontal and vertical modes.
17290 * @see elm_slider_inverted_get()
17294 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
17297 * Get whether a given slider widget's displaying values are
17300 * @param obj The slider object.
17301 * @return @c EINA_TRUE, if @p obj has inverted values,
17302 * @c EINA_FALSE otherwise (and on errors).
17304 * @see elm_slider_inverted_set() for more details.
17308 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17311 * Set whether to enlarge slider indicator (augmented knob) or not.
17313 * @param obj The slider object.
17314 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
17315 * let the knob always at default size.
17317 * By default, indicator will be bigger while dragged by the user.
17319 * @warning It won't display values set with
17320 * elm_slider_indicator_format_set() if you disable indicator.
17324 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
17327 * Get whether a given slider widget's enlarging indicator or not.
17329 * @param obj The slider object.
17330 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
17331 * @c EINA_FALSE otherwise (and on errors).
17333 * @see elm_slider_indicator_show_set() for details.
17337 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17346 * @addtogroup Actionslider Actionslider
17348 * A actionslider is a switcher for 2 or 3 labels with customizable magnet
17349 * properties. The indicator is the element the user drags to choose a label.
17350 * When the position is set with magnet, when released the indicator will be
17351 * moved to it if it's nearest the magnetized position.
17353 * @note By default all positions are set as enabled.
17355 * Signals that you can add callbacks for are:
17357 * "selected" - when user selects an enabled position (the label is passed
17360 * "pos_changed" - when the indicator reaches any of the positions("left",
17361 * "right" or "center").
17363 * See an example of actionslider usage @ref actionslider_example_page "here"
17367 typedef enum _Elm_Actionslider_Indicator_Pos
17369 ELM_ACTIONSLIDER_INDICATOR_NONE,
17370 ELM_ACTIONSLIDER_INDICATOR_LEFT,
17371 ELM_ACTIONSLIDER_INDICATOR_RIGHT,
17372 ELM_ACTIONSLIDER_INDICATOR_CENTER
17373 } Elm_Actionslider_Indicator_Pos;
17375 typedef enum _Elm_Actionslider_Magnet_Pos
17377 ELM_ACTIONSLIDER_MAGNET_NONE = 0,
17378 ELM_ACTIONSLIDER_MAGNET_LEFT = 1 << 0,
17379 ELM_ACTIONSLIDER_MAGNET_CENTER = 1 << 1,
17380 ELM_ACTIONSLIDER_MAGNET_RIGHT= 1 << 2,
17381 ELM_ACTIONSLIDER_MAGNET_ALL = (1 << 3) -1,
17382 ELM_ACTIONSLIDER_MAGNET_BOTH = (1 << 3)
17383 } Elm_Actionslider_Magnet_Pos;
17385 typedef enum _Elm_Actionslider_Label_Pos
17387 ELM_ACTIONSLIDER_LABEL_LEFT,
17388 ELM_ACTIONSLIDER_LABEL_RIGHT,
17389 ELM_ACTIONSLIDER_LABEL_CENTER,
17390 ELM_ACTIONSLIDER_LABEL_BUTTON
17391 } Elm_Actionslider_Label_Pos;
17393 /* smart callbacks called:
17394 * "indicator,position" - when a button reaches to the special position like "left", "right" and "center".
17398 * Add a new actionslider to the parent.
17400 * @param parent The parent object
17401 * @return The new actionslider object or NULL if it cannot be created
17403 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17406 * Set actionslider label.
17408 * @param[in] obj The actionslider object
17409 * @param[in] pos The position of the label.
17410 * (ELM_ACTIONSLIDER_LABEL_LEFT, ELM_ACTIONSLIDER_LABEL_RIGHT)
17411 * @param label The label which is going to be set.
17413 EAPI void elm_actionslider_label_set(Evas_Object *obj, Elm_Actionslider_Label_Pos pos, const char *label) EINA_ARG_NONNULL(1);
17415 * Get actionslider labels.
17417 * @param obj The actionslider object
17418 * @param left_label A char** to place the left_label of @p obj into.
17419 * @param center_label A char** to place the center_label of @p obj into.
17420 * @param right_label A char** to place the right_label of @p obj into.
17422 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);
17424 * Get actionslider selected label.
17426 * @param obj The actionslider object
17427 * @return The selected label
17429 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17431 * Set actionslider indicator position.
17433 * @param obj The actionslider object.
17434 * @param pos The position of the indicator.
17436 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Indicator_Pos pos) EINA_ARG_NONNULL(1);
17438 * Get actionslider indicator position.
17440 * @param obj The actionslider object.
17441 * @return The position of the indicator.
17443 EAPI Elm_Actionslider_Indicator_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17445 * Set actionslider magnet position. To make multiple positions magnets @c or
17446 * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT)
17448 * @param obj The actionslider object.
17449 * @param pos Bit mask indicating the magnet positions.
17451 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
17453 * Get actionslider magnet position.
17455 * @param obj The actionslider object.
17456 * @return The positions with magnet property.
17458 EAPI Elm_Actionslider_Magnet_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17460 * Set actionslider enabled position. To set multiple positions as enabled @c or
17461 * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT).
17463 * @note All the positions are enabled by default.
17465 * @param obj The actionslider object.
17466 * @param pos Bit mask indicating the enabled positions.
17468 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
17470 * Get actionslider enabled position.
17472 * @param obj The actionslider object.
17473 * @return The enabled positions.
17475 EAPI Elm_Actionslider_Magnet_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17477 * Set the label used on the indicator.
17479 * @param obj The actionslider object
17480 * @param label The label to be set on the indicator.
17481 * @deprecated use elm_object_text_set() instead.
17483 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17485 * Get the label used on the indicator object.
17487 * @param obj The actionslider object
17488 * @return The indicator label
17489 * @deprecated use elm_object_text_get() instead.
17491 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
17494 * Hold actionslider object movement.
17496 * @param[in] obj The actionslider object
17497 * @param[in] flag Actionslider hold/release
17498 * (EINA_TURE = hold/EIN_FALSE = release)
17500 * @ingroup Actionslider
17502 EAPI void elm_actionslider_hold(Evas_Object *obj, Eina_Bool flag) EINA_ARG_NONNULL(1);
17510 * @defgroup Genlist Genlist
17512 * @image html img/widget/genlist/preview-00.png
17513 * @image latex img/widget/genlist/preview-00.eps
17514 * @image html img/genlist.png
17515 * @image latex img/genlist.eps
17517 * This widget aims to have more expansive list than the simple list in
17518 * Elementary that could have more flexible items and allow many more entries
17519 * while still being fast and low on memory usage. At the same time it was
17520 * also made to be able to do tree structures. But the price to pay is more
17521 * complexity when it comes to usage. If all you want is a simple list with
17522 * icons and a single label, use the normal @ref List object.
17524 * Genlist has a fairly large API, mostly because it's relatively complex,
17525 * trying to be both expansive, powerful and efficient. First we will begin
17526 * an overview on the theory behind genlist.
17528 * @section Genlist_Item_Class Genlist item classes - creating items
17530 * In order to have the ability to add and delete items on the fly, genlist
17531 * implements a class (callback) system where the application provides a
17532 * structure with information about that type of item (genlist may contain
17533 * multiple different items with different classes, states and styles).
17534 * Genlist will call the functions in this struct (methods) when an item is
17535 * "realized" (i.e., created dynamically, while the user is scrolling the
17536 * grid). All objects will simply be deleted when no longer needed with
17537 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
17538 * following members:
17539 * - @c item_style - This is a constant string and simply defines the name
17540 * of the item style. It @b must be specified and the default should be @c
17543 * - @c func - A struct with pointers to functions that will be called when
17544 * an item is going to be actually created. All of them receive a @c data
17545 * parameter that will point to the same data passed to
17546 * elm_genlist_item_append() and related item creation functions, and a @c
17547 * obj parameter that points to the genlist object itself.
17549 * The function pointers inside @c func are @c label_get, @c icon_get, @c
17550 * state_get and @c del. The 3 first functions also receive a @c part
17551 * parameter described below. A brief description of these functions follows:
17553 * - @c label_get - The @c part parameter is the name string of one of the
17554 * existing text parts in the Edje group implementing the item's theme.
17555 * This function @b must return a strdup'()ed string, as the caller will
17556 * free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
17557 * - @c content_get - The @c part parameter is the name string of one of the
17558 * existing (content) swallow parts in the Edje group implementing the item's
17559 * theme. It must return @c NULL, when no content is desired, or a valid
17560 * object handle, otherwise. The object will be deleted by the genlist on
17561 * its deletion or when the item is "unrealized". See
17562 * #Elm_Genlist_Item_Icon_Get_Cb.
17563 * - @c func.state_get - The @c part parameter is the name string of one of
17564 * the state parts in the Edje group implementing the item's theme. Return
17565 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
17566 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
17567 * and @c "elm" as "emission" and "source" arguments, respectively, when
17568 * the state is true (the default is false), where @c XXX is the name of
17569 * the (state) part. See #Elm_Genlist_Item_State_Get_Cb.
17570 * - @c func.del - This is intended for use when genlist items are deleted,
17571 * so any data attached to the item (e.g. its data parameter on creation)
17572 * can be deleted. See #Elm_Genlist_Item_Del_Cb.
17574 * available item styles:
17576 * - default_style - The text part is a textblock
17578 * @image html img/widget/genlist/preview-04.png
17579 * @image latex img/widget/genlist/preview-04.eps
17583 * @image html img/widget/genlist/preview-01.png
17584 * @image latex img/widget/genlist/preview-01.eps
17586 * - icon_top_text_bottom
17588 * @image html img/widget/genlist/preview-02.png
17589 * @image latex img/widget/genlist/preview-02.eps
17593 * @image html img/widget/genlist/preview-03.png
17594 * @image latex img/widget/genlist/preview-03.eps
17596 * @section Genlist_Items Structure of items
17598 * An item in a genlist can have 0 or more text labels (they can be regular
17599 * text or textblock Evas objects - that's up to the style to determine), 0
17600 * or more contents (which are simply objects swallowed into the genlist item's
17601 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
17602 * behavior left to the user to define. The Edje part names for each of
17603 * these properties will be looked up, in the theme file for the genlist,
17604 * under the Edje (string) data items named @c "labels", @c "contents" and @c
17605 * "states", respectively. For each of those properties, if more than one
17606 * part is provided, they must have names listed separated by spaces in the
17607 * data fields. For the default genlist item theme, we have @b one label
17608 * part (@c "elm.text"), @b two content parts (@c "elm.swalllow.icon" and @c
17609 * "elm.swallow.end") and @b no state parts.
17611 * A genlist item may be at one of several styles. Elementary provides one
17612 * by default - "default", but this can be extended by system or application
17613 * custom themes/overlays/extensions (see @ref Theme "themes" for more
17616 * @section Genlist_Manipulation Editing and Navigating
17618 * Items can be added by several calls. All of them return a @ref
17619 * Elm_Genlist_Item handle that is an internal member inside the genlist.
17620 * They all take a data parameter that is meant to be used for a handle to
17621 * the applications internal data (eg the struct with the original item
17622 * data). The parent parameter is the parent genlist item this belongs to if
17623 * it is a tree or an indexed group, and NULL if there is no parent. The
17624 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
17625 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
17626 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
17627 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
17628 * is set then this item is group index item that is displayed at the top
17629 * until the next group comes. The func parameter is a convenience callback
17630 * that is called when the item is selected and the data parameter will be
17631 * the func_data parameter, obj be the genlist object and event_info will be
17632 * the genlist item.
17634 * elm_genlist_item_append() adds an item to the end of the list, or if
17635 * there is a parent, to the end of all the child items of the parent.
17636 * elm_genlist_item_prepend() is the same but adds to the beginning of
17637 * the list or children list. elm_genlist_item_insert_before() inserts at
17638 * item before another item and elm_genlist_item_insert_after() inserts after
17639 * the indicated item.
17641 * The application can clear the list with elm_genlist_clear() which deletes
17642 * all the items in the list and elm_genlist_item_del() will delete a specific
17643 * item. elm_genlist_item_subitems_clear() will clear all items that are
17644 * children of the indicated parent item.
17646 * To help inspect list items you can jump to the item at the top of the list
17647 * with elm_genlist_first_item_get() which will return the item pointer, and
17648 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
17649 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
17650 * and previous items respectively relative to the indicated item. Using
17651 * these calls you can walk the entire item list/tree. Note that as a tree
17652 * the items are flattened in the list, so elm_genlist_item_parent_get() will
17653 * let you know which item is the parent (and thus know how to skip them if
17656 * @section Genlist_Muti_Selection Multi-selection
17658 * If the application wants multiple items to be able to be selected,
17659 * elm_genlist_multi_select_set() can enable this. If the list is
17660 * single-selection only (the default), then elm_genlist_selected_item_get()
17661 * will return the selected item, if any, or NULL I none is selected. If the
17662 * list is multi-select then elm_genlist_selected_items_get() will return a
17663 * list (that is only valid as long as no items are modified (added, deleted,
17664 * selected or unselected)).
17666 * @section Genlist_Usage_Hints Usage hints
17668 * There are also convenience functions. elm_genlist_item_genlist_get() will
17669 * return the genlist object the item belongs to. elm_genlist_item_show()
17670 * will make the scroller scroll to show that specific item so its visible.
17671 * elm_genlist_item_data_get() returns the data pointer set by the item
17672 * creation functions.
17674 * If an item changes (state of boolean changes, label or contents change),
17675 * then use elm_genlist_item_update() to have genlist update the item with
17676 * the new state. Genlist will re-realize the item thus call the functions
17677 * in the _Elm_Genlist_Item_Class for that item.
17679 * To programmatically (un)select an item use elm_genlist_item_selected_set().
17680 * To get its selected state use elm_genlist_item_selected_get(). Similarly
17681 * to expand/contract an item and get its expanded state, use
17682 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
17683 * again to make an item disabled (unable to be selected and appear
17684 * differently) use elm_genlist_item_disabled_set() to set this and
17685 * elm_genlist_item_disabled_get() to get the disabled state.
17687 * In general to indicate how the genlist should expand items horizontally to
17688 * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
17689 * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
17690 * mode means that if items are too wide to fit, the scroller will scroll
17691 * horizontally. Otherwise items are expanded to fill the width of the
17692 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
17693 * to the viewport width and limited to that size. This can be combined with
17694 * a different style that uses edjes' ellipsis feature (cutting text off like
17697 * Items will only call their selection func and callback when first becoming
17698 * selected. Any further clicks will do nothing, unless you enable always
17699 * select with elm_genlist_always_select_mode_set(). This means even if
17700 * selected, every click will make the selected callbacks be called.
17701 * elm_genlist_no_select_mode_set() will turn off the ability to select
17702 * items entirely and they will neither appear selected nor call selected
17703 * callback functions.
17705 * Remember that you can create new styles and add your own theme augmentation
17706 * per application with elm_theme_extension_add(). If you absolutely must
17707 * have a specific style that overrides any theme the user or system sets up
17708 * you can use elm_theme_overlay_add() to add such a file.
17710 * @section Genlist_Implementation Implementation
17712 * Evas tracks every object you create. Every time it processes an event
17713 * (mouse move, down, up etc.) it needs to walk through objects and find out
17714 * what event that affects. Even worse every time it renders display updates,
17715 * in order to just calculate what to re-draw, it needs to walk through many
17716 * many many objects. Thus, the more objects you keep active, the more
17717 * overhead Evas has in just doing its work. It is advisable to keep your
17718 * active objects to the minimum working set you need. Also remember that
17719 * object creation and deletion carries an overhead, so there is a
17720 * middle-ground, which is not easily determined. But don't keep massive lists
17721 * of objects you can't see or use. Genlist does this with list objects. It
17722 * creates and destroys them dynamically as you scroll around. It groups them
17723 * into blocks so it can determine the visibility etc. of a whole block at
17724 * once as opposed to having to walk the whole list. This 2-level list allows
17725 * for very large numbers of items to be in the list (tests have used up to
17726 * 2,000,000 items). Also genlist employs a queue for adding items. As items
17727 * may be different sizes, every item added needs to be calculated as to its
17728 * size and thus this presents a lot of overhead on populating the list, this
17729 * genlist employs a queue. Any item added is queued and spooled off over
17730 * time, actually appearing some time later, so if your list has many members
17731 * you may find it takes a while for them to all appear, with your process
17732 * consuming a lot of CPU while it is busy spooling.
17734 * Genlist also implements a tree structure, but it does so with callbacks to
17735 * the application, with the application filling in tree structures when
17736 * requested (allowing for efficient building of a very deep tree that could
17737 * even be used for file-management). See the above smart signal callbacks for
17740 * @section Genlist_Smart_Events Genlist smart events
17742 * Signals that you can add callbacks for are:
17743 * - @c "activated" - The user has double-clicked or pressed
17744 * (enter|return|spacebar) on an item. The @c event_info parameter is the
17745 * item that was activated.
17746 * - @c "clicked,double" - The user has double-clicked an item. The @c
17747 * event_info parameter is the item that was double-clicked.
17748 * - @c "selected" - This is called when a user has made an item selected.
17749 * The event_info parameter is the genlist item that was selected.
17750 * - @c "unselected" - This is called when a user has made an item
17751 * unselected. The event_info parameter is the genlist item that was
17753 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
17754 * called and the item is now meant to be expanded. The event_info
17755 * parameter is the genlist item that was indicated to expand. It is the
17756 * job of this callback to then fill in the child items.
17757 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
17758 * called and the item is now meant to be contracted. The event_info
17759 * parameter is the genlist item that was indicated to contract. It is the
17760 * job of this callback to then delete the child items.
17761 * - @c "expand,request" - This is called when a user has indicated they want
17762 * to expand a tree branch item. The callback should decide if the item can
17763 * expand (has any children) and then call elm_genlist_item_expanded_set()
17764 * appropriately to set the state. The event_info parameter is the genlist
17765 * item that was indicated to expand.
17766 * - @c "contract,request" - This is called when a user has indicated they
17767 * want to contract a tree branch item. The callback should decide if the
17768 * item can contract (has any children) and then call
17769 * elm_genlist_item_expanded_set() appropriately to set the state. The
17770 * event_info parameter is the genlist item that was indicated to contract.
17771 * - @c "realized" - This is called when the item in the list is created as a
17772 * real evas object. event_info parameter is the genlist item that was
17773 * created. The object may be deleted at any time, so it is up to the
17774 * caller to not use the object pointer from elm_genlist_item_object_get()
17775 * in a way where it may point to freed objects.
17776 * - @c "unrealized" - This is called just before an item is unrealized.
17777 * After this call content objects provided will be deleted and the item
17778 * object itself delete or be put into a floating cache.
17779 * - @c "drag,start,up" - This is called when the item in the list has been
17780 * dragged (not scrolled) up.
17781 * - @c "drag,start,down" - This is called when the item in the list has been
17782 * dragged (not scrolled) down.
17783 * - @c "drag,start,left" - This is called when the item in the list has been
17784 * dragged (not scrolled) left.
17785 * - @c "drag,start,right" - This is called when the item in the list has
17786 * been dragged (not scrolled) right.
17787 * - @c "drag,stop" - This is called when the item in the list has stopped
17789 * - @c "drag" - This is called when the item in the list is being dragged.
17790 * - @c "longpressed" - This is called when the item is pressed for a certain
17791 * amount of time. By default it's 1 second.
17792 * - @c "scroll,anim,start" - This is called when scrolling animation has
17794 * - @c "scroll,anim,stop" - This is called when scrolling animation has
17796 * - @c "scroll,drag,start" - This is called when dragging the content has
17798 * - @c "scroll,drag,stop" - This is called when dragging the content has
17800 * - @c "edge,top" - This is called when the genlist is scrolled until
17802 * - @c "edge,bottom" - This is called when the genlist is scrolled
17803 * until the bottom edge.
17804 * - @c "edge,left" - This is called when the genlist is scrolled
17805 * until the left edge.
17806 * - @c "edge,right" - This is called when the genlist is scrolled
17807 * until the right edge.
17808 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
17810 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
17812 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
17814 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
17816 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
17817 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
17818 * multi-touch pinched in.
17819 * - @c "swipe" - This is called when the genlist is swiped.
17820 * - @c "moved" - This is called when a genlist item is moved.
17821 * - @c "language,changed" - This is called when the program's language is
17824 * @section Genlist_Examples Examples
17826 * Here is a list of examples that use the genlist, trying to show some of
17827 * its capabilities:
17828 * - @ref genlist_example_01
17829 * - @ref genlist_example_02
17830 * - @ref genlist_example_03
17831 * - @ref genlist_example_04
17832 * - @ref genlist_example_05
17836 * @addtogroup Genlist
17841 * @enum _Elm_Genlist_Item_Flags
17842 * @typedef Elm_Genlist_Item_Flags
17844 * Defines if the item is of any special type (has subitems or it's the
17845 * index of a group), or is just a simple item.
17849 typedef enum _Elm_Genlist_Item_Flags
17851 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
17852 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
17853 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
17854 } Elm_Genlist_Item_Flags;
17855 typedef enum _Elm_Genlist_Item_Field_Flags
17857 ELM_GENLIST_ITEM_FIELD_ALL = 0,
17858 ELM_GENLIST_ITEM_FIELD_LABEL = (1 << 0),
17859 ELM_GENLIST_ITEM_FIELD_ICON = (1 << 1),
17860 ELM_GENLIST_ITEM_FIELD_STATE = (1 << 2)
17861 } Elm_Genlist_Item_Field_Flags;
17862 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
17863 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
17864 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func;
17865 typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
17866 typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part);
17867 typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
17868 typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj);
17869 typedef void (*GenlistItemMovedFunc) ( Evas_Object *genlist, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after);
17872 * @struct _Elm_Genlist_Item_Class
17874 * Genlist item class definition structs.
17876 * This struct contains the style and fetching functions that will define the
17877 * contents of each item.
17879 * @see @ref Genlist_Item_Class
17881 struct _Elm_Genlist_Item_Class
17883 const char *item_style;
17885 GenlistItemLabelGetFunc label_get;
17886 GenlistItemIconGetFunc icon_get;
17887 GenlistItemStateGetFunc state_get;
17888 GenlistItemDelFunc del;
17889 GenlistItemMovedFunc moved;
17891 const char *edit_item_style;
17892 const char *mode_item_style;
17894 #define Elm_Genlist_Item_Class_Func Elm_Gen_Item_Class_Func
17896 * Add a new genlist widget to the given parent Elementary
17897 * (container) object
17899 * @param parent The parent object
17900 * @return a new genlist widget handle or @c NULL, on errors
17902 * This function inserts a new genlist widget on the canvas.
17904 * @see elm_genlist_item_append()
17905 * @see elm_genlist_item_del()
17906 * @see elm_genlist_clear()
17910 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17912 * Remove all items from a given genlist widget.
17914 * @param obj The genlist object
17916 * This removes (and deletes) all items in @p obj, leaving it empty.
17918 * @see elm_genlist_item_del(), to remove just one item.
17922 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
17924 * Enable or disable multi-selection in the genlist
17926 * @param obj The genlist object
17927 * @param multi Multi-select enable/disable. Default is disabled.
17929 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
17930 * the list. This allows more than 1 item to be selected. To retrieve the list
17931 * of selected items, use elm_genlist_selected_items_get().
17933 * @see elm_genlist_selected_items_get()
17934 * @see elm_genlist_multi_select_get()
17938 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
17940 * Gets if multi-selection in genlist is enabled or disabled.
17942 * @param obj The genlist object
17943 * @return Multi-select enabled/disabled
17944 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
17946 * @see elm_genlist_multi_select_set()
17950 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17952 * This sets the horizontal stretching mode.
17954 * @param obj The genlist object
17955 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
17957 * This sets the mode used for sizing items horizontally. Valid modes
17958 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
17959 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
17960 * the scroller will scroll horizontally. Otherwise items are expanded
17961 * to fill the width of the viewport of the scroller. If it is
17962 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
17963 * limited to that size.
17965 * @see elm_genlist_horizontal_get()
17969 EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
17971 * Gets the horizontal stretching mode.
17973 * @param obj The genlist object
17974 * @return The mode to use
17975 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
17977 * @see elm_genlist_horizontal_set()
17981 EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17983 * Set the always select mode.
17985 * @param obj The genlist object
17986 * @param always_select The always select mode (@c EINA_TRUE = on, @c
17987 * EINA_FALSE = off). Default is @c EINA_FALSE.
17989 * Items will only call their selection func and callback when first
17990 * becoming selected. Any further clicks will do nothing, unless you
17991 * enable always select with elm_genlist_always_select_mode_set().
17992 * This means that, even if selected, every click will make the selected
17993 * callbacks be called.
17995 * @see elm_genlist_always_select_mode_get()
17999 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
18001 * Get the always select mode.
18003 * @param obj The genlist object
18004 * @return The always select mode
18005 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18007 * @see elm_genlist_always_select_mode_set()
18011 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18013 * Enable/disable the no select mode.
18015 * @param obj The genlist object
18016 * @param no_select The no select mode
18017 * (EINA_TRUE = on, EINA_FALSE = off)
18019 * This will turn off the ability to select items entirely and they
18020 * will neither appear selected nor call selected callback functions.
18022 * @see elm_genlist_no_select_mode_get()
18026 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
18028 * Gets whether the no select mode is enabled.
18030 * @param obj The genlist object
18031 * @return The no select mode
18032 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18034 * @see elm_genlist_no_select_mode_set()
18038 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18040 * Enable/disable compress mode.
18042 * @param obj The genlist object
18043 * @param compress The compress mode
18044 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
18046 * This will enable the compress mode where items are "compressed"
18047 * horizontally to fit the genlist scrollable viewport width. This is
18048 * special for genlist. Do not rely on
18049 * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
18050 * work as genlist needs to handle it specially.
18052 * @see elm_genlist_compress_mode_get()
18056 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
18058 * Get whether the compress mode is enabled.
18060 * @param obj The genlist object
18061 * @return The compress mode
18062 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18064 * @see elm_genlist_compress_mode_set()
18068 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18070 * Enable/disable height-for-width mode.
18072 * @param obj The genlist object
18073 * @param setting The height-for-width mode (@c EINA_TRUE = on,
18074 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
18076 * With height-for-width mode the item width will be fixed (restricted
18077 * to a minimum of) to the list width when calculating its size in
18078 * order to allow the height to be calculated based on it. This allows,
18079 * for instance, text block to wrap lines if the Edje part is
18080 * configured with "text.min: 0 1".
18082 * @note This mode will make list resize slower as it will have to
18083 * recalculate every item height again whenever the list width
18086 * @note When height-for-width mode is enabled, it also enables
18087 * compress mode (see elm_genlist_compress_mode_set()) and
18088 * disables homogeneous (see elm_genlist_homogeneous_set()).
18092 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
18094 * Get whether the height-for-width mode is enabled.
18096 * @param obj The genlist object
18097 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
18102 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18104 * Enable/disable horizontal and vertical bouncing effect.
18106 * @param obj The genlist object
18107 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
18108 * EINA_FALSE = off). Default is @c EINA_FALSE.
18109 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
18110 * EINA_FALSE = off). Default is @c EINA_TRUE.
18112 * This will enable or disable the scroller bouncing effect for the
18113 * genlist. See elm_scroller_bounce_set() for details.
18115 * @see elm_scroller_bounce_set()
18116 * @see elm_genlist_bounce_get()
18120 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18122 * Get whether the horizontal and vertical bouncing effect is enabled.
18124 * @param obj The genlist object
18125 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
18127 * @param v_bounce Pointer to a bool to receive if the bounce vertically
18130 * @see elm_genlist_bounce_set()
18134 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18136 * Enable/disable homogenous mode.
18138 * @param obj The genlist object
18139 * @param homogeneous Assume the items within the genlist are of the
18140 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
18143 * This will enable the homogeneous mode where items are of the same
18144 * height and width so that genlist may do the lazy-loading at its
18145 * maximum (which increases the performance for scrolling the list). This
18146 * implies 'compressed' mode.
18148 * @see elm_genlist_compress_mode_set()
18149 * @see elm_genlist_homogeneous_get()
18153 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
18155 * Get whether the homogenous mode is enabled.
18157 * @param obj The genlist object
18158 * @return Assume the items within the genlist are of the same height
18159 * and width (EINA_TRUE = on, EINA_FALSE = off)
18161 * @see elm_genlist_homogeneous_set()
18165 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18167 * Set the maximum number of items within an item block
18169 * @param obj The genlist object
18170 * @param n Maximum number of items within an item block. Default is 32.
18172 * This will configure the block count to tune to the target with
18173 * particular performance matrix.
18175 * A block of objects will be used to reduce the number of operations due to
18176 * many objects in the screen. It can determine the visibility, or if the
18177 * object has changed, it theme needs to be updated, etc. doing this kind of
18178 * calculation to the entire block, instead of per object.
18180 * The default value for the block count is enough for most lists, so unless
18181 * you know you will have a lot of objects visible in the screen at the same
18182 * time, don't try to change this.
18184 * @see elm_genlist_block_count_get()
18185 * @see @ref Genlist_Implementation
18189 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
18191 * Get the maximum number of items within an item block
18193 * @param obj The genlist object
18194 * @return Maximum number of items within an item block
18196 * @see elm_genlist_block_count_set()
18200 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18202 * Set the timeout in seconds for the longpress event.
18204 * @param obj The genlist object
18205 * @param timeout timeout in seconds. Default is 1.
18207 * This option will change how long it takes to send an event "longpressed"
18208 * after the mouse down signal is sent to the list. If this event occurs, no
18209 * "clicked" event will be sent.
18211 * @see elm_genlist_longpress_timeout_set()
18215 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18217 * Get the timeout in seconds for the longpress event.
18219 * @param obj The genlist object
18220 * @return timeout in seconds
18222 * @see elm_genlist_longpress_timeout_get()
18226 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18228 * Append a new item in a given genlist widget.
18230 * @param obj The genlist object
18231 * @param itc The item class for the item
18232 * @param data The item data
18233 * @param parent The parent item, or NULL if none
18234 * @param flags Item flags
18235 * @param func Convenience function called when the item is selected
18236 * @param func_data Data passed to @p func above.
18237 * @return A handle to the item added or @c NULL if not possible
18239 * This adds the given item to the end of the list or the end of
18240 * the children list if the @p parent is given.
18242 * @see elm_genlist_item_prepend()
18243 * @see elm_genlist_item_insert_before()
18244 * @see elm_genlist_item_insert_after()
18245 * @see elm_genlist_item_del()
18249 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);
18251 * Prepend a new item in a given genlist widget.
18253 * @param obj The genlist object
18254 * @param itc The item class for the item
18255 * @param data The item data
18256 * @param parent The parent item, or NULL if none
18257 * @param flags Item flags
18258 * @param func Convenience function called when the item is selected
18259 * @param func_data Data passed to @p func above.
18260 * @return A handle to the item added or NULL if not possible
18262 * This adds an item to the beginning of the list or beginning of the
18263 * children of the parent if given.
18265 * @see elm_genlist_item_append()
18266 * @see elm_genlist_item_insert_before()
18267 * @see elm_genlist_item_insert_after()
18268 * @see elm_genlist_item_del()
18272 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);
18274 * Insert an item before another in a genlist widget
18276 * @param obj The genlist object
18277 * @param itc The item class for the item
18278 * @param data The item data
18279 * @param before The item to place this new one before.
18280 * @param flags Item flags
18281 * @param func Convenience function called when the item is selected
18282 * @param func_data Data passed to @p func above.
18283 * @return A handle to the item added or @c NULL if not possible
18285 * This inserts an item before another in the list. It will be in the
18286 * same tree level or group as the item it is inserted before.
18288 * @see elm_genlist_item_append()
18289 * @see elm_genlist_item_prepend()
18290 * @see elm_genlist_item_insert_after()
18291 * @see elm_genlist_item_del()
18295 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);
18297 * Insert an item after another in a genlist widget
18299 * @param obj The genlist object
18300 * @param itc The item class for the item
18301 * @param data The item data
18302 * @param after The item to place this new one after.
18303 * @param flags Item flags
18304 * @param func Convenience function called when the item is selected
18305 * @param func_data Data passed to @p func above.
18306 * @return A handle to the item added or @c NULL if not possible
18308 * This inserts an item after another in the list. It will be in the
18309 * same tree level or group as the item it is inserted after.
18311 * @see elm_genlist_item_append()
18312 * @see elm_genlist_item_prepend()
18313 * @see elm_genlist_item_insert_before()
18314 * @see elm_genlist_item_del()
18318 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);
18320 * Insert a new item into the sorted genlist object
18322 * @param obj The genlist object
18323 * @param itc The item class for the item
18324 * @param data The item data
18325 * @param parent The parent item, or NULL if none
18326 * @param flags Item flags
18327 * @param comp The function called for the sort
18328 * @param func Convenience function called when item selected
18329 * @param func_data Data passed to @p func above.
18330 * @return A handle to the item added or NULL if not possible
18334 EAPI Elm_Genlist_Item *elm_genlist_item_sorted_insert(Evas_Object *obj, const Elm_Genlist_Item_Class *itc, const void *data, Elm_Genlist_Item *parent, Elm_Genlist_Item_Flags flags, Eina_Compare_Cb comp, Evas_Smart_Cb func,const void *func_data);
18335 EAPI Elm_Genlist_Item *elm_genlist_item_direct_sorted_insert(Evas_Object *obj, const Elm_Genlist_Item_Class *itc, const void *data, Elm_Genlist_Item *parent, Elm_Genlist_Item_Flags flags, Eina_Compare_Cb comp, Evas_Smart_Cb func, const void *func_data);
18336 /* operations to retrieve existing items */
18338 * Get the selectd item in the genlist.
18340 * @param obj The genlist object
18341 * @return The selected item, or NULL if none is selected.
18343 * This gets the selected item in the list (if multi-selection is enabled, only
18344 * the item that was first selected in the list is returned - which is not very
18345 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
18348 * If no item is selected, NULL is returned.
18350 * @see elm_genlist_selected_items_get()
18354 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18356 * Get a list of selected items in the genlist.
18358 * @param obj The genlist object
18359 * @return The list of selected items, or NULL if none are selected.
18361 * It returns a list of the selected items. This list pointer is only valid so
18362 * long as the selection doesn't change (no items are selected or unselected, or
18363 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
18364 * pointers. The order of the items in this list is the order which they were
18365 * selected, i.e. the first item in this list is the first item that was
18366 * selected, and so on.
18368 * @note If not in multi-select mode, consider using function
18369 * elm_genlist_selected_item_get() instead.
18371 * @see elm_genlist_multi_select_set()
18372 * @see elm_genlist_selected_item_get()
18376 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18378 * Get the mode item style of items in the genlist
18379 * @param obj The genlist object
18380 * @return The mode item style string, or NULL if none is specified
18382 * This is a constant string and simply defines the name of the
18383 * style that will be used for mode animations. It can be
18384 * @c NULL if you don't plan to use Genlist mode. See
18385 * elm_genlist_item_mode_set() for more info.
18389 EAPI const char *elm_genlist_mode_item_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18391 * Set the mode item style of items in the genlist
18392 * @param obj The genlist object
18393 * @param style The mode item style string, or NULL if none is desired
18395 * This is a constant string and simply defines the name of the
18396 * style that will be used for mode animations. It can be
18397 * @c NULL if you don't plan to use Genlist mode. See
18398 * elm_genlist_item_mode_set() for more info.
18402 EAPI void elm_genlist_mode_item_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
18404 * Get a list of realized items in genlist
18406 * @param obj The genlist object
18407 * @return The list of realized items, nor NULL if none are realized.
18409 * This returns a list of the realized items in the genlist. The list
18410 * contains Elm_Genlist_Item pointers. The list must be freed by the
18411 * caller when done with eina_list_free(). The item pointers in the
18412 * list are only valid so long as those items are not deleted or the
18413 * genlist is not deleted.
18415 * @see elm_genlist_realized_items_update()
18419 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18421 * Get the item that is at the x, y canvas coords.
18423 * @param obj The gelinst object.
18424 * @param x The input x coordinate
18425 * @param y The input y coordinate
18426 * @param posret The position relative to the item returned here
18427 * @return The item at the coordinates or NULL if none
18429 * This returns the item at the given coordinates (which are canvas
18430 * relative, not object-relative). If an item is at that coordinate,
18431 * that item handle is returned, and if @p posret is not NULL, the
18432 * integer pointed to is set to a value of -1, 0 or 1, depending if
18433 * the coordinate is on the upper portion of that item (-1), on the
18434 * middle section (0) or on the lower part (1). If NULL is returned as
18435 * an item (no item found there), then posret may indicate -1 or 1
18436 * based if the coordinate is above or below all items respectively in
18441 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);
18443 * Get the first item in the genlist
18445 * This returns the first item in the list.
18447 * @param obj The genlist object
18448 * @return The first item, or NULL if none
18452 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18454 * Get the last item in the genlist
18456 * This returns the last item in the list.
18458 * @return The last item, or NULL if none
18462 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18464 * Set the scrollbar policy
18466 * @param obj The genlist object
18467 * @param policy_h Horizontal scrollbar policy.
18468 * @param policy_v Vertical scrollbar policy.
18470 * This sets the scrollbar visibility policy for the given genlist
18471 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
18472 * made visible if it is needed, and otherwise kept hidden.
18473 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
18474 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
18475 * respectively for the horizontal and vertical scrollbars. Default is
18476 * #ELM_SMART_SCROLLER_POLICY_AUTO
18478 * @see elm_genlist_scroller_policy_get()
18482 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
18484 * Get the scrollbar policy
18486 * @param obj The genlist object
18487 * @param policy_h Pointer to store the horizontal scrollbar policy.
18488 * @param policy_v Pointer to store the vertical scrollbar policy.
18490 * @see elm_genlist_scroller_policy_set()
18494 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);
18496 * Get the @b next item in a genlist widget's internal list of items,
18497 * given a handle to one of those items.
18499 * @param item The genlist item to fetch next from
18500 * @return The item after @p item, or @c NULL if there's none (and
18503 * This returns the item placed after the @p item, on the container
18506 * @see elm_genlist_item_prev_get()
18510 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18512 * Get the @b previous item in a genlist widget's internal list of items,
18513 * given a handle to one of those items.
18515 * @param item The genlist item to fetch previous from
18516 * @return The item before @p item, or @c NULL if there's none (and
18519 * This returns the item placed before the @p item, on the container
18522 * @see elm_genlist_item_next_get()
18526 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18528 * Get the genlist object's handle which contains a given genlist
18531 * @param item The item to fetch the container from
18532 * @return The genlist (parent) object
18534 * This returns the genlist object itself that an item belongs to.
18538 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18540 * Get the parent item of the given item
18542 * @param it The item
18543 * @return The parent of the item or @c NULL if it has no parent.
18545 * This returns the item that was specified as parent of the item @p it on
18546 * elm_genlist_item_append() and insertion related functions.
18550 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18552 * Remove all sub-items (children) of the given item
18554 * @param it The item
18556 * This removes all items that are children (and their descendants) of the
18557 * given item @p it.
18559 * @see elm_genlist_clear()
18560 * @see elm_genlist_item_del()
18564 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18566 * Set whether a given genlist item is selected or not
18568 * @param it The item
18569 * @param selected Use @c EINA_TRUE, to make it selected, @c
18570 * EINA_FALSE to make it unselected
18572 * This sets the selected state of an item. If multi selection is
18573 * not enabled on the containing genlist and @p selected is @c
18574 * EINA_TRUE, any other previously selected items will get
18575 * unselected in favor of this new one.
18577 * @see elm_genlist_item_selected_get()
18581 EINA_DEPRECATED EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
18583 * Get whether a given genlist item is selected or not
18585 * @param it The item
18586 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
18588 * @see elm_genlist_item_selected_set() for more details
18592 EINA_DEPRECATED EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18594 * Sets the expanded state of an item.
18596 * @param it The item
18597 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
18599 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
18602 * The theme will respond to this change visually, and a signal "expanded" or
18603 * "contracted" will be sent from the genlist with a pointer to the item that
18604 * has been expanded/contracted.
18606 * Calling this function won't show or hide any child of this item (if it is
18607 * a parent). You must manually delete and create them on the callbacks fo
18608 * the "expanded" or "contracted" signals.
18610 * @see elm_genlist_item_expanded_get()
18614 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
18616 * Get the expanded state of an item
18618 * @param it The item
18619 * @return The expanded state
18621 * This gets the expanded state of an item.
18623 * @see elm_genlist_item_expanded_set()
18627 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18629 * Get the depth of expanded item
18631 * @param it The genlist item object
18632 * @return The depth of expanded item
18636 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18638 * Set whether a given genlist item is disabled or not.
18640 * @param it The item
18641 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
18642 * to enable it back.
18644 * A disabled item cannot be selected or unselected. It will also
18645 * change its appearance, to signal the user it's disabled.
18647 * @see elm_genlist_item_disabled_get()
18651 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
18653 * Get whether a given genlist item is disabled or not.
18655 * @param it The item
18656 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
18659 * @see elm_genlist_item_disabled_set() for more details
18663 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18665 * Sets the display only state of an item.
18667 * @param it The item
18668 * @param display_only @c EINA_TRUE if the item is display only, @c
18669 * EINA_FALSE otherwise.
18671 * A display only item cannot be selected or unselected. It is for
18672 * display only and not selecting or otherwise clicking, dragging
18673 * etc. by the user, thus finger size rules will not be applied to
18676 * It's good to set group index items to display only state.
18678 * @see elm_genlist_item_display_only_get()
18682 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
18684 * Get the display only state of an item
18686 * @param it The item
18687 * @return @c EINA_TRUE if the item is display only, @c
18688 * EINA_FALSE otherwise.
18690 * @see elm_genlist_item_display_only_set()
18694 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18696 * Show the portion of a genlist's internal list containing a given
18697 * item, immediately.
18699 * @param it The item to display
18701 * This causes genlist to jump to the given item @p it and show it (by
18702 * immediately scrolling to that position), if it is not fully visible.
18704 * @see elm_genlist_item_bring_in()
18705 * @see elm_genlist_item_top_show()
18706 * @see elm_genlist_item_middle_show()
18710 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18712 * Animatedly bring in, to the visible are of a genlist, a given
18715 * @param it The item to display
18717 * This causes genlist to jump to the given item @p it and show it (by
18718 * animatedly scrolling), if it is not fully visible. This may use animation
18719 * to do so and take a period of time
18721 * @see elm_genlist_item_show()
18722 * @see elm_genlist_item_top_bring_in()
18723 * @see elm_genlist_item_middle_bring_in()
18727 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18729 * Show the portion of a genlist's internal list containing a given
18730 * item, immediately.
18732 * @param it The item to display
18734 * This causes genlist to jump to the given item @p it and show it (by
18735 * immediately scrolling to that position), if it is not fully visible.
18737 * The item will be positioned at the top of the genlist viewport.
18739 * @see elm_genlist_item_show()
18740 * @see elm_genlist_item_top_bring_in()
18744 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18746 * Animatedly bring in, to the visible are of a genlist, a given
18749 * @param it The item
18751 * This causes genlist to jump to the given item @p it and show it (by
18752 * animatedly scrolling), if it is not fully visible. This may use animation
18753 * to do so and take a period of time
18755 * The item will be positioned at the top of the genlist viewport.
18757 * @see elm_genlist_item_bring_in()
18758 * @see elm_genlist_item_top_show()
18762 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18764 * Show the portion of a genlist's internal list containing a given
18765 * item, immediately.
18767 * @param it The item to display
18769 * This causes genlist to jump to the given item @p it and show it (by
18770 * immediately scrolling to that position), if it is not fully visible.
18772 * The item will be positioned at the middle of the genlist viewport.
18774 * @see elm_genlist_item_show()
18775 * @see elm_genlist_item_middle_bring_in()
18779 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18781 * Animatedly bring in, to the visible are of a genlist, a given
18784 * @param it The item
18786 * This causes genlist to jump to the given item @p it and show it (by
18787 * animatedly scrolling), if it is not fully visible. This may use animation
18788 * to do so and take a period of time
18790 * The item will be positioned at the middle of the genlist viewport.
18792 * @see elm_genlist_item_bring_in()
18793 * @see elm_genlist_item_middle_show()
18797 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18799 * Remove a genlist item from the its parent, deleting it.
18801 * @param item The item to be removed.
18802 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
18804 * @see elm_genlist_clear(), to remove all items in a genlist at
18809 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18811 * Return the data associated to a given genlist item
18813 * @param item The genlist item.
18814 * @return the data associated to this item.
18816 * This returns the @c data value passed on the
18817 * elm_genlist_item_append() and related item addition calls.
18819 * @see elm_genlist_item_append()
18820 * @see elm_genlist_item_data_set()
18824 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18826 * Set the data associated to a given genlist item
18828 * @param item The genlist item
18829 * @param data The new data pointer to set on it
18831 * This @b overrides the @c data value passed on the
18832 * elm_genlist_item_append() and related item addition calls. This
18833 * function @b won't call elm_genlist_item_update() automatically,
18834 * so you'd issue it afterwards if you want to hove the item
18835 * updated to reflect the that new data.
18837 * @see elm_genlist_item_data_get()
18841 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
18843 * Tells genlist to "orphan" icons fetchs by the item class
18845 * @param it The item
18847 * This instructs genlist to release references to icons in the item,
18848 * meaning that they will no longer be managed by genlist and are
18849 * floating "orphans" that can be re-used elsewhere if the user wants
18854 EAPI void elm_genlist_item_contents_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18855 EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18857 * Get the real Evas object created to implement the view of a
18858 * given genlist item
18860 * @param item The genlist item.
18861 * @return the Evas object implementing this item's view.
18863 * This returns the actual Evas object used to implement the
18864 * specified genlist item's view. This may be @c NULL, as it may
18865 * not have been created or may have been deleted, at any time, by
18866 * the genlist. <b>Do not modify this object</b> (move, resize,
18867 * show, hide, etc.), as the genlist is controlling it. This
18868 * function is for querying, emitting custom signals or hooking
18869 * lower level callbacks for events on that object. Do not delete
18870 * this object under any circumstances.
18872 * @see elm_genlist_item_data_get()
18876 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18878 * Update the contents of an item
18880 * @param it The item
18882 * This updates an item by calling all the item class functions again
18883 * to get the icons, labels and states. Use this when the original
18884 * item data has changed and the changes are desired to be reflected.
18886 * Use elm_genlist_realized_items_update() to update all already realized
18889 * @see elm_genlist_realized_items_update()
18893 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18894 EAPI void elm_genlist_item_fields_update(Elm_Genlist_Item *it, const char *parts, Elm_Genlist_Item_Field_Flags itf) EINA_ARG_NONNULL(1);
18896 * Update the item class of an item
18898 * @param it The item
18899 * @param itc The item class for the item
18901 * This sets another class fo the item, changing the way that it is
18902 * displayed. After changing the item class, elm_genlist_item_update() is
18903 * called on the item @p it.
18907 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
18908 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18910 * Set the text to be shown in a given genlist item's tooltips.
18912 * @param item The genlist item
18913 * @param text The text to set in the content
18915 * This call will setup the text to be used as tooltip to that item
18916 * (analogous to elm_object_tooltip_text_set(), but being item
18917 * tooltips with higher precedence than object tooltips). It can
18918 * have only one tooltip at a time, so any previous tooltip data
18919 * will get removed.
18921 * In order to set an icon or something else as a tooltip, look at
18922 * elm_genlist_item_tooltip_content_cb_set().
18926 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
18928 * Set the content to be shown in a given genlist item's tooltips
18930 * @param item The genlist item.
18931 * @param func The function returning the tooltip contents.
18932 * @param data What to provide to @a func as callback data/context.
18933 * @param del_cb Called when data is not needed anymore, either when
18934 * another callback replaces @p func, the tooltip is unset with
18935 * elm_genlist_item_tooltip_unset() or the owner @p item
18936 * dies. This callback receives as its first parameter the
18937 * given @p data, being @c event_info the item handle.
18939 * This call will setup the tooltip's contents to @p item
18940 * (analogous to elm_object_tooltip_content_cb_set(), but being
18941 * item tooltips with higher precedence than object tooltips). It
18942 * can have only one tooltip at a time, so any previous tooltip
18943 * content will get removed. @p func (with @p data) will be called
18944 * every time Elementary needs to show the tooltip and it should
18945 * return a valid Evas object, which will be fully managed by the
18946 * tooltip system, getting deleted when the tooltip is gone.
18948 * In order to set just a text as a tooltip, look at
18949 * elm_genlist_item_tooltip_text_set().
18953 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);
18955 * Unset a tooltip from a given genlist item
18957 * @param item genlist item to remove a previously set tooltip from.
18959 * This call removes any tooltip set on @p item. The callback
18960 * provided as @c del_cb to
18961 * elm_genlist_item_tooltip_content_cb_set() will be called to
18962 * notify it is not used anymore (and have resources cleaned, if
18965 * @see elm_genlist_item_tooltip_content_cb_set()
18969 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18971 * Set a different @b style for a given genlist item's tooltip.
18973 * @param item genlist item with tooltip set
18974 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
18975 * "default", @c "transparent", etc)
18977 * Tooltips can have <b>alternate styles</b> to be displayed on,
18978 * which are defined by the theme set on Elementary. This function
18979 * works analogously as elm_object_tooltip_style_set(), but here
18980 * applied only to genlist item objects. The default style for
18981 * tooltips is @c "default".
18983 * @note before you set a style you should define a tooltip with
18984 * elm_genlist_item_tooltip_content_cb_set() or
18985 * elm_genlist_item_tooltip_text_set()
18987 * @see elm_genlist_item_tooltip_style_get()
18991 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
18993 * Get the style set a given genlist item's tooltip.
18995 * @param item genlist item with tooltip already set on.
18996 * @return style the theme style in use, which defaults to
18997 * "default". If the object does not have a tooltip set,
18998 * then @c NULL is returned.
19000 * @see elm_genlist_item_tooltip_style_set() for more details
19004 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19006 * Set the type of mouse pointer/cursor decoration to be shown,
19007 * when the mouse pointer is over the given genlist widget item
19009 * @param item genlist item to customize cursor on
19010 * @param cursor the cursor type's name
19012 * This function works analogously as elm_object_cursor_set(), but
19013 * here the cursor's changing area is restricted to the item's
19014 * area, and not the whole widget's. Note that that item cursors
19015 * have precedence over widget cursors, so that a mouse over @p
19016 * item will always show cursor @p type.
19018 * If this function is called twice for an object, a previously set
19019 * cursor will be unset on the second call.
19021 * @see elm_object_cursor_set()
19022 * @see elm_genlist_item_cursor_get()
19023 * @see elm_genlist_item_cursor_unset()
19027 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
19029 * Get the type of mouse pointer/cursor decoration set to be shown,
19030 * when the mouse pointer is over the given genlist widget item
19032 * @param item genlist item with custom cursor set
19033 * @return the cursor type's name or @c NULL, if no custom cursors
19034 * were set to @p item (and on errors)
19036 * @see elm_object_cursor_get()
19037 * @see elm_genlist_item_cursor_set() for more details
19038 * @see elm_genlist_item_cursor_unset()
19042 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19044 * Unset any custom mouse pointer/cursor decoration set to be
19045 * shown, when the mouse pointer is over the given genlist widget
19046 * item, thus making it show the @b default cursor again.
19048 * @param item a genlist item
19050 * Use this call to undo any custom settings on this item's cursor
19051 * decoration, bringing it back to defaults (no custom style set).
19053 * @see elm_object_cursor_unset()
19054 * @see elm_genlist_item_cursor_set() for more details
19058 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19060 * Set a different @b style for a given custom cursor set for a
19063 * @param item genlist item with custom cursor set
19064 * @param style the <b>theme style</b> to use (e.g. @c "default",
19065 * @c "transparent", etc)
19067 * This function only makes sense when one is using custom mouse
19068 * cursor decorations <b>defined in a theme file</b> , which can
19069 * have, given a cursor name/type, <b>alternate styles</b> on
19070 * it. It works analogously as elm_object_cursor_style_set(), but
19071 * here applied only to genlist item objects.
19073 * @warning Before you set a cursor style you should have defined a
19074 * custom cursor previously on the item, with
19075 * elm_genlist_item_cursor_set()
19077 * @see elm_genlist_item_cursor_engine_only_set()
19078 * @see elm_genlist_item_cursor_style_get()
19082 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19084 * Get the current @b style set for a given genlist item's custom
19087 * @param item genlist item with custom cursor set.
19088 * @return style the cursor style in use. If the object does not
19089 * have a cursor set, then @c NULL is returned.
19091 * @see elm_genlist_item_cursor_style_set() for more details
19095 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19097 * Set if the (custom) cursor for a given genlist item should be
19098 * searched in its theme, also, or should only rely on the
19099 * rendering engine.
19101 * @param item item with custom (custom) cursor already set on
19102 * @param engine_only Use @c EINA_TRUE to have cursors looked for
19103 * only on those provided by the rendering engine, @c EINA_FALSE to
19104 * have them searched on the widget's theme, as well.
19106 * @note This call is of use only if you've set a custom cursor
19107 * for genlist items, with elm_genlist_item_cursor_set().
19109 * @note By default, cursors will only be looked for between those
19110 * provided by the rendering engine.
19114 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
19116 * Get if the (custom) cursor for a given genlist item is being
19117 * searched in its theme, also, or is only relying on the rendering
19120 * @param item a genlist item
19121 * @return @c EINA_TRUE, if cursors are being looked for only on
19122 * those provided by the rendering engine, @c EINA_FALSE if they
19123 * are being searched on the widget's theme, as well.
19125 * @see elm_genlist_item_cursor_engine_only_set(), for more details
19129 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19131 * Update the contents of all realized items.
19133 * @param obj The genlist object.
19135 * This updates all realized items by calling all the item class functions again
19136 * to get the icons, labels and states. Use this when the original
19137 * item data has changed and the changes are desired to be reflected.
19139 * To update just one item, use elm_genlist_item_update().
19141 * @see elm_genlist_realized_items_get()
19142 * @see elm_genlist_item_update()
19146 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
19148 * Activate a genlist mode on an item
19150 * @param item The genlist item
19151 * @param mode Mode name
19152 * @param mode_set Boolean to define set or unset mode.
19154 * A genlist mode is a different way of selecting an item. Once a mode is
19155 * activated on an item, any other selected item is immediately unselected.
19156 * This feature provides an easy way of implementing a new kind of animation
19157 * for selecting an item, without having to entirely rewrite the item style
19158 * theme. However, the elm_genlist_selected_* API can't be used to get what
19159 * item is activate for a mode.
19161 * The current item style will still be used, but applying a genlist mode to
19162 * an item will select it using a different kind of animation.
19164 * The current active item for a mode can be found by
19165 * elm_genlist_mode_item_get().
19167 * The characteristics of genlist mode are:
19168 * - Only one mode can be active at any time, and for only one item.
19169 * - Genlist handles deactivating other items when one item is activated.
19170 * - A mode is defined in the genlist theme (edc), and more modes can easily
19172 * - A mode style and the genlist item style are different things. They
19173 * can be combined to provide a default style to the item, with some kind
19174 * of animation for that item when the mode is activated.
19176 * When a mode is activated on an item, a new view for that item is created.
19177 * The theme of this mode defines the animation that will be used to transit
19178 * the item from the old view to the new view. This second (new) view will be
19179 * active for that item while the mode is active on the item, and will be
19180 * destroyed after the mode is totally deactivated from that item.
19182 * @see elm_genlist_mode_get()
19183 * @see elm_genlist_mode_item_get()
19187 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
19189 * Get the last (or current) genlist mode used.
19191 * @param obj The genlist object
19193 * This function just returns the name of the last used genlist mode. It will
19194 * be the current mode if it's still active.
19196 * @see elm_genlist_item_mode_set()
19197 * @see elm_genlist_mode_item_get()
19201 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19203 * Get active genlist mode item
19205 * @param obj The genlist object
19206 * @return The active item for that current mode. Or @c NULL if no item is
19207 * activated with any mode.
19209 * This function returns the item that was activated with a mode, by the
19210 * function elm_genlist_item_mode_set().
19212 * @see elm_genlist_item_mode_set()
19213 * @see elm_genlist_mode_get()
19217 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19222 * @param obj The genlist object
19223 * @param reorder_mode The reorder mode
19224 * (EINA_TRUE = on, EINA_FALSE = off)
19228 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
19231 * Get the reorder mode
19233 * @param obj The genlist object
19234 * @return The reorder mode
19235 * (EINA_TRUE = on, EINA_FALSE = off)
19239 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19241 EAPI void elm_genlist_edit_mode_set(Evas_Object *obj, Eina_Bool edit_mode) EINA_ARG_NONNULL(1);
19242 EAPI Eina_Bool elm_genlist_edit_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19243 EAPI void elm_genlist_item_rename_mode_set(Elm_Genlist_Item *it, Eina_Bool renamed) EINA_ARG_NONNULL(1);
19244 EAPI Eina_Bool elm_genlist_item_rename_mode_get(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19245 EAPI void elm_genlist_item_move_after(Elm_Genlist_Item *it, Elm_Genlist_Item *after ) EINA_ARG_NONNULL(1, 2);
19246 EAPI void elm_genlist_item_move_before(Elm_Genlist_Item *it, Elm_Genlist_Item *before) EINA_ARG_NONNULL(1, 2);
19247 EAPI void elm_genlist_effect_set(const Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19248 EAPI void elm_genlist_pinch_zoom_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19249 EAPI void elm_genlist_pinch_zoom_mode_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19250 EAPI Eina_Bool elm_genlist_pinch_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19257 * @page tutorial_check Check example
19258 * @dontinclude check_example_01.c
19260 * This example will show 2 checkboxes, one with just a label and the second
19261 * one with both a label and an icon. This example also ilustrates how to
19262 * have the checkbox change the value of a variable and how to react to those
19265 * We will start with the usual setup code:
19268 * And now we create our first checkbox, set its label, tell it to change
19269 * the value of @p value when the checkbox stats is changed and ask to be
19270 * notified of state changes:
19273 * For our second checkbox we are going to set an icon so we need to create
19276 * @note For simplicity we are using a rectangle as icon, but any evas object
19279 * And for our second checkbox we set the label, icon and state to true:
19282 * We now do some more setup:
19285 * And finally implement the callback that will be called when the first
19286 * checkbox's state changes. This callback will use @p data to print a
19289 * @note This work because @p data is @p value(from the main function) and @p
19290 * value is changed when the checkbox is changed.
19292 * Our example will look like this:
19293 * @image html screenshots/check_example_01.png
19294 * @image latex screenshots/check_example_01.eps
19296 * @example check_example_01.c
19299 * @defgroup Check Check
19301 * @brief The check widget allows for toggling a value between true and
19304 * Check objects are a lot like radio objects in layout and functionality
19305 * except they do not work as a group, but independently and only toggle the
19306 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
19307 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
19308 * returns the current state. For convenience, like the radio objects, you
19309 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
19310 * for it to modify.
19312 * Signals that you can add callbacks for are:
19313 * "changed" - This is called whenever the user changes the state of one of
19314 * the check object(event_info is NULL).
19316 * @ref tutorial_check should give you a firm grasp of how to use this widget.
19320 * @brief Add a new Check object
19322 * @param parent The parent object
19323 * @return The new object or NULL if it cannot be created
19325 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19327 * @brief Set the text label of the check object
19329 * @param obj The check object
19330 * @param label The text label string in UTF-8
19332 * @deprecated use elm_object_text_set() instead.
19334 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19336 * @brief Get the text label of the check object
19338 * @param obj The check object
19339 * @return The text label string in UTF-8
19341 * @deprecated use elm_object_text_get() instead.
19343 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19345 * @brief Set the icon object of the check object
19347 * @param obj The check object
19348 * @param icon The icon object
19350 * Once the icon object is set, a previously set one will be deleted.
19351 * If you want to keep that old content object, use the
19352 * elm_check_icon_unset() function.
19354 EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19356 * @brief Get the icon object of the check object
19358 * @param obj The check object
19359 * @return The icon object
19361 EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19363 * @brief Unset the icon used for the check object
19365 * @param obj The check object
19366 * @return The icon object that was being used
19368 * Unparent and return the icon object which was set for this widget.
19370 EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19372 * @brief Set the on/off state of the check object
19374 * @param obj The check object
19375 * @param state The state to use (1 == on, 0 == off)
19377 * This sets the state of the check. If set
19378 * with elm_check_state_pointer_set() the state of that variable is also
19379 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
19381 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
19383 * @brief Get the state of the check object
19385 * @param obj The check object
19386 * @return The boolean state
19388 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19390 * @brief Set a convenience pointer to a boolean to change
19392 * @param obj The check object
19393 * @param statep Pointer to the boolean to modify
19395 * This sets a pointer to a boolean, that, in addition to the check objects
19396 * state will also be modified directly. To stop setting the object pointed
19397 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
19398 * then when this is called, the check objects state will also be modified to
19399 * reflect the value of the boolean @p statep points to, just like calling
19400 * elm_check_state_set().
19402 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
19408 * @defgroup Radio Radio
19410 * @image html img/widget/radio/preview-00.png
19411 * @image latex img/widget/radio/preview-00.eps
19413 * @brief Radio is a widget that allows for 1 or more options to be displayed
19414 * and have the user choose only 1 of them.
19416 * A radio object contains an indicator, an optional Label and an optional
19417 * icon object. While it's possible to have a group of only one radio they,
19418 * are normally used in groups of 2 or more. To add a radio to a group use
19419 * elm_radio_group_add(). The radio object(s) will select from one of a set
19420 * of integer values, so any value they are configuring needs to be mapped to
19421 * a set of integers. To configure what value that radio object represents,
19422 * use elm_radio_state_value_set() to set the integer it represents. To set
19423 * the value the whole group(which one is currently selected) is to indicate
19424 * use elm_radio_value_set() on any group member, and to get the groups value
19425 * use elm_radio_value_get(). For convenience the radio objects are also able
19426 * to directly set an integer(int) to the value that is selected. To specify
19427 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
19428 * The radio objects will modify this directly. That implies the pointer must
19429 * point to valid memory for as long as the radio objects exist.
19431 * Signals that you can add callbacks for are:
19432 * @li changed - This is called whenever the user changes the state of one of
19433 * the radio objects within the group of radio objects that work together.
19435 * Default contents parts of the radio widget that you can use for are:
19436 * @li "elm.swallow.content" - A icon of the radio
19438 * @ref tutorial_radio show most of this API in action.
19442 * @brief Add a new radio to the parent
19444 * @param parent The parent object
19445 * @return The new object or NULL if it cannot be created
19447 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19449 * @brief Set the text label of the radio object
19451 * @param obj The radio object
19452 * @param label The text label string in UTF-8
19454 * @deprecated use elm_object_text_set() instead.
19456 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19458 * @brief Get the text label of the radio object
19460 * @param obj The radio object
19461 * @return The text label string in UTF-8
19463 * @deprecated use elm_object_text_set() instead.
19465 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19467 * @brief Set the icon object of the radio object
19469 * @param obj The radio object
19470 * @param icon The icon object
19472 * Once the icon object is set, a previously set one will be deleted. If you
19473 * want to keep that old content object, use the elm_radio_icon_unset()
19476 * @deprecated use elm_object_content_set() instead.
19478 EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19480 * @brief Get the icon object of the radio object
19482 * @param obj The radio object
19483 * @return The icon object
19485 * @see elm_radio_icon_set()
19487 EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19489 * @brief Unset the icon used for the radio object
19491 * @param obj The radio object
19492 * @return The icon object that was being used
19494 * Unparent and return the icon object which was set for this widget.
19496 * @see elm_radio_icon_set()
19497 * @deprecated use elm_object_content_unset() instead.
19499 EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19501 * @brief Add this radio to a group of other radio objects
19503 * @param obj The radio object
19504 * @param group Any object whose group the @p obj is to join.
19506 * Radio objects work in groups. Each member should have a different integer
19507 * value assigned. In order to have them work as a group, they need to know
19508 * about each other. This adds the given radio object to the group of which
19509 * the group object indicated is a member.
19511 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
19513 * @brief Set the integer value that this radio object represents
19515 * @param obj The radio object
19516 * @param value The value to use if this radio object is selected
19518 * This sets the value of the radio.
19520 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
19522 * @brief Get the integer value that this radio object represents
19524 * @param obj The radio object
19525 * @return The value used if this radio object is selected
19527 * This gets the value of the radio.
19529 * @see elm_radio_value_set()
19531 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19533 * @brief Set the value of the radio.
19535 * @param obj The radio object
19536 * @param value The value to use for the group
19538 * This sets the value of the radio group and will also set the value if
19539 * pointed to, to the value supplied, but will not call any callbacks.
19541 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
19543 * @brief Get the state of the radio object
19545 * @param obj The radio object
19546 * @return The integer state
19548 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19550 * @brief Set a convenience pointer to a integer to change
19552 * @param obj The radio object
19553 * @param valuep Pointer to the integer to modify
19555 * This sets a pointer to a integer, that, in addition to the radio objects
19556 * state will also be modified directly. To stop setting the object pointed
19557 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
19558 * when this is called, the radio objects state will also be modified to
19559 * reflect the value of the integer valuep points to, just like calling
19560 * elm_radio_value_set().
19562 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
19568 * @defgroup Pager Pager
19570 * @image html img/widget/pager/preview-00.png
19571 * @image latex img/widget/pager/preview-00.eps
19573 * @brief Widget that allows flipping between 1 or more āpagesā of objects.
19575 * The flipping between āpagesā of objects is animated. All content in pager
19576 * is kept in a stack, the last content to be added will be on the top of the
19577 * stack(be visible).
19579 * Objects can be pushed or popped from the stack or deleted as normal.
19580 * Pushes and pops will animate (and a pop will delete the object once the
19581 * animation is finished). Any object already in the pager can be promoted to
19582 * the top(from its current stacking position) through the use of
19583 * elm_pager_content_promote(). Objects are pushed to the top with
19584 * elm_pager_content_push() and when the top item is no longer wanted, simply
19585 * pop it with elm_pager_content_pop() and it will also be deleted. If an
19586 * object is no longer needed and is not the top item, just delete it as
19587 * normal. You can query which objects are the top and bottom with
19588 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
19590 * Signals that you can add callbacks for are:
19591 * "hide,finished" - when the previous page is hided
19593 * This widget has the following styles available:
19596 * @li fade_translucide
19597 * @li fade_invisible
19598 * @note This styles affect only the flipping animations, the appearance when
19599 * not animating is unaffected by styles.
19601 * @ref tutorial_pager gives a good overview of the usage of the API.
19605 * Add a new pager to the parent
19607 * @param parent The parent object
19608 * @return The new object or NULL if it cannot be created
19612 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19614 * @brief Push an object to the top of the pager stack (and show it).
19616 * @param obj The pager object
19617 * @param content The object to push
19619 * The object pushed becomes a child of the pager, it will be controlled and
19620 * deleted when the pager is deleted.
19622 * @note If the content is already in the stack use
19623 * elm_pager_content_promote().
19624 * @warning Using this function on @p content already in the stack results in
19625 * undefined behavior.
19627 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
19629 * @brief Pop the object that is on top of the stack
19631 * @param obj The pager object
19633 * This pops the object that is on the top(visible) of the pager, makes it
19634 * disappear, then deletes the object. The object that was underneath it on
19635 * the stack will become visible.
19637 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
19639 * @brief Moves an object already in the pager stack to the top of the stack.
19641 * @param obj The pager object
19642 * @param content The object to promote
19644 * This will take the @p content and move it to the top of the stack as
19645 * if it had been pushed there.
19647 * @note If the content isn't already in the stack use
19648 * elm_pager_content_push().
19649 * @warning Using this function on @p content not already in the stack
19650 * results in undefined behavior.
19652 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
19654 * @brief Return the object at the bottom of the pager stack
19656 * @param obj The pager object
19657 * @return The bottom object or NULL if none
19659 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19661 * @brief Return the object at the top of the pager stack
19663 * @param obj The pager object
19664 * @return The top object or NULL if none
19666 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19668 EAPI void elm_pager_to_content_pop(Evas_Object *obj, Evas_Object *content); EINA_ARG_NONNULL(1);
19669 EAPI void elm_pager_animation_disabled_set(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
19676 * @defgroup Slideshow Slideshow
19678 * @image html img/widget/slideshow/preview-00.png
19679 * @image latex img/widget/slideshow/preview-00.eps
19681 * This widget, as the name indicates, is a pre-made image
19682 * slideshow panel, with API functions acting on (child) image
19683 * items presentation. Between those actions, are:
19684 * - advance to next/previous image
19685 * - select the style of image transition animation
19686 * - set the exhibition time for each image
19687 * - start/stop the slideshow
19689 * The transition animations are defined in the widget's theme,
19690 * consequently new animations can be added without having to
19691 * update the widget's code.
19693 * @section Slideshow_Items Slideshow items
19695 * For slideshow items, just like for @ref Genlist "genlist" ones,
19696 * the user defines a @b classes, specifying functions that will be
19697 * called on the item's creation and deletion times.
19699 * The #Elm_Slideshow_Item_Class structure contains the following
19702 * - @c func.get - When an item is displayed, this function is
19703 * called, and it's where one should create the item object, de
19704 * facto. For example, the object can be a pure Evas image object
19705 * or an Elementary @ref Photocam "photocam" widget. See
19706 * #SlideshowItemGetFunc.
19707 * - @c func.del - When an item is no more displayed, this function
19708 * is called, where the user must delete any data associated to
19709 * the item. See #SlideshowItemDelFunc.
19711 * @section Slideshow_Caching Slideshow caching
19713 * The slideshow provides facilities to have items adjacent to the
19714 * one being displayed <b>already "realized"</b> (i.e. loaded) for
19715 * you, so that the system does not have to decode image data
19716 * anymore at the time it has to actually switch images on its
19717 * viewport. The user is able to set the numbers of items to be
19718 * cached @b before and @b after the current item, in the widget's
19721 * Smart events one can add callbacks for are:
19723 * - @c "changed" - when the slideshow switches its view to a new
19726 * List of examples for the slideshow widget:
19727 * @li @ref slideshow_example
19731 * @addtogroup Slideshow
19735 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
19736 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
19737 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Slideshow item handle */
19738 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
19739 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
19742 * @struct _Elm_Slideshow_Item_Class
19744 * Slideshow item class definition. See @ref Slideshow_Items for
19747 struct _Elm_Slideshow_Item_Class
19749 struct _Elm_Slideshow_Item_Class_Func
19751 SlideshowItemGetFunc get;
19752 SlideshowItemDelFunc del;
19754 }; /**< #Elm_Slideshow_Item_Class member definitions */
19757 * Add a new slideshow widget to the given parent Elementary
19758 * (container) object
19760 * @param parent The parent object
19761 * @return A new slideshow widget handle or @c NULL, on errors
19763 * This function inserts a new slideshow widget on the canvas.
19765 * @ingroup Slideshow
19767 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19770 * Add (append) a new item in a given slideshow widget.
19772 * @param obj The slideshow object
19773 * @param itc The item class for the item
19774 * @param data The item's data
19775 * @return A handle to the item added or @c NULL, on errors
19777 * Add a new item to @p obj's internal list of items, appending it.
19778 * The item's class must contain the function really fetching the
19779 * image object to show for this item, which could be an Evas image
19780 * object or an Elementary photo, for example. The @p data
19781 * parameter is going to be passed to both class functions of the
19784 * @see #Elm_Slideshow_Item_Class
19785 * @see elm_slideshow_item_sorted_insert()
19787 * @ingroup Slideshow
19789 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
19792 * Insert a new item into the given slideshow widget, using the @p func
19793 * function to sort items (by item handles).
19795 * @param obj The slideshow object
19796 * @param itc The item class for the item
19797 * @param data The item's data
19798 * @param func The comparing function to be used to sort slideshow
19799 * items <b>by #Elm_Slideshow_Item item handles</b>
19800 * @return Returns The slideshow item handle, on success, or
19801 * @c NULL, on errors
19803 * Add a new item to @p obj's internal list of items, in a position
19804 * determined by the @p func comparing function. The item's class
19805 * must contain the function really fetching the image object to
19806 * show for this item, which could be an Evas image object or an
19807 * Elementary photo, for example. The @p data parameter is going to
19808 * be passed to both class functions of the item.
19810 * @see #Elm_Slideshow_Item_Class
19811 * @see elm_slideshow_item_add()
19813 * @ingroup Slideshow
19815 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);
19818 * Display a given slideshow widget's item, programmatically.
19820 * @param obj The slideshow object
19821 * @param item The item to display on @p obj's viewport
19823 * The change between the current item and @p item will use the
19824 * transition @p obj is set to use (@see
19825 * elm_slideshow_transition_set()).
19827 * @ingroup Slideshow
19829 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
19832 * Slide to the @b next item, in a given slideshow widget
19834 * @param obj The slideshow object
19836 * The sliding animation @p obj is set to use will be the
19837 * transition effect used, after this call is issued.
19839 * @note If the end of the slideshow's internal list of items is
19840 * reached, it'll wrap around to the list's beginning, again.
19842 * @ingroup Slideshow
19844 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
19847 * Slide to the @b previous item, in a given slideshow widget
19849 * @param obj The slideshow object
19851 * The sliding animation @p obj is set to use will be the
19852 * transition effect used, after this call is issued.
19854 * @note If the beginning of the slideshow's internal list of items
19855 * is reached, it'll wrap around to the list's end, again.
19857 * @ingroup Slideshow
19859 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
19862 * Returns the list of sliding transition/effect names available, for a
19863 * given slideshow widget.
19865 * @param obj The slideshow object
19866 * @return The list of transitions (list of @b stringshared strings
19869 * The transitions, which come from @p obj's theme, must be an EDC
19870 * data item named @c "transitions" on the theme file, with (prefix)
19871 * names of EDC programs actually implementing them.
19873 * The available transitions for slideshows on the default theme are:
19874 * - @c "fade" - the current item fades out, while the new one
19875 * fades in to the slideshow's viewport.
19876 * - @c "black_fade" - the current item fades to black, and just
19877 * then, the new item will fade in.
19878 * - @c "horizontal" - the current item slides horizontally, until
19879 * it gets out of the slideshow's viewport, while the new item
19880 * comes from the left to take its place.
19881 * - @c "vertical" - the current item slides vertically, until it
19882 * gets out of the slideshow's viewport, while the new item comes
19883 * from the bottom to take its place.
19884 * - @c "square" - the new item starts to appear from the middle of
19885 * the current one, but with a tiny size, growing until its
19886 * target (full) size and covering the old one.
19888 * @warning The stringshared strings get no new references
19889 * exclusive to the user grabbing the list, here, so if you'd like
19890 * to use them out of this call's context, you'd better @c
19891 * eina_stringshare_ref() them.
19893 * @see elm_slideshow_transition_set()
19895 * @ingroup Slideshow
19897 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19900 * Set the current slide transition/effect in use for a given
19903 * @param obj The slideshow object
19904 * @param transition The new transition's name string
19906 * If @p transition is implemented in @p obj's theme (i.e., is
19907 * contained in the list returned by
19908 * elm_slideshow_transitions_get()), this new sliding effect will
19909 * be used on the widget.
19911 * @see elm_slideshow_transitions_get() for more details
19913 * @ingroup Slideshow
19915 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
19918 * Get the current slide transition/effect in use for a given
19921 * @param obj The slideshow object
19922 * @return The current transition's name
19924 * @see elm_slideshow_transition_set() for more details
19926 * @ingroup Slideshow
19928 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19931 * Set the interval between each image transition on a given
19932 * slideshow widget, <b>and start the slideshow, itself</b>
19934 * @param obj The slideshow object
19935 * @param timeout The new displaying timeout for images
19937 * After this call, the slideshow widget will start cycling its
19938 * view, sequentially and automatically, with the images of the
19939 * items it has. The time between each new image displayed is going
19940 * to be @p timeout, in @b seconds. If a different timeout was set
19941 * previously and an slideshow was in progress, it will continue
19942 * with the new time between transitions, after this call.
19944 * @note A value less than or equal to 0 on @p timeout will disable
19945 * the widget's internal timer, thus halting any slideshow which
19946 * could be happening on @p obj.
19948 * @see elm_slideshow_timeout_get()
19950 * @ingroup Slideshow
19952 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
19955 * Get the interval set for image transitions on a given slideshow
19958 * @param obj The slideshow object
19959 * @return Returns the timeout set on it
19961 * @see elm_slideshow_timeout_set() for more details
19963 * @ingroup Slideshow
19965 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19968 * Set if, after a slideshow is started, for a given slideshow
19969 * widget, its items should be displayed cyclically or not.
19971 * @param obj The slideshow object
19972 * @param loop Use @c EINA_TRUE to make it cycle through items or
19973 * @c EINA_FALSE for it to stop at the end of @p obj's internal
19976 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
19977 * ignore what is set by this functions, i.e., they'll @b always
19978 * cycle through items. This affects only the "automatic"
19979 * slideshow, as set by elm_slideshow_timeout_set().
19981 * @see elm_slideshow_loop_get()
19983 * @ingroup Slideshow
19985 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
19988 * Get if, after a slideshow is started, for a given slideshow
19989 * widget, its items are to be displayed cyclically or not.
19991 * @param obj The slideshow object
19992 * @return @c EINA_TRUE, if the items in @p obj will be cycled
19993 * through or @c EINA_FALSE, otherwise
19995 * @see elm_slideshow_loop_set() for more details
19997 * @ingroup Slideshow
19999 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20002 * Remove all items from a given slideshow widget
20004 * @param obj The slideshow object
20006 * This removes (and deletes) all items in @p obj, leaving it
20009 * @see elm_slideshow_item_del(), to remove just one item.
20011 * @ingroup Slideshow
20013 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20016 * Get the internal list of items in a given slideshow widget.
20018 * @param obj The slideshow object
20019 * @return The list of items (#Elm_Slideshow_Item as data) or
20020 * @c NULL on errors.
20022 * This list is @b not to be modified in any way and must not be
20023 * freed. Use the list members with functions like
20024 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
20026 * @warning This list is only valid until @p obj object's internal
20027 * items list is changed. It should be fetched again with another
20028 * call to this function when changes happen.
20030 * @ingroup Slideshow
20032 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20035 * Delete a given item from a slideshow widget.
20037 * @param item The slideshow item
20039 * @ingroup Slideshow
20041 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20044 * Return the data associated with a given slideshow item
20046 * @param item The slideshow item
20047 * @return Returns the data associated to this item
20049 * @ingroup Slideshow
20051 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20054 * Returns the currently displayed item, in a given slideshow widget
20056 * @param obj The slideshow object
20057 * @return A handle to the item being displayed in @p obj or
20058 * @c NULL, if none is (and on errors)
20060 * @ingroup Slideshow
20062 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20065 * Get the real Evas object created to implement the view of a
20066 * given slideshow item
20068 * @param item The slideshow item.
20069 * @return the Evas object implementing this item's view.
20071 * This returns the actual Evas object used to implement the
20072 * specified slideshow item's view. This may be @c NULL, as it may
20073 * not have been created or may have been deleted, at any time, by
20074 * the slideshow. <b>Do not modify this object</b> (move, resize,
20075 * show, hide, etc.), as the slideshow is controlling it. This
20076 * function is for querying, emitting custom signals or hooking
20077 * lower level callbacks for events on that object. Do not delete
20078 * this object under any circumstances.
20080 * @see elm_slideshow_item_data_get()
20082 * @ingroup Slideshow
20084 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
20087 * Get the the item, in a given slideshow widget, placed at
20088 * position @p nth, in its internal items list
20090 * @param obj The slideshow object
20091 * @param nth The number of the item to grab a handle to (0 being
20093 * @return The item stored in @p obj at position @p nth or @c NULL,
20094 * if there's no item with that index (and on errors)
20096 * @ingroup Slideshow
20098 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
20101 * Set the current slide layout in use for a given slideshow widget
20103 * @param obj The slideshow object
20104 * @param layout The new layout's name string
20106 * If @p layout is implemented in @p obj's theme (i.e., is contained
20107 * in the list returned by elm_slideshow_layouts_get()), this new
20108 * images layout will be used on the widget.
20110 * @see elm_slideshow_layouts_get() for more details
20112 * @ingroup Slideshow
20114 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
20117 * Get the current slide layout in use for a given slideshow widget
20119 * @param obj The slideshow object
20120 * @return The current layout's name
20122 * @see elm_slideshow_layout_set() for more details
20124 * @ingroup Slideshow
20126 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20129 * Returns the list of @b layout names available, for a given
20130 * slideshow widget.
20132 * @param obj The slideshow object
20133 * @return The list of layouts (list of @b stringshared strings
20136 * Slideshow layouts will change how the widget is to dispose each
20137 * image item in its viewport, with regard to cropping, scaling,
20140 * The layouts, which come from @p obj's theme, must be an EDC
20141 * data item name @c "layouts" on the theme file, with (prefix)
20142 * names of EDC programs actually implementing them.
20144 * The available layouts for slideshows on the default theme are:
20145 * - @c "fullscreen" - item images with original aspect, scaled to
20146 * touch top and down slideshow borders or, if the image's heigh
20147 * is not enough, left and right slideshow borders.
20148 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
20149 * one, but always leaving 10% of the slideshow's dimensions of
20150 * distance between the item image's borders and the slideshow
20151 * borders, for each axis.
20153 * @warning The stringshared strings get no new references
20154 * exclusive to the user grabbing the list, here, so if you'd like
20155 * to use them out of this call's context, you'd better @c
20156 * eina_stringshare_ref() them.
20158 * @see elm_slideshow_layout_set()
20160 * @ingroup Slideshow
20162 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20165 * Set the number of items to cache, on a given slideshow widget,
20166 * <b>before the current item</b>
20168 * @param obj The slideshow object
20169 * @param count Number of items to cache before the current one
20171 * The default value for this property is @c 2. See
20172 * @ref Slideshow_Caching "slideshow caching" for more details.
20174 * @see elm_slideshow_cache_before_get()
20176 * @ingroup Slideshow
20178 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20181 * Retrieve the number of items to cache, on a given slideshow widget,
20182 * <b>before the current item</b>
20184 * @param obj The slideshow object
20185 * @return The number of items set to be cached before the current one
20187 * @see elm_slideshow_cache_before_set() for more details
20189 * @ingroup Slideshow
20191 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20194 * Set the number of items to cache, on a given slideshow widget,
20195 * <b>after the current item</b>
20197 * @param obj The slideshow object
20198 * @param count Number of items to cache after the current one
20200 * The default value for this property is @c 2. See
20201 * @ref Slideshow_Caching "slideshow caching" for more details.
20203 * @see elm_slideshow_cache_after_get()
20205 * @ingroup Slideshow
20207 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20210 * Retrieve the number of items to cache, on a given slideshow widget,
20211 * <b>after the current item</b>
20213 * @param obj The slideshow object
20214 * @return The number of items set to be cached after the current one
20216 * @see elm_slideshow_cache_after_set() for more details
20218 * @ingroup Slideshow
20220 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20223 * Get the number of items stored in a given slideshow widget
20225 * @param obj The slideshow object
20226 * @return The number of items on @p obj, at the moment of this call
20228 * @ingroup Slideshow
20230 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20237 * @defgroup Fileselector File Selector
20239 * @image html img/widget/fileselector/preview-00.png
20240 * @image latex img/widget/fileselector/preview-00.eps
20242 * A file selector is a widget that allows a user to navigate
20243 * through a file system, reporting file selections back via its
20246 * It contains shortcut buttons for home directory (@c ~) and to
20247 * jump one directory upwards (..), as well as cancel/ok buttons to
20248 * confirm/cancel a given selection. After either one of those two
20249 * former actions, the file selector will issue its @c "done" smart
20252 * There's a text entry on it, too, showing the name of the current
20253 * selection. There's the possibility of making it editable, so it
20254 * is useful on file saving dialogs on applications, where one
20255 * gives a file name to save contents to, in a given directory in
20256 * the system. This custom file name will be reported on the @c
20257 * "done" smart callback (explained in sequence).
20259 * Finally, it has a view to display file system items into in two
20264 * If Elementary is built with support of the Ethumb thumbnailing
20265 * library, the second form of view will display preview thumbnails
20266 * of files which it supports.
20268 * Smart callbacks one can register to:
20270 * - @c "selected" - the user has clicked on a file (when not in
20271 * folders-only mode) or directory (when in folders-only mode)
20272 * - @c "directory,open" - the list has been populated with new
20273 * content (@c event_info is a pointer to the directory's
20274 * path, a @b stringshared string)
20275 * - @c "done" - the user has clicked on the "ok" or "cancel"
20276 * buttons (@c event_info is a pointer to the selection's
20277 * path, a @b stringshared string)
20279 * Here is an example on its usage:
20280 * @li @ref fileselector_example
20284 * @addtogroup Fileselector
20289 * Defines how a file selector widget is to layout its contents
20290 * (file system entries).
20292 typedef enum _Elm_Fileselector_Mode
20294 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
20295 ELM_FILESELECTOR_GRID, /**< layout as a grid */
20296 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
20297 } Elm_Fileselector_Mode;
20300 * Add a new file selector widget to the given parent Elementary
20301 * (container) object
20303 * @param parent The parent object
20304 * @return a new file selector widget handle or @c NULL, on errors
20306 * This function inserts a new file selector widget on the canvas.
20308 * @ingroup Fileselector
20310 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20313 * Enable/disable the file name entry box where the user can type
20314 * in a name for a file, in a given file selector widget
20316 * @param obj The file selector object
20317 * @param is_save @c EINA_TRUE to make the file selector a "saving
20318 * dialog", @c EINA_FALSE otherwise
20320 * Having the entry editable is useful on file saving dialogs on
20321 * applications, where one gives a file name to save contents to,
20322 * in a given directory in the system. This custom file name will
20323 * be reported on the @c "done" smart callback.
20325 * @see elm_fileselector_is_save_get()
20327 * @ingroup Fileselector
20329 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
20332 * Get whether the given file selector is in "saving dialog" mode
20334 * @param obj The file selector object
20335 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
20336 * mode, @c EINA_FALSE otherwise (and on errors)
20338 * @see elm_fileselector_is_save_set() for more details
20340 * @ingroup Fileselector
20342 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20345 * Enable/disable folder-only view for a given file selector widget
20347 * @param obj The file selector object
20348 * @param only @c EINA_TRUE to make @p obj only display
20349 * directories, @c EINA_FALSE to make files to be displayed in it
20352 * If enabled, the widget's view will only display folder items,
20355 * @see elm_fileselector_folder_only_get()
20357 * @ingroup Fileselector
20359 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
20362 * Get whether folder-only view is set for a given file selector
20365 * @param obj The file selector object
20366 * @return only @c EINA_TRUE if @p obj is only displaying
20367 * directories, @c EINA_FALSE if files are being displayed in it
20368 * too (and on errors)
20370 * @see elm_fileselector_folder_only_get()
20372 * @ingroup Fileselector
20374 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20377 * Enable/disable the "ok" and "cancel" buttons on a given file
20380 * @param obj The file selector object
20381 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
20383 * @note A file selector without those buttons will never emit the
20384 * @c "done" smart event, and is only usable if one is just hooking
20385 * to the other two events.
20387 * @see elm_fileselector_buttons_ok_cancel_get()
20389 * @ingroup Fileselector
20391 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
20394 * Get whether the "ok" and "cancel" buttons on a given file
20395 * selector widget are being shown.
20397 * @param obj The file selector object
20398 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
20399 * otherwise (and on errors)
20401 * @see elm_fileselector_buttons_ok_cancel_set() for more details
20403 * @ingroup Fileselector
20405 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20408 * Enable/disable a tree view in the given file selector widget,
20409 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
20411 * @param obj The file selector object
20412 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
20415 * In a tree view, arrows are created on the sides of directories,
20416 * allowing them to expand in place.
20418 * @note If it's in other mode, the changes made by this function
20419 * will only be visible when one switches back to "list" mode.
20421 * @see elm_fileselector_expandable_get()
20423 * @ingroup Fileselector
20425 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
20428 * Get whether tree view is enabled for the given file selector
20431 * @param obj The file selector object
20432 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
20433 * otherwise (and or errors)
20435 * @see elm_fileselector_expandable_set() for more details
20437 * @ingroup Fileselector
20439 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20442 * Set, programmatically, the @b directory that a given file
20443 * selector widget will display contents from
20445 * @param obj The file selector object
20446 * @param path The path to display in @p obj
20448 * This will change the @b directory that @p obj is displaying. It
20449 * will also clear the text entry area on the @p obj object, which
20450 * displays select files' names.
20452 * @see elm_fileselector_path_get()
20454 * @ingroup Fileselector
20456 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
20459 * Get the parent directory's path that a given file selector
20460 * widget is displaying
20462 * @param obj The file selector object
20463 * @return The (full) path of the directory the file selector is
20464 * displaying, a @b stringshared string
20466 * @see elm_fileselector_path_set()
20468 * @ingroup Fileselector
20470 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20473 * Set, programmatically, the currently selected file/directory in
20474 * the given file selector widget
20476 * @param obj The file selector object
20477 * @param path The (full) path to a file or directory
20478 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
20479 * latter case occurs if the directory or file pointed to do not
20482 * @see elm_fileselector_selected_get()
20484 * @ingroup Fileselector
20486 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
20489 * Get the currently selected item's (full) path, in the given file
20492 * @param obj The file selector object
20493 * @return The absolute path of the selected item, a @b
20494 * stringshared string
20496 * @note Custom editions on @p obj object's text entry, if made,
20497 * will appear on the return string of this function, naturally.
20499 * @see elm_fileselector_selected_set() for more details
20501 * @ingroup Fileselector
20503 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20506 * Set the mode in which a given file selector widget will display
20507 * (layout) file system entries in its view
20509 * @param obj The file selector object
20510 * @param mode The mode of the fileselector, being it one of
20511 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
20512 * first one, naturally, will display the files in a list. The
20513 * latter will make the widget to display its entries in a grid
20516 * @note By using elm_fileselector_expandable_set(), the user may
20517 * trigger a tree view for that list.
20519 * @note If Elementary is built with support of the Ethumb
20520 * thumbnailing library, the second form of view will display
20521 * preview thumbnails of files which it supports. You must have
20522 * elm_need_ethumb() called in your Elementary for thumbnailing to
20525 * @see elm_fileselector_expandable_set().
20526 * @see elm_fileselector_mode_get().
20528 * @ingroup Fileselector
20530 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
20533 * Get the mode in which a given file selector widget is displaying
20534 * (layouting) file system entries in its view
20536 * @param obj The fileselector object
20537 * @return The mode in which the fileselector is at
20539 * @see elm_fileselector_mode_set() for more details
20541 * @ingroup Fileselector
20543 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20550 * @defgroup Progressbar Progress bar
20552 * The progress bar is a widget for visually representing the
20553 * progress status of a given job/task.
20555 * A progress bar may be horizontal or vertical. It may display an
20556 * icon besides it, as well as primary and @b units labels. The
20557 * former is meant to label the widget as a whole, while the
20558 * latter, which is formatted with floating point values (and thus
20559 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
20560 * units"</c>), is meant to label the widget's <b>progress
20561 * value</b>. Label, icon and unit strings/objects are @b optional
20562 * for progress bars.
20564 * A progress bar may be @b inverted, in which state it gets its
20565 * values inverted, with high values being on the left or top and
20566 * low values on the right or bottom, as opposed to normally have
20567 * the low values on the former and high values on the latter,
20568 * respectively, for horizontal and vertical modes.
20570 * The @b span of the progress, as set by
20571 * elm_progressbar_span_size_set(), is its length (horizontally or
20572 * vertically), unless one puts size hints on the widget to expand
20573 * on desired directions, by any container. That length will be
20574 * scaled by the object or applications scaling factor. At any
20575 * point code can query the progress bar for its value with
20576 * elm_progressbar_value_get().
20578 * Available widget styles for progress bars:
20580 * - @c "wheel" (simple style, no text, no progression, only
20581 * "pulse" effect is available)
20583 * Default contents parts of the progressbar widget that you can use for are:
20584 * @li "elm.swallow.content" - A icon of the progressbar
20586 * Here is an example on its usage:
20587 * @li @ref progressbar_example
20591 * Add a new progress bar widget to the given parent Elementary
20592 * (container) object
20594 * @param parent The parent object
20595 * @return a new progress bar widget handle or @c NULL, on errors
20597 * This function inserts a new progress bar widget on the canvas.
20599 * @ingroup Progressbar
20601 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20604 * Set whether a given progress bar widget is at "pulsing mode" or
20607 * @param obj The progress bar object
20608 * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
20609 * @c EINA_FALSE to put it back to its default one
20611 * By default, progress bars will display values from the low to
20612 * high value boundaries. There are, though, contexts in which the
20613 * state of progression of a given task is @b unknown. For those,
20614 * one can set a progress bar widget to a "pulsing state", to give
20615 * the user an idea that some computation is being held, but
20616 * without exact progress values. In the default theme it will
20617 * animate its bar with the contents filling in constantly and back
20618 * to non-filled, in a loop. To start and stop this pulsing
20619 * animation, one has to explicitly call elm_progressbar_pulse().
20621 * @see elm_progressbar_pulse_get()
20622 * @see elm_progressbar_pulse()
20624 * @ingroup Progressbar
20626 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
20629 * Get whether a given progress bar widget is at "pulsing mode" or
20632 * @param obj The progress bar object
20633 * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
20634 * if it's in the default one (and on errors)
20636 * @ingroup Progressbar
20638 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20641 * Start/stop a given progress bar "pulsing" animation, if its
20644 * @param obj The progress bar object
20645 * @param state @c EINA_TRUE, to @b start the pulsing animation,
20646 * @c EINA_FALSE to @b stop it
20648 * @note This call won't do anything if @p obj is not under "pulsing mode".
20650 * @see elm_progressbar_pulse_set() for more details.
20652 * @ingroup Progressbar
20654 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
20657 * Set the progress value (in percentage) on a given progress bar
20660 * @param obj The progress bar object
20661 * @param val The progress value (@b must be between @c 0.0 and @c
20664 * Use this call to set progress bar levels.
20666 * @note If you passes a value out of the specified range for @p
20667 * val, it will be interpreted as the @b closest of the @b boundary
20668 * values in the range.
20670 * @ingroup Progressbar
20672 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
20675 * Get the progress value (in percentage) on a given progress bar
20678 * @param obj The progress bar object
20679 * @return The value of the progressbar
20681 * @see elm_progressbar_value_set() for more details
20683 * @ingroup Progressbar
20685 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20688 * Set the label of a given progress bar widget
20690 * @param obj The progress bar object
20691 * @param label The text label string, in UTF-8
20693 * @ingroup Progressbar
20694 * @deprecated use elm_object_text_set() instead.
20696 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
20699 * Get the label of a given progress bar widget
20701 * @param obj The progressbar object
20702 * @return The text label string, in UTF-8
20704 * @ingroup Progressbar
20705 * @deprecated use elm_object_text_set() instead.
20707 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20710 * Set the icon object of a given progress bar widget
20712 * @param obj The progress bar object
20713 * @param icon The icon object
20715 * Use this call to decorate @p obj with an icon next to it.
20717 * @note Once the icon object is set, a previously set one will be
20718 * deleted. If you want to keep that old content object, use the
20719 * elm_progressbar_icon_unset() function.
20721 * @see elm_progressbar_icon_get()
20722 * @deprecated use elm_object_content_set() instead.
20724 * @ingroup Progressbar
20726 EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
20729 * Retrieve the icon object set for a given progress bar widget
20731 * @param obj The progress bar object
20732 * @return The icon object's handle, if @p obj had one set, or @c NULL,
20733 * otherwise (and on errors)
20735 * @see elm_progressbar_icon_set() for more details
20736 * @deprecated use elm_object_content_set() instead.
20738 * @ingroup Progressbar
20740 EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20743 * Unset an icon set on a given progress bar widget
20745 * @param obj The progress bar object
20746 * @return The icon object that was being used, if any was set, or
20747 * @c NULL, otherwise (and on errors)
20749 * This call will unparent and return the icon object which was set
20750 * for this widget, previously, on success.
20752 * @see elm_progressbar_icon_set() for more details
20753 * @deprecated use elm_object_content_unset() instead.
20755 * @ingroup Progressbar
20757 EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20760 * Set the (exact) length of the bar region of a given progress bar
20763 * @param obj The progress bar object
20764 * @param size The length of the progress bar's bar region
20766 * This sets the minimum width (when in horizontal mode) or height
20767 * (when in vertical mode) of the actual bar area of the progress
20768 * bar @p obj. This in turn affects the object's minimum size. Use
20769 * this when you're not setting other size hints expanding on the
20770 * given direction (like weight and alignment hints) and you would
20771 * like it to have a specific size.
20773 * @note Icon, label and unit text around @p obj will require their
20774 * own space, which will make @p obj to require more the @p size,
20777 * @see elm_progressbar_span_size_get()
20779 * @ingroup Progressbar
20781 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
20784 * Get the length set for the bar region of a given progress bar
20787 * @param obj The progress bar object
20788 * @return The length of the progress bar's bar region
20790 * If that size was not set previously, with
20791 * elm_progressbar_span_size_set(), this call will return @c 0.
20793 * @ingroup Progressbar
20795 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20798 * Set the format string for a given progress bar widget's units
20801 * @param obj The progress bar object
20802 * @param format The format string for @p obj's units label
20804 * If @c NULL is passed on @p format, it will make @p obj's units
20805 * area to be hidden completely. If not, it'll set the <b>format
20806 * string</b> for the units label's @b text. The units label is
20807 * provided a floating point value, so the units text is up display
20808 * at most one floating point falue. Note that the units label is
20809 * optional. Use a format string such as "%1.2f meters" for
20812 * @note The default format string for a progress bar is an integer
20813 * percentage, as in @c "%.0f %%".
20815 * @see elm_progressbar_unit_format_get()
20817 * @ingroup Progressbar
20819 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
20822 * Retrieve the format string set for a given progress bar widget's
20825 * @param obj The progress bar object
20826 * @return The format set string for @p obj's units label or
20827 * @c NULL, if none was set (and on errors)
20829 * @see elm_progressbar_unit_format_set() for more details
20831 * @ingroup Progressbar
20833 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20836 * Set the orientation of a given progress bar widget
20838 * @param obj The progress bar object
20839 * @param horizontal Use @c EINA_TRUE to make @p obj to be
20840 * @b horizontal, @c EINA_FALSE to make it @b vertical
20842 * Use this function to change how your progress bar is to be
20843 * disposed: vertically or horizontally.
20845 * @see elm_progressbar_horizontal_get()
20847 * @ingroup Progressbar
20849 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
20852 * Retrieve the orientation of a given progress bar widget
20854 * @param obj The progress bar object
20855 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
20856 * @c EINA_FALSE if it's @b vertical (and on errors)
20858 * @see elm_progressbar_horizontal_set() for more details
20860 * @ingroup Progressbar
20862 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20865 * Invert a given progress bar widget's displaying values order
20867 * @param obj The progress bar object
20868 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
20869 * @c EINA_FALSE to bring it back to default, non-inverted values.
20871 * A progress bar may be @b inverted, in which state it gets its
20872 * values inverted, with high values being on the left or top and
20873 * low values on the right or bottom, as opposed to normally have
20874 * the low values on the former and high values on the latter,
20875 * respectively, for horizontal and vertical modes.
20877 * @see elm_progressbar_inverted_get()
20879 * @ingroup Progressbar
20881 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
20884 * Get whether a given progress bar widget's displaying values are
20887 * @param obj The progress bar object
20888 * @return @c EINA_TRUE, if @p obj has inverted values,
20889 * @c EINA_FALSE otherwise (and on errors)
20891 * @see elm_progressbar_inverted_set() for more details
20893 * @ingroup Progressbar
20895 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20898 * @defgroup Separator Separator
20900 * @brief Separator is a very thin object used to separate other objects.
20902 * A separator can be vertical or horizontal.
20904 * @ref tutorial_separator is a good example of how to use a separator.
20908 * @brief Add a separator object to @p parent
20910 * @param parent The parent object
20912 * @return The separator object, or NULL upon failure
20914 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20916 * @brief Set the horizontal mode of a separator object
20918 * @param obj The separator object
20919 * @param horizontal If true, the separator is horizontal
20921 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
20923 * @brief Get the horizontal mode of a separator object
20925 * @param obj The separator object
20926 * @return If true, the separator is horizontal
20928 * @see elm_separator_horizontal_set()
20930 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20936 * @addtogroup Spinner
20941 * Add a new spinner widget to the given parent Elementary
20942 * (container) object.
20944 * @param parent The parent object.
20945 * @return a new spinner widget handle or @c NULL, on errors.
20947 * This function inserts a new spinner widget on the canvas.
20952 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20955 * Set the format string of the displayed label.
20957 * @param obj The spinner object.
20958 * @param fmt The format string for the label display.
20960 * If @c NULL, this sets the format to "%.0f". If not it sets the format
20961 * string for the label text. The label text is provided a floating point
20962 * value, so the label text can display up to 1 floating point value.
20963 * Note that this is optional.
20965 * Use a format string such as "%1.2f meters" for example, and it will
20966 * display values like: "3.14 meters" for a value equal to 3.14159.
20968 * Default is "%0.f".
20970 * @see elm_spinner_label_format_get()
20974 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
20977 * Get the label format of the spinner.
20979 * @param obj The spinner object.
20980 * @return The text label format string in UTF-8.
20982 * @see elm_spinner_label_format_set() for details.
20986 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20989 * Set the minimum and maximum values for the spinner.
20991 * @param obj The spinner object.
20992 * @param min The minimum value.
20993 * @param max The maximum value.
20995 * Define the allowed range of values to be selected by the user.
20997 * If actual value is less than @p min, it will be updated to @p min. If it
20998 * is bigger then @p max, will be updated to @p max. Actual value can be
20999 * get with elm_spinner_value_get().
21001 * By default, min is equal to 0, and max is equal to 100.
21003 * @warning Maximum must be greater than minimum.
21005 * @see elm_spinner_min_max_get()
21009 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
21012 * Get the minimum and maximum values of the spinner.
21014 * @param obj The spinner object.
21015 * @param min Pointer where to store the minimum value.
21016 * @param max Pointer where to store the maximum value.
21018 * @note If only one value is needed, the other pointer can be passed
21021 * @see elm_spinner_min_max_set() for details.
21025 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
21028 * Set the step used to increment or decrement the spinner value.
21030 * @param obj The spinner object.
21031 * @param step The step value.
21033 * This value will be incremented or decremented to the displayed value.
21034 * It will be incremented while the user keep right or top arrow pressed,
21035 * and will be decremented while the user keep left or bottom arrow pressed.
21037 * The interval to increment / decrement can be set with
21038 * elm_spinner_interval_set().
21040 * By default step value is equal to 1.
21042 * @see elm_spinner_step_get()
21046 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
21049 * Get the step used to increment or decrement the spinner value.
21051 * @param obj The spinner object.
21052 * @return The step value.
21054 * @see elm_spinner_step_get() for more details.
21058 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21061 * Set the value the spinner displays.
21063 * @param obj The spinner object.
21064 * @param val The value to be displayed.
21066 * Value will be presented on the label following format specified with
21067 * elm_spinner_format_set().
21069 * @warning The value must to be between min and max values. This values
21070 * are set by elm_spinner_min_max_set().
21072 * @see elm_spinner_value_get().
21073 * @see elm_spinner_format_set().
21074 * @see elm_spinner_min_max_set().
21078 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21081 * Get the value displayed by the spinner.
21083 * @param obj The spinner object.
21084 * @return The value displayed.
21086 * @see elm_spinner_value_set() for details.
21090 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21093 * Set whether the spinner should wrap when it reaches its
21094 * minimum or maximum value.
21096 * @param obj The spinner object.
21097 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
21100 * Disabled by default. If disabled, when the user tries to increment the
21102 * but displayed value plus step value is bigger than maximum value,
21104 * won't allow it. The same happens when the user tries to decrement it,
21105 * but the value less step is less than minimum value.
21107 * When wrap is enabled, in such situations it will allow these changes,
21108 * but will get the value that would be less than minimum and subtracts
21109 * from maximum. Or add the value that would be more than maximum to
21113 * @li min value = 10
21114 * @li max value = 50
21115 * @li step value = 20
21116 * @li displayed value = 20
21118 * When the user decrement value (using left or bottom arrow), it will
21119 * displays @c 40, because max - (min - (displayed - step)) is
21120 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
21122 * @see elm_spinner_wrap_get().
21126 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
21129 * Get whether the spinner should wrap when it reaches its
21130 * minimum or maximum value.
21132 * @param obj The spinner object
21133 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
21134 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21136 * @see elm_spinner_wrap_set() for details.
21140 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21143 * Set whether the spinner can be directly edited by the user or not.
21145 * @param obj The spinner object.
21146 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
21147 * don't allow users to edit it directly.
21149 * Spinner objects can have edition @b disabled, in which state they will
21150 * be changed only by arrows.
21151 * Useful for contexts
21152 * where you don't want your users to interact with it writting the value.
21154 * when using special values, the user can see real value instead
21155 * of special label on edition.
21157 * It's enabled by default.
21159 * @see elm_spinner_editable_get()
21163 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
21166 * Get whether the spinner can be directly edited by the user or not.
21168 * @param obj The spinner object.
21169 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
21170 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21172 * @see elm_spinner_editable_set() for details.
21176 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21179 * Set a special string to display in the place of the numerical value.
21181 * @param obj The spinner object.
21182 * @param value The value to be replaced.
21183 * @param label The label to be used.
21185 * It's useful for cases when a user should select an item that is
21186 * better indicated by a label than a value. For example, weekdays or months.
21190 * sp = elm_spinner_add(win);
21191 * elm_spinner_min_max_set(sp, 1, 3);
21192 * elm_spinner_special_value_add(sp, 1, "January");
21193 * elm_spinner_special_value_add(sp, 2, "February");
21194 * elm_spinner_special_value_add(sp, 3, "March");
21195 * evas_object_show(sp);
21200 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
21203 * Set the interval on time updates for an user mouse button hold
21204 * on spinner widgets' arrows.
21206 * @param obj The spinner object.
21207 * @param interval The (first) interval value in seconds.
21209 * This interval value is @b decreased while the user holds the
21210 * mouse pointer either incrementing or decrementing spinner's value.
21212 * This helps the user to get to a given value distant from the
21213 * current one easier/faster, as it will start to change quicker and
21214 * quicker on mouse button holds.
21216 * The calculation for the next change interval value, starting from
21217 * the one set with this call, is the previous interval divided by
21218 * @c 1.05, so it decreases a little bit.
21220 * The default starting interval value for automatic changes is
21223 * @see elm_spinner_interval_get()
21227 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21230 * Get the interval on time updates for an user mouse button hold
21231 * on spinner widgets' arrows.
21233 * @param obj The spinner object.
21234 * @return The (first) interval value, in seconds, set on it.
21236 * @see elm_spinner_interval_set() for more details.
21240 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21247 * @defgroup Index Index
21249 * @image html img/widget/index/preview-00.png
21250 * @image latex img/widget/index/preview-00.eps
21252 * An index widget gives you an index for fast access to whichever
21253 * group of other UI items one might have. It's a list of text
21254 * items (usually letters, for alphabetically ordered access).
21256 * Index widgets are by default hidden and just appear when the
21257 * user clicks over it's reserved area in the canvas. In its
21258 * default theme, it's an area one @ref Fingers "finger" wide on
21259 * the right side of the index widget's container.
21261 * When items on the index are selected, smart callbacks get
21262 * called, so that its user can make other container objects to
21263 * show a given area or child object depending on the index item
21264 * selected. You'd probably be using an index together with @ref
21265 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
21268 * Smart events one can add callbacks for are:
21269 * - @c "changed" - When the selected index item changes. @c
21270 * event_info is the selected item's data pointer.
21271 * - @c "delay,changed" - When the selected index item changes, but
21272 * after a small idling period. @c event_info is the selected
21273 * item's data pointer.
21274 * - @c "selected" - When the user releases a mouse button and
21275 * selects an item. @c event_info is the selected item's data
21277 * - @c "level,up" - when the user moves a finger from the first
21278 * level to the second level
21279 * - @c "level,down" - when the user moves a finger from the second
21280 * level to the first level
21282 * The @c "delay,changed" event is so that it'll wait a small time
21283 * before actually reporting those events and, moreover, just the
21284 * last event happening on those time frames will actually be
21287 * Here are some examples on its usage:
21288 * @li @ref index_example_01
21289 * @li @ref index_example_02
21293 * @addtogroup Index
21297 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
21300 * Add a new index widget to the given parent Elementary
21301 * (container) object
21303 * @param parent The parent object
21304 * @return a new index widget handle or @c NULL, on errors
21306 * This function inserts a new index widget on the canvas.
21310 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21313 * Set whether a given index widget is or not visible,
21316 * @param obj The index object
21317 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
21319 * Not to be confused with visible as in @c evas_object_show() --
21320 * visible with regard to the widget's auto hiding feature.
21322 * @see elm_index_active_get()
21326 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
21329 * Get whether a given index widget is currently visible or not.
21331 * @param obj The index object
21332 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
21334 * @see elm_index_active_set() for more details
21338 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21341 * Set the items level for a given index widget.
21343 * @param obj The index object.
21344 * @param level @c 0 or @c 1, the currently implemented levels.
21346 * @see elm_index_item_level_get()
21350 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21353 * Get the items level set for a given index widget.
21355 * @param obj The index object.
21356 * @return @c 0 or @c 1, which are the levels @p obj might be at.
21358 * @see elm_index_item_level_set() for more information
21362 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21365 * Returns the last selected item's data, for a given index widget.
21367 * @param obj The index object.
21368 * @return The item @b data associated to the last selected item on
21369 * @p obj (or @c NULL, on errors).
21371 * @warning The returned value is @b not an #Elm_Index_Item item
21372 * handle, but the data associated to it (see the @c item parameter
21373 * in elm_index_item_append(), as an example).
21377 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21380 * Append a new item on a given index widget.
21382 * @param obj The index object.
21383 * @param letter Letter under which the item should be indexed
21384 * @param item The item data to set for the index's item
21386 * Despite the most common usage of the @p letter argument is for
21387 * single char strings, one could use arbitrary strings as index
21390 * @c item will be the pointer returned back on @c "changed", @c
21391 * "delay,changed" and @c "selected" smart events.
21395 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21398 * Prepend a new item on a given index widget.
21400 * @param obj The index object.
21401 * @param letter Letter under which the item should be indexed
21402 * @param item The item data to set for the index's item
21404 * Despite the most common usage of the @p letter argument is for
21405 * single char strings, one could use arbitrary strings as index
21408 * @c item will be the pointer returned back on @c "changed", @c
21409 * "delay,changed" and @c "selected" smart events.
21413 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21416 * Append a new item, on a given index widget, <b>after the item
21417 * having @p relative as data</b>.
21419 * @param obj The index object.
21420 * @param letter Letter under which the item should be indexed
21421 * @param item The item data to set for the index's item
21422 * @param relative The item data of the index item to be the
21423 * predecessor of this new one
21425 * Despite the most common usage of the @p letter argument is for
21426 * single char strings, one could use arbitrary strings as index
21429 * @c item will be the pointer returned back on @c "changed", @c
21430 * "delay,changed" and @c "selected" smart events.
21432 * @note If @p relative is @c NULL or if it's not found to be data
21433 * set on any previous item on @p obj, this function will behave as
21434 * elm_index_item_append().
21438 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
21441 * Prepend a new item, on a given index widget, <b>after the item
21442 * having @p relative as data</b>.
21444 * @param obj The index object.
21445 * @param letter Letter under which the item should be indexed
21446 * @param item The item data to set for the index's item
21447 * @param relative The item data of the index item to be the
21448 * successor of this new one
21450 * Despite the most common usage of the @p letter argument is for
21451 * single char strings, one could use arbitrary strings as index
21454 * @c item will be the pointer returned back on @c "changed", @c
21455 * "delay,changed" and @c "selected" smart events.
21457 * @note If @p relative is @c NULL or if it's not found to be data
21458 * set on any previous item on @p obj, this function will behave as
21459 * elm_index_item_prepend().
21463 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
21466 * Insert a new item into the given index widget, using @p cmp_func
21467 * function to sort items (by item handles).
21469 * @param obj The index object.
21470 * @param letter Letter under which the item should be indexed
21471 * @param item The item data to set for the index's item
21472 * @param cmp_func The comparing function to be used to sort index
21473 * items <b>by #Elm_Index_Item item handles</b>
21474 * @param cmp_data_func A @b fallback function to be called for the
21475 * sorting of index items <b>by item data</b>). It will be used
21476 * when @p cmp_func returns @c 0 (equality), which means an index
21477 * item with provided item data already exists. To decide which
21478 * data item should be pointed to by the index item in question, @p
21479 * cmp_data_func will be used. If @p cmp_data_func returns a
21480 * non-negative value, the previous index item data will be
21481 * replaced by the given @p item pointer. If the previous data need
21482 * to be freed, it should be done by the @p cmp_data_func function,
21483 * because all references to it will be lost. If this function is
21484 * not provided (@c NULL is given), index items will be @b
21485 * duplicated, if @p cmp_func returns @c 0.
21487 * Despite the most common usage of the @p letter argument is for
21488 * single char strings, one could use arbitrary strings as index
21491 * @c item will be the pointer returned back on @c "changed", @c
21492 * "delay,changed" and @c "selected" smart events.
21496 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);
21499 * Remove an item from a given index widget, <b>to be referenced by
21500 * it's data value</b>.
21502 * @param obj The index object
21503 * @param item The item's data pointer for the item to be removed
21506 * If a deletion callback is set, via elm_index_item_del_cb_set(),
21507 * that callback function will be called by this one.
21509 * @warning The item to be removed from @p obj will be found via
21510 * its item data pointer, and not by an #Elm_Index_Item handle.
21514 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
21517 * Find a given index widget's item, <b>using item data</b>.
21519 * @param obj The index object
21520 * @param item The item data pointed to by the desired index item
21521 * @return The index item handle, if found, or @c NULL otherwise
21525 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
21528 * Removes @b all items from a given index widget.
21530 * @param obj The index object.
21532 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
21533 * that callback function will be called for each item in @p obj.
21537 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
21540 * Go to a given items level on a index widget
21542 * @param obj The index object
21543 * @param level The index level (one of @c 0 or @c 1)
21547 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21550 * Return the data associated with a given index widget item
21552 * @param it The index widget item handle
21553 * @return The data associated with @p it
21555 * @see elm_index_item_data_set()
21559 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
21562 * Set the data associated with a given index widget item
21564 * @param it The index widget item handle
21565 * @param data The new data pointer to set to @p it
21567 * This sets new item data on @p it.
21569 * @warning The old data pointer won't be touched by this function, so
21570 * the user had better to free that old data himself/herself.
21574 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
21577 * Set the function to be called when a given index widget item is freed.
21579 * @param it The item to set the callback on
21580 * @param func The function to call on the item's deletion
21582 * When called, @p func will have both @c data and @c event_info
21583 * arguments with the @p it item's data value and, naturally, the
21584 * @c obj argument with a handle to the parent index widget.
21588 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
21591 * Get the letter (string) set on a given index widget item.
21593 * @param it The index item handle
21594 * @return The letter string set on @p it
21598 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
21602 EAPI void elm_index_button_image_invisible_set(Evas_Object *obj, Eina_Bool invisible) EINA_ARG_NONNULL(1);
21609 * @defgroup Photocam Photocam
21611 * @image html img/widget/photocam/preview-00.png
21612 * @image latex img/widget/photocam/preview-00.eps
21614 * This is a widget specifically for displaying high-resolution digital
21615 * camera photos giving speedy feedback (fast load), low memory footprint
21616 * and zooming and panning as well as fitting logic. It is entirely focused
21617 * on jpeg images, and takes advantage of properties of the jpeg format (via
21618 * evas loader features in the jpeg loader).
21620 * Signals that you can add callbacks for are:
21621 * @li "clicked" - This is called when a user has clicked the photo without
21623 * @li "press" - This is called when a user has pressed down on the photo.
21624 * @li "longpressed" - This is called when a user has pressed down on the
21625 * photo for a long time without dragging around.
21626 * @li "clicked,double" - This is called when a user has double-clicked the
21628 * @li "load" - Photo load begins.
21629 * @li "loaded" - This is called when the image file load is complete for the
21630 * first view (low resolution blurry version).
21631 * @li "load,detail" - Photo detailed data load begins.
21632 * @li "loaded,detail" - This is called when the image file load is complete
21633 * for the detailed image data (full resolution needed).
21634 * @li "zoom,start" - Zoom animation started.
21635 * @li "zoom,stop" - Zoom animation stopped.
21636 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
21637 * @li "scroll" - the content has been scrolled (moved)
21638 * @li "scroll,anim,start" - scrolling animation has started
21639 * @li "scroll,anim,stop" - scrolling animation has stopped
21640 * @li "scroll,drag,start" - dragging the contents around has started
21641 * @li "scroll,drag,stop" - dragging the contents around has stopped
21643 * @ref tutorial_photocam shows the API in action.
21647 * @brief Types of zoom available.
21649 typedef enum _Elm_Photocam_Zoom_Mode
21651 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
21652 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
21653 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
21654 ELM_PHOTOCAM_ZOOM_MODE_LAST
21655 } Elm_Photocam_Zoom_Mode;
21657 * @brief Add a new Photocam object
21659 * @param parent The parent object
21660 * @return The new object or NULL if it cannot be created
21662 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21664 * @brief Set the photo file to be shown
21666 * @param obj The photocam object
21667 * @param file The photo file
21668 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
21670 * This sets (and shows) the specified file (with a relative or absolute
21671 * path) and will return a load error (same error that
21672 * evas_object_image_load_error_get() will return). The image will change and
21673 * adjust its size at this point and begin a background load process for this
21674 * photo that at some time in the future will be displayed at the full
21677 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
21679 * @brief Returns the path of the current image file
21681 * @param obj The photocam object
21682 * @return Returns the path
21684 * @see elm_photocam_file_set()
21686 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21688 * @brief Set the zoom level of the photo
21690 * @param obj The photocam object
21691 * @param zoom The zoom level to set
21693 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
21694 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
21695 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
21696 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
21699 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
21701 * @brief Get the zoom level of the photo
21703 * @param obj The photocam object
21704 * @return The current zoom level
21706 * This returns the current zoom level of the photocam object. Note that if
21707 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
21708 * (which is the default), the zoom level may be changed at any time by the
21709 * photocam object itself to account for photo size and photocam viewpoer
21712 * @see elm_photocam_zoom_set()
21713 * @see elm_photocam_zoom_mode_set()
21715 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21717 * @brief Set the zoom mode
21719 * @param obj The photocam object
21720 * @param mode The desired mode
21722 * This sets the zoom mode to manual or one of several automatic levels.
21723 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
21724 * elm_photocam_zoom_set() and will stay at that level until changed by code
21725 * or until zoom mode is changed. This is the default mode. The Automatic
21726 * modes will allow the photocam object to automatically adjust zoom mode
21727 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
21728 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
21729 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
21730 * pixels within the frame are left unfilled.
21732 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
21734 * @brief Get the zoom mode
21736 * @param obj The photocam object
21737 * @return The current zoom mode
21739 * This gets the current zoom mode of the photocam object.
21741 * @see elm_photocam_zoom_mode_set()
21743 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21745 * @brief Get the current image pixel width and height
21747 * @param obj The photocam object
21748 * @param w A pointer to the width return
21749 * @param h A pointer to the height return
21751 * This gets the current photo pixel width and height (for the original).
21752 * The size will be returned in the integers @p w and @p h that are pointed
21755 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
21757 * @brief Get the area of the image that is currently shown
21760 * @param x A pointer to the X-coordinate of region
21761 * @param y A pointer to the Y-coordinate of region
21762 * @param w A pointer to the width
21763 * @param h A pointer to the height
21765 * @see elm_photocam_image_region_show()
21766 * @see elm_photocam_image_region_bring_in()
21768 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
21770 * @brief Set the viewed portion of the image
21772 * @param obj The photocam object
21773 * @param x X-coordinate of region in image original pixels
21774 * @param y Y-coordinate of region in image original pixels
21775 * @param w Width of region in image original pixels
21776 * @param h Height of region in image original pixels
21778 * This shows the region of the image without using animation.
21780 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
21782 * @brief Bring in the viewed portion of the image
21784 * @param obj The photocam object
21785 * @param x X-coordinate of region in image original pixels
21786 * @param y Y-coordinate of region in image original pixels
21787 * @param w Width of region in image original pixels
21788 * @param h Height of region in image original pixels
21790 * This shows the region of the image using animation.
21792 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
21794 * @brief Set the paused state for photocam
21796 * @param obj The photocam object
21797 * @param paused The pause state to set
21799 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
21800 * photocam. The default is off. This will stop zooming using animation on
21801 * zoom levels changes and change instantly. This will stop any existing
21802 * animations that are running.
21804 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
21806 * @brief Get the paused state for photocam
21808 * @param obj The photocam object
21809 * @return The current paused state
21811 * This gets the current paused state for the photocam object.
21813 * @see elm_photocam_paused_set()
21815 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21817 * @brief Get the internal low-res image used for photocam
21819 * @param obj The photocam object
21820 * @return The internal image object handle, or NULL if none exists
21822 * This gets the internal image object inside photocam. Do not modify it. It
21823 * is for inspection only, and hooking callbacks to. Nothing else. It may be
21824 * deleted at any time as well.
21826 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21828 * @brief Set the photocam scrolling bouncing.
21830 * @param obj The photocam object
21831 * @param h_bounce bouncing for horizontal
21832 * @param v_bounce bouncing for vertical
21834 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
21836 * @brief Get the photocam scrolling bouncing.
21838 * @param obj The photocam object
21839 * @param h_bounce bouncing for horizontal
21840 * @param v_bounce bouncing for vertical
21842 * @see elm_photocam_bounce_set()
21844 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
21850 * @defgroup Map Map
21851 * @ingroup Elementary
21853 * @image html img/widget/map/preview-00.png
21854 * @image latex img/widget/map/preview-00.eps
21856 * This is a widget specifically for displaying a map. It uses basically
21857 * OpenStreetMap provider http://www.openstreetmap.org/,
21858 * but custom providers can be added.
21860 * It supports some basic but yet nice features:
21861 * @li zoom and scroll
21862 * @li markers with content to be displayed when user clicks over it
21863 * @li group of markers
21866 * Smart callbacks one can listen to:
21868 * - "clicked" - This is called when a user has clicked the map without
21870 * - "press" - This is called when a user has pressed down on the map.
21871 * - "longpressed" - This is called when a user has pressed down on the map
21872 * for a long time without dragging around.
21873 * - "clicked,double" - This is called when a user has double-clicked
21875 * - "load,detail" - Map detailed data load begins.
21876 * - "loaded,detail" - This is called when all currently visible parts of
21877 * the map are loaded.
21878 * - "zoom,start" - Zoom animation started.
21879 * - "zoom,stop" - Zoom animation stopped.
21880 * - "zoom,change" - Zoom changed when using an auto zoom mode.
21881 * - "scroll" - the content has been scrolled (moved).
21882 * - "scroll,anim,start" - scrolling animation has started.
21883 * - "scroll,anim,stop" - scrolling animation has stopped.
21884 * - "scroll,drag,start" - dragging the contents around has started.
21885 * - "scroll,drag,stop" - dragging the contents around has stopped.
21886 * - "downloaded" - This is called when all currently required map images
21888 * - "route,load" - This is called when route request begins.
21889 * - "route,loaded" - This is called when route request ends.
21890 * - "name,load" - This is called when name request begins.
21891 * - "name,loaded- This is called when name request ends.
21893 * Available style for map widget:
21896 * Available style for markers:
21901 * Available style for marker bubble:
21904 * List of examples:
21905 * @li @ref map_example_01
21906 * @li @ref map_example_02
21907 * @li @ref map_example_03
21916 * @enum _Elm_Map_Zoom_Mode
21917 * @typedef Elm_Map_Zoom_Mode
21919 * Set map's zoom behavior. It can be set to manual or automatic.
21921 * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
21923 * Values <b> don't </b> work as bitmask, only one can be choosen.
21925 * @note Valid sizes are 2^zoom, consequently the map may be smaller
21926 * than the scroller view.
21928 * @see elm_map_zoom_mode_set()
21929 * @see elm_map_zoom_mode_get()
21933 typedef enum _Elm_Map_Zoom_Mode
21935 ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
21936 ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
21937 ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
21938 ELM_MAP_ZOOM_MODE_LAST
21939 } Elm_Map_Zoom_Mode;
21942 * @enum _Elm_Map_Route_Sources
21943 * @typedef Elm_Map_Route_Sources
21945 * Set route service to be used. By default used source is
21946 * #ELM_MAP_ROUTE_SOURCE_YOURS.
21948 * @see elm_map_route_source_set()
21949 * @see elm_map_route_source_get()
21953 typedef enum _Elm_Map_Route_Sources
21955 ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
21956 ELM_MAP_ROUTE_SOURCE_MONAV, /**< MoNav offers exact routing without heuristic assumptions. Its routing core is based on Contraction Hierarchies. It's not working with Map yet. */
21957 ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
21958 ELM_MAP_ROUTE_SOURCE_LAST
21959 } Elm_Map_Route_Sources;
21961 typedef enum _Elm_Map_Name_Sources
21963 ELM_MAP_NAME_SOURCE_NOMINATIM,
21964 ELM_MAP_NAME_SOURCE_LAST
21965 } Elm_Map_Name_Sources;
21968 * @enum _Elm_Map_Route_Type
21969 * @typedef Elm_Map_Route_Type
21971 * Set type of transport used on route.
21973 * @see elm_map_route_add()
21977 typedef enum _Elm_Map_Route_Type
21979 ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
21980 ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
21981 ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
21982 ELM_MAP_ROUTE_TYPE_LAST
21983 } Elm_Map_Route_Type;
21986 * @enum _Elm_Map_Route_Method
21987 * @typedef Elm_Map_Route_Method
21989 * Set the routing method, what should be priorized, time or distance.
21991 * @see elm_map_route_add()
21995 typedef enum _Elm_Map_Route_Method
21997 ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
21998 ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
21999 ELM_MAP_ROUTE_METHOD_LAST
22000 } Elm_Map_Route_Method;
22002 typedef enum _Elm_Map_Name_Method
22004 ELM_MAP_NAME_METHOD_SEARCH,
22005 ELM_MAP_NAME_METHOD_REVERSE,
22006 ELM_MAP_NAME_METHOD_LAST
22007 } Elm_Map_Name_Method;
22009 typedef struct _Elm_Map_Marker Elm_Map_Marker; /**< A marker to be shown in a specific point of the map. Can be created with elm_map_marker_add() and deleted with elm_map_marker_remove(). */
22010 typedef struct _Elm_Map_Marker_Class Elm_Map_Marker_Class; /**< Each marker must be associated to a class. It's required to add a mark. The class defines the style of the marker when a marker is displayed alone (not grouped). A new class can be created with elm_map_marker_class_new(). */
22011 typedef struct _Elm_Map_Group_Class Elm_Map_Group_Class; /**< Each marker must be associated to a group class. It's required to add a mark. The group class defines the style of the marker when a marker is grouped to other markers. Markers with the same group are grouped if they are close. A new group class can be created with elm_map_marker_group_class_new(). */
22012 typedef struct _Elm_Map_Route Elm_Map_Route; /**< A route to be shown in the map. Can be created with elm_map_route_add() and deleted with elm_map_route_remove(). */
22013 typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
22014 typedef struct _Elm_Map_Track Elm_Map_Track;
22016 typedef Evas_Object *(*ElmMapMarkerGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Bubble content fetching class function for marker classes. When the user click on a marker, a bubble is displayed with a content. */
22017 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
22018 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
22019 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
22021 typedef char *(*ElmMapModuleSourceFunc) (void);
22022 typedef int (*ElmMapModuleZoomMinFunc) (void);
22023 typedef int (*ElmMapModuleZoomMaxFunc) (void);
22024 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
22025 typedef int (*ElmMapModuleRouteSourceFunc) (void);
22026 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
22027 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
22028 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
22029 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
22032 * Add a new map widget to the given parent Elementary (container) object.
22034 * @param parent The parent object.
22035 * @return a new map widget handle or @c NULL, on errors.
22037 * This function inserts a new map widget on the canvas.
22041 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22044 * Set the zoom level of the map.
22046 * @param obj The map object.
22047 * @param zoom The zoom level to set.
22049 * This sets the zoom level.
22051 * It will respect limits defined by elm_map_source_zoom_min_set() and
22052 * elm_map_source_zoom_max_set().
22054 * By default these values are 0 (world map) and 18 (maximum zoom).
22056 * This function should be used when zoom mode is set to
22057 * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
22058 * with elm_map_zoom_mode_set().
22060 * @see elm_map_zoom_mode_set().
22061 * @see elm_map_zoom_get().
22065 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22068 * Get the zoom level of the map.
22070 * @param obj The map object.
22071 * @return The current zoom level.
22073 * This returns the current zoom level of the map object.
22075 * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
22076 * (which is the default), the zoom level may be changed at any time by the
22077 * map object itself to account for map size and map viewport size.
22079 * @see elm_map_zoom_set() for details.
22083 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22086 * Set the zoom mode used by the map object.
22088 * @param obj The map object.
22089 * @param mode The zoom mode of the map, being it one of
22090 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22091 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22093 * This sets the zoom mode to manual or one of the automatic levels.
22094 * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
22095 * elm_map_zoom_set() and will stay at that level until changed by code
22096 * or until zoom mode is changed. This is the default mode.
22098 * The Automatic modes will allow the map object to automatically
22099 * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
22100 * adjust zoom so the map fits inside the scroll frame with no pixels
22101 * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
22102 * ensure no pixels within the frame are left unfilled. Do not forget that
22103 * the valid sizes are 2^zoom, consequently the map may be smaller than
22104 * the scroller view.
22106 * @see elm_map_zoom_set()
22110 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22113 * Get the zoom mode used by the map object.
22115 * @param obj The map object.
22116 * @return The zoom mode of the map, being it one of
22117 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22118 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22120 * This function returns the current zoom mode used by the map object.
22122 * @see elm_map_zoom_mode_set() for more details.
22126 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22129 * Get the current coordinates of the map.
22131 * @param obj The map object.
22132 * @param lon Pointer where to store longitude.
22133 * @param lat Pointer where to store latitude.
22135 * This gets the current center coordinates of the map object. It can be
22136 * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
22138 * @see elm_map_geo_region_bring_in()
22139 * @see elm_map_geo_region_show()
22143 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
22146 * Animatedly bring in given coordinates to the center of the map.
22148 * @param obj The map object.
22149 * @param lon Longitude to center at.
22150 * @param lat Latitude to center at.
22152 * This causes map to jump to the given @p lat and @p lon coordinates
22153 * and show it (by scrolling) in the center of the viewport, if it is not
22154 * already centered. This will use animation to do so and take a period
22155 * of time to complete.
22157 * @see elm_map_geo_region_show() for a function to avoid animation.
22158 * @see elm_map_geo_region_get()
22162 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22165 * Show the given coordinates at the center of the map, @b immediately.
22167 * @param obj The map object.
22168 * @param lon Longitude to center at.
22169 * @param lat Latitude to center at.
22171 * This causes map to @b redraw its viewport's contents to the
22172 * region contining the given @p lat and @p lon, that will be moved to the
22173 * center of the map.
22175 * @see elm_map_geo_region_bring_in() for a function to move with animation.
22176 * @see elm_map_geo_region_get()
22180 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22183 * Pause or unpause the map.
22185 * @param obj The map object.
22186 * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
22189 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22192 * The default is off.
22194 * This will stop zooming using animation, changing zoom levels will
22195 * change instantly. This will stop any existing animations that are running.
22197 * @see elm_map_paused_get()
22201 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22204 * Get a value whether map is paused or not.
22206 * @param obj The map object.
22207 * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
22208 * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
22210 * This gets the current paused state for the map object.
22212 * @see elm_map_paused_set() for details.
22216 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22219 * Set to show markers during zoom level changes or not.
22221 * @param obj The map object.
22222 * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
22225 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22228 * The default is off.
22230 * This will stop zooming using animation, changing zoom levels will
22231 * change instantly. This will stop any existing animations that are running.
22233 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22236 * The default is off.
22238 * Enabling it will force the map to stop displaying the markers during
22239 * zoom level changes. Set to on if you have a large number of markers.
22241 * @see elm_map_paused_markers_get()
22245 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22248 * Get a value whether markers will be displayed on zoom level changes or not
22250 * @param obj The map object.
22251 * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
22252 * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
22254 * This gets the current markers paused state for the map object.
22256 * @see elm_map_paused_markers_set() for details.
22260 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22263 * Get the information of downloading status.
22265 * @param obj The map object.
22266 * @param try_num Pointer where to store number of tiles being downloaded.
22267 * @param finish_num Pointer where to store number of tiles successfully
22270 * This gets the current downloading status for the map object, the number
22271 * of tiles being downloaded and the number of tiles already downloaded.
22275 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
22278 * Convert a pixel coordinate (x,y) into a geographic coordinate
22279 * (longitude, latitude).
22281 * @param obj The map object.
22282 * @param x the coordinate.
22283 * @param y the coordinate.
22284 * @param size the size in pixels of the map.
22285 * The map is a square and generally his size is : pow(2.0, zoom)*256.
22286 * @param lon Pointer where to store the longitude that correspond to x.
22287 * @param lat Pointer where to store the latitude that correspond to y.
22289 * @note Origin pixel point is the top left corner of the viewport.
22290 * Map zoom and size are taken on account.
22292 * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
22296 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);
22299 * Convert a geographic coordinate (longitude, latitude) into a pixel
22300 * coordinate (x, y).
22302 * @param obj The map object.
22303 * @param lon the longitude.
22304 * @param lat the latitude.
22305 * @param size the size in pixels of the map. The map is a square
22306 * and generally his size is : pow(2.0, zoom)*256.
22307 * @param x Pointer where to store the horizontal pixel coordinate that
22308 * correspond to the longitude.
22309 * @param y Pointer where to store the vertical pixel coordinate that
22310 * correspond to the latitude.
22312 * @note Origin pixel point is the top left corner of the viewport.
22313 * Map zoom and size are taken on account.
22315 * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
22319 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);
22322 * Convert a geographic coordinate (longitude, latitude) into a name
22325 * @param obj The map object.
22326 * @param lon the longitude.
22327 * @param lat the latitude.
22328 * @return name A #Elm_Map_Name handle for this coordinate.
22330 * To get the string for this address, elm_map_name_address_get()
22333 * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
22337 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22340 * Convert a name (address) into a geographic coordinate
22341 * (longitude, latitude).
22343 * @param obj The map object.
22344 * @param name The address.
22345 * @return name A #Elm_Map_Name handle for this address.
22347 * To get the longitude and latitude, elm_map_name_region_get()
22350 * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
22354 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
22357 * Convert a pixel coordinate into a rotated pixel coordinate.
22359 * @param obj The map object.
22360 * @param x horizontal coordinate of the point to rotate.
22361 * @param y vertical coordinate of the point to rotate.
22362 * @param cx rotation's center horizontal position.
22363 * @param cy rotation's center vertical position.
22364 * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
22365 * @param xx Pointer where to store rotated x.
22366 * @param yy Pointer where to store rotated y.
22370 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);
22373 * Add a new marker to the map object.
22375 * @param obj The map object.
22376 * @param lon The longitude of the marker.
22377 * @param lat The latitude of the marker.
22378 * @param clas The class, to use when marker @b isn't grouped to others.
22379 * @param clas_group The class group, to use when marker is grouped to others
22380 * @param data The data passed to the callbacks.
22382 * @return The created marker or @c NULL upon failure.
22384 * A marker will be created and shown in a specific point of the map, defined
22385 * by @p lon and @p lat.
22387 * It will be displayed using style defined by @p class when this marker
22388 * is displayed alone (not grouped). A new class can be created with
22389 * elm_map_marker_class_new().
22391 * If the marker is grouped to other markers, it will be displayed with
22392 * style defined by @p class_group. Markers with the same group are grouped
22393 * if they are close. A new group class can be created with
22394 * elm_map_marker_group_class_new().
22396 * Markers created with this method can be deleted with
22397 * elm_map_marker_remove().
22399 * A marker can have associated content to be displayed by a bubble,
22400 * when a user click over it, as well as an icon. These objects will
22401 * be fetch using class' callback functions.
22403 * @see elm_map_marker_class_new()
22404 * @see elm_map_marker_group_class_new()
22405 * @see elm_map_marker_remove()
22409 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);
22412 * Set the maximum numbers of markers' content to be displayed in a group.
22414 * @param obj The map object.
22415 * @param max The maximum numbers of items displayed in a bubble.
22417 * A bubble will be displayed when the user clicks over the group,
22418 * and will place the content of markers that belong to this group
22421 * A group can have a long list of markers, consequently the creation
22422 * of the content of the bubble can be very slow.
22424 * In order to avoid this, a maximum number of items is displayed
22427 * By default this number is 30.
22429 * Marker with the same group class are grouped if they are close.
22431 * @see elm_map_marker_add()
22435 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
22438 * Remove a marker from the map.
22440 * @param marker The marker to remove.
22442 * @see elm_map_marker_add()
22446 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22449 * Get the current coordinates of the marker.
22451 * @param marker marker.
22452 * @param lat Pointer where to store the marker's latitude.
22453 * @param lon Pointer where to store the marker's longitude.
22455 * These values are set when adding markers, with function
22456 * elm_map_marker_add().
22458 * @see elm_map_marker_add()
22462 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
22465 * Animatedly bring in given marker to the center of the map.
22467 * @param marker The marker to center at.
22469 * This causes map to jump to the given @p marker's coordinates
22470 * and show it (by scrolling) in the center of the viewport, if it is not
22471 * already centered. This will use animation to do so and take a period
22472 * of time to complete.
22474 * @see elm_map_marker_show() for a function to avoid animation.
22475 * @see elm_map_marker_region_get()
22479 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22482 * Show the given marker at the center of the map, @b immediately.
22484 * @param marker The marker to center at.
22486 * This causes map to @b redraw its viewport's contents to the
22487 * region contining the given @p marker's coordinates, that will be
22488 * moved to the center of the map.
22490 * @see elm_map_marker_bring_in() for a function to move with animation.
22491 * @see elm_map_markers_list_show() if more than one marker need to be
22493 * @see elm_map_marker_region_get()
22497 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22500 * Move and zoom the map to display a list of markers.
22502 * @param markers A list of #Elm_Map_Marker handles.
22504 * The map will be centered on the center point of the markers in the list.
22505 * Then the map will be zoomed in order to fit the markers using the maximum
22506 * zoom which allows display of all the markers.
22508 * @warning All the markers should belong to the same map object.
22510 * @see elm_map_marker_show() to show a single marker.
22511 * @see elm_map_marker_bring_in()
22515 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
22518 * Get the Evas object returned by the ElmMapMarkerGetFunc callback
22520 * @param marker The marker wich content should be returned.
22521 * @return Return the evas object if it exists, else @c NULL.
22523 * To set callback function #ElmMapMarkerGetFunc for the marker class,
22524 * elm_map_marker_class_get_cb_set() should be used.
22526 * This content is what will be inside the bubble that will be displayed
22527 * when an user clicks over the marker.
22529 * This returns the actual Evas object used to be placed inside
22530 * the bubble. This may be @c NULL, as it may
22531 * not have been created or may have been deleted, at any time, by
22532 * the map. <b>Do not modify this object</b> (move, resize,
22533 * show, hide, etc.), as the map is controlling it. This
22534 * function is for querying, emitting custom signals or hooking
22535 * lower level callbacks for events on that object. Do not delete
22536 * this object under any circumstances.
22540 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22543 * Update the marker
22545 * @param marker The marker to be updated.
22547 * If a content is set to this marker, it will call function to delete it,
22548 * #ElmMapMarkerDelFunc, and then will fetch the content again with
22549 * #ElmMapMarkerGetFunc.
22551 * These functions are set for the marker class with
22552 * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
22556 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22559 * Close all the bubbles opened by the user.
22561 * @param obj The map object.
22563 * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
22564 * when the user clicks on a marker.
22566 * This functions is set for the marker class with
22567 * elm_map_marker_class_get_cb_set().
22571 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
22574 * Create a new group class.
22576 * @param obj The map object.
22577 * @return Returns the new group class.
22579 * Each marker must be associated to a group class. Markers in the same
22580 * group are grouped if they are close.
22582 * The group class defines the style of the marker when a marker is grouped
22583 * to others markers. When it is alone, another class will be used.
22585 * A group class will need to be provided when creating a marker with
22586 * elm_map_marker_add().
22588 * Some properties and functions can be set by class, as:
22589 * - style, with elm_map_group_class_style_set()
22590 * - data - to be associated to the group class. It can be set using
22591 * elm_map_group_class_data_set().
22592 * - min zoom to display markers, set with
22593 * elm_map_group_class_zoom_displayed_set().
22594 * - max zoom to group markers, set using
22595 * elm_map_group_class_zoom_grouped_set().
22596 * - visibility - set if markers will be visible or not, set with
22597 * elm_map_group_class_hide_set().
22598 * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
22599 * It can be set using elm_map_group_class_icon_cb_set().
22601 * @see elm_map_marker_add()
22602 * @see elm_map_group_class_style_set()
22603 * @see elm_map_group_class_data_set()
22604 * @see elm_map_group_class_zoom_displayed_set()
22605 * @see elm_map_group_class_zoom_grouped_set()
22606 * @see elm_map_group_class_hide_set()
22607 * @see elm_map_group_class_icon_cb_set()
22611 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
22614 * Set the marker's style of a group class.
22616 * @param clas The group class.
22617 * @param style The style to be used by markers.
22619 * Each marker must be associated to a group class, and will use the style
22620 * defined by such class when grouped to other markers.
22622 * The following styles are provided by default theme:
22623 * @li @c radio - blue circle
22624 * @li @c radio2 - green circle
22627 * @see elm_map_group_class_new() for more details.
22628 * @see elm_map_marker_add()
22632 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
22635 * Set the icon callback function of a group class.
22637 * @param clas The group class.
22638 * @param icon_get The callback function that will return the icon.
22640 * Each marker must be associated to a group class, and it can display a
22641 * custom icon. The function @p icon_get must return this icon.
22643 * @see elm_map_group_class_new() for more details.
22644 * @see elm_map_marker_add()
22648 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
22651 * Set the data associated to the group class.
22653 * @param clas The group class.
22654 * @param data The new user data.
22656 * This data will be passed for callback functions, like icon get callback,
22657 * that can be set with elm_map_group_class_icon_cb_set().
22659 * If a data was previously set, the object will lose the pointer for it,
22660 * so if needs to be freed, you must do it yourself.
22662 * @see elm_map_group_class_new() for more details.
22663 * @see elm_map_group_class_icon_cb_set()
22664 * @see elm_map_marker_add()
22668 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
22671 * Set the minimum zoom from where the markers are displayed.
22673 * @param clas The group class.
22674 * @param zoom The minimum zoom.
22676 * Markers only will be displayed when the map is displayed at @p zoom
22679 * @see elm_map_group_class_new() for more details.
22680 * @see elm_map_marker_add()
22684 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
22687 * Set the zoom from where the markers are no more grouped.
22689 * @param clas The group class.
22690 * @param zoom The maximum zoom.
22692 * Markers only will be grouped when the map is displayed at
22693 * less than @p zoom.
22695 * @see elm_map_group_class_new() for more details.
22696 * @see elm_map_marker_add()
22700 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
22703 * Set if the markers associated to the group class @clas are hidden or not.
22705 * @param clas The group class.
22706 * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
22709 * If @p hide is @c EINA_TRUE the markers will be hidden, but default
22714 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
22717 * Create a new marker class.
22719 * @param obj The map object.
22720 * @return Returns the new group class.
22722 * Each marker must be associated to a class.
22724 * The marker class defines the style of the marker when a marker is
22725 * displayed alone, i.e., not grouped to to others markers. When grouped
22726 * it will use group class style.
22728 * A marker class will need to be provided when creating a marker with
22729 * elm_map_marker_add().
22731 * Some properties and functions can be set by class, as:
22732 * - style, with elm_map_marker_class_style_set()
22733 * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
22734 * It can be set using elm_map_marker_class_icon_cb_set().
22735 * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
22736 * Set using elm_map_marker_class_get_cb_set().
22737 * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
22738 * Set using elm_map_marker_class_del_cb_set().
22740 * @see elm_map_marker_add()
22741 * @see elm_map_marker_class_style_set()
22742 * @see elm_map_marker_class_icon_cb_set()
22743 * @see elm_map_marker_class_get_cb_set()
22744 * @see elm_map_marker_class_del_cb_set()
22748 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
22751 * Set the marker's style of a marker class.
22753 * @param clas The marker class.
22754 * @param style The style to be used by markers.
22756 * Each marker must be associated to a marker class, and will use the style
22757 * defined by such class when alone, i.e., @b not grouped to other markers.
22759 * The following styles are provided by default theme:
22764 * @see elm_map_marker_class_new() for more details.
22765 * @see elm_map_marker_add()
22769 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
22772 * Set the icon callback function of a marker class.
22774 * @param clas The marker class.
22775 * @param icon_get The callback function that will return the icon.
22777 * Each marker must be associated to a marker class, and it can display a
22778 * custom icon. The function @p icon_get must return this icon.
22780 * @see elm_map_marker_class_new() for more details.
22781 * @see elm_map_marker_add()
22785 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
22788 * Set the bubble content callback function of a marker class.
22790 * @param clas The marker class.
22791 * @param get The callback function that will return the content.
22793 * Each marker must be associated to a marker class, and it can display a
22794 * a content on a bubble that opens when the user click over the marker.
22795 * The function @p get must return this content object.
22797 * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
22800 * @see elm_map_marker_class_new() for more details.
22801 * @see elm_map_marker_class_del_cb_set()
22802 * @see elm_map_marker_add()
22806 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
22809 * Set the callback function used to delete bubble content of a marker class.
22811 * @param clas The marker class.
22812 * @param del The callback function that will delete the content.
22814 * Each marker must be associated to a marker class, and it can display a
22815 * a content on a bubble that opens when the user click over the marker.
22816 * The function to return such content can be set with
22817 * elm_map_marker_class_get_cb_set().
22819 * If this content must be freed, a callback function need to be
22820 * set for that task with this function.
22822 * If this callback is defined it will have to delete (or not) the
22823 * object inside, but if the callback is not defined the object will be
22824 * destroyed with evas_object_del().
22826 * @see elm_map_marker_class_new() for more details.
22827 * @see elm_map_marker_class_get_cb_set()
22828 * @see elm_map_marker_add()
22832 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
22835 * Get the list of available sources.
22837 * @param obj The map object.
22838 * @return The source names list.
22840 * It will provide a list with all available sources, that can be set as
22841 * current source with elm_map_source_name_set(), or get with
22842 * elm_map_source_name_get().
22844 * Available sources:
22850 * @see elm_map_source_name_set() for more details.
22851 * @see elm_map_source_name_get()
22855 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22858 * Set the source of the map.
22860 * @param obj The map object.
22861 * @param source The source to be used.
22863 * Map widget retrieves images that composes the map from a web service.
22864 * This web service can be set with this method.
22866 * A different service can return a different maps with different
22867 * information and it can use different zoom values.
22869 * The @p source_name need to match one of the names provided by
22870 * elm_map_source_names_get().
22872 * The current source can be get using elm_map_source_name_get().
22874 * @see elm_map_source_names_get()
22875 * @see elm_map_source_name_get()
22880 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
22883 * Get the name of currently used source.
22885 * @param obj The map object.
22886 * @return Returns the name of the source in use.
22888 * @see elm_map_source_name_set() for more details.
22892 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22895 * Set the source of the route service to be used by the map.
22897 * @param obj The map object.
22898 * @param source The route service to be used, being it one of
22899 * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
22900 * and #ELM_MAP_ROUTE_SOURCE_ORS.
22902 * Each one has its own algorithm, so the route retrieved may
22903 * differ depending on the source route. Now, only the default is working.
22905 * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
22906 * http://www.yournavigation.org/.
22908 * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
22909 * assumptions. Its routing core is based on Contraction Hierarchies.
22911 * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
22913 * @see elm_map_route_source_get().
22917 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
22920 * Get the current route source.
22922 * @param obj The map object.
22923 * @return The source of the route service used by the map.
22925 * @see elm_map_route_source_set() for details.
22929 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22932 * Set the minimum zoom of the source.
22934 * @param obj The map object.
22935 * @param zoom New minimum zoom value to be used.
22937 * By default, it's 0.
22941 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22944 * Get the minimum zoom of the source.
22946 * @param obj The map object.
22947 * @return Returns the minimum zoom of the source.
22949 * @see elm_map_source_zoom_min_set() for details.
22953 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22956 * Set the maximum zoom of the source.
22958 * @param obj The map object.
22959 * @param zoom New maximum zoom value to be used.
22961 * By default, it's 18.
22965 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22968 * Get the maximum zoom of the source.
22970 * @param obj The map object.
22971 * @return Returns the maximum zoom of the source.
22973 * @see elm_map_source_zoom_min_set() for details.
22977 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22980 * Set the user agent used by the map object to access routing services.
22982 * @param obj The map object.
22983 * @param user_agent The user agent to be used by the map.
22985 * User agent is a client application implementing a network protocol used
22986 * in communications within a clientāserver distributed computing system
22988 * The @p user_agent identification string will transmitted in a header
22989 * field @c User-Agent.
22991 * @see elm_map_user_agent_get()
22995 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
22998 * Get the user agent used by the map object.
23000 * @param obj The map object.
23001 * @return The user agent identification string used by the map.
23003 * @see elm_map_user_agent_set() for details.
23007 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23010 * Add a new route to the map object.
23012 * @param obj The map object.
23013 * @param type The type of transport to be considered when tracing a route.
23014 * @param method The routing method, what should be priorized.
23015 * @param flon The start longitude.
23016 * @param flat The start latitude.
23017 * @param tlon The destination longitude.
23018 * @param tlat The destination latitude.
23020 * @return The created route or @c NULL upon failure.
23022 * A route will be traced by point on coordinates (@p flat, @p flon)
23023 * to point on coordinates (@p tlat, @p tlon), using the route service
23024 * set with elm_map_route_source_set().
23026 * It will take @p type on consideration to define the route,
23027 * depending if the user will be walking or driving, the route may vary.
23028 * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
23029 * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
23031 * Another parameter is what the route should priorize, the minor distance
23032 * or the less time to be spend on the route. So @p method should be one
23033 * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
23035 * Routes created with this method can be deleted with
23036 * elm_map_route_remove(), colored with elm_map_route_color_set(),
23037 * and distance can be get with elm_map_route_distance_get().
23039 * @see elm_map_route_remove()
23040 * @see elm_map_route_color_set()
23041 * @see elm_map_route_distance_get()
23042 * @see elm_map_route_source_set()
23046 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);
23049 * Remove a route from the map.
23051 * @param route The route to remove.
23053 * @see elm_map_route_add()
23057 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23060 * Set the route color.
23062 * @param route The route object.
23063 * @param r Red channel value, from 0 to 255.
23064 * @param g Green channel value, from 0 to 255.
23065 * @param b Blue channel value, from 0 to 255.
23066 * @param a Alpha channel value, from 0 to 255.
23068 * It uses an additive color model, so each color channel represents
23069 * how much of each primary colors must to be used. 0 represents
23070 * ausence of this color, so if all of the three are set to 0,
23071 * the color will be black.
23073 * These component values should be integers in the range 0 to 255,
23074 * (single 8-bit byte).
23076 * This sets the color used for the route. By default, it is set to
23077 * solid red (r = 255, g = 0, b = 0, a = 255).
23079 * For alpha channel, 0 represents completely transparent, and 255, opaque.
23081 * @see elm_map_route_color_get()
23085 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
23088 * Get the route color.
23090 * @param route The route object.
23091 * @param r Pointer where to store the red channel value.
23092 * @param g Pointer where to store the green channel value.
23093 * @param b Pointer where to store the blue channel value.
23094 * @param a Pointer where to store the alpha channel value.
23096 * @see elm_map_route_color_set() for details.
23100 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
23103 * Get the route distance in kilometers.
23105 * @param route The route object.
23106 * @return The distance of route (unit : km).
23110 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23113 * Get the information of route nodes.
23115 * @param route The route object.
23116 * @return Returns a string with the nodes of route.
23120 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23123 * Get the information of route waypoint.
23125 * @param route the route object.
23126 * @return Returns a string with information about waypoint of route.
23130 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23133 * Get the address of the name.
23135 * @param name The name handle.
23136 * @return Returns the address string of @p name.
23138 * This gets the coordinates of the @p name, created with one of the
23139 * conversion functions.
23141 * @see elm_map_utils_convert_name_into_coord()
23142 * @see elm_map_utils_convert_coord_into_name()
23146 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23149 * Get the current coordinates of the name.
23151 * @param name The name handle.
23152 * @param lat Pointer where to store the latitude.
23153 * @param lon Pointer where to store The longitude.
23155 * This gets the coordinates of the @p name, created with one of the
23156 * conversion functions.
23158 * @see elm_map_utils_convert_name_into_coord()
23159 * @see elm_map_utils_convert_coord_into_name()
23163 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
23166 * Remove a name from the map.
23168 * @param name The name to remove.
23170 * Basically the struct handled by @p name will be freed, so convertions
23171 * between address and coordinates will be lost.
23173 * @see elm_map_utils_convert_name_into_coord()
23174 * @see elm_map_utils_convert_coord_into_name()
23178 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23183 * @param obj The map object.
23184 * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
23185 * @param cx Rotation's center horizontal position.
23186 * @param cy Rotation's center vertical position.
23188 * @see elm_map_rotate_get()
23192 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
23195 * Get the rotate degree of the map
23197 * @param obj The map object
23198 * @param degree Pointer where to store degrees from 0.0 to 360.0
23199 * to rotate arount Z axis.
23200 * @param cx Pointer where to store rotation's center horizontal position.
23201 * @param cy Pointer where to store rotation's center vertical position.
23203 * @see elm_map_rotate_set() to set map rotation.
23207 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);
23210 * Enable or disable mouse wheel to be used to zoom in / out the map.
23212 * @param obj The map object.
23213 * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
23216 * Mouse wheel can be used for the user to zoom in or zoom out the map.
23218 * It's disabled by default.
23220 * @see elm_map_wheel_disabled_get()
23224 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
23227 * Get a value whether mouse wheel is enabled or not.
23229 * @param obj The map object.
23230 * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
23231 * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23233 * Mouse wheel can be used for the user to zoom in or zoom out the map.
23235 * @see elm_map_wheel_disabled_set() for details.
23239 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23243 * Add a track on the map
23245 * @param obj The map object.
23246 * @param emap The emap route object.
23247 * @return The route object. This is an elm object of type Route.
23249 * @see elm_route_add() for details.
23253 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
23257 * Remove a track from the map
23259 * @param obj The map object.
23260 * @param route The track to remove.
23264 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
23271 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
23273 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
23275 EAPI double elm_route_lon_min_get(Evas_Object *obj);
23276 EAPI double elm_route_lat_min_get(Evas_Object *obj);
23277 EAPI double elm_route_lon_max_get(Evas_Object *obj);
23278 EAPI double elm_route_lat_max_get(Evas_Object *obj);
23281 * @defgroup Panel Panel
23283 * @image html img/widget/panel/preview-00.png
23284 * @image latex img/widget/panel/preview-00.eps
23286 * @brief A panel is a type of animated container that contains subobjects.
23287 * It can be expanded or contracted by clicking the button on it's edge.
23289 * Orientations are as follows:
23290 * @li ELM_PANEL_ORIENT_TOP
23291 * @li ELM_PANEL_ORIENT_LEFT
23292 * @li ELM_PANEL_ORIENT_RIGHT
23294 * To set/get/unset the content of the panel, you can use
23295 * elm_object_content_set/get/unset APIs.
23296 * Once the content object is set, a previously set one will be deleted.
23297 * If you want to keep that old content object, use the
23298 * elm_object_content_unset() function
23300 * @ref tutorial_panel shows one way to use this widget.
23303 typedef enum _Elm_Panel_Orient
23305 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
23306 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
23307 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
23308 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
23309 } Elm_Panel_Orient;
23311 * @brief Adds a panel object
23313 * @param parent The parent object
23315 * @return The panel object, or NULL on failure
23317 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23319 * @brief Sets the orientation of the panel
23321 * @param parent The parent object
23322 * @param orient The panel orientation. Can be one of the following:
23323 * @li ELM_PANEL_ORIENT_TOP
23324 * @li ELM_PANEL_ORIENT_LEFT
23325 * @li ELM_PANEL_ORIENT_RIGHT
23327 * Sets from where the panel will (dis)appear.
23329 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
23331 * @brief Get the orientation of the panel.
23333 * @param obj The panel object
23334 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
23336 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23338 * @brief Set the content of the panel.
23340 * @param obj The panel object
23341 * @param content The panel content
23343 * Once the content object is set, a previously set one will be deleted.
23344 * If you want to keep that old content object, use the
23345 * elm_panel_content_unset() function.
23347 EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23349 * @brief Get the content of the panel.
23351 * @param obj The panel object
23352 * @return The content that is being used
23354 * Return the content object which is set for this widget.
23356 * @see elm_panel_content_set()
23358 EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23360 * @brief Unset the content of the panel.
23362 * @param obj The panel object
23363 * @return The content that was being used
23365 * Unparent and return the content object which was set for this widget.
23367 * @see elm_panel_content_set()
23369 EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23371 * @brief Set the state of the panel.
23373 * @param obj The panel object
23374 * @param hidden If true, the panel will run the animation to contract
23376 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
23378 * @brief Get the state of the panel.
23380 * @param obj The panel object
23381 * @param hidden If true, the panel is in the "hide" state
23383 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23385 * @brief Toggle the hidden state of the panel from code
23387 * @param obj The panel object
23389 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
23395 * @defgroup Panes Panes
23396 * @ingroup Elementary
23398 * @image html img/widget/panes/preview-00.png
23399 * @image latex img/widget/panes/preview-00.eps width=\textwidth
23401 * @image html img/panes.png
23402 * @image latex img/panes.eps width=\textwidth
23404 * The panes adds a dragable bar between two contents. When dragged
23405 * this bar will resize contents size.
23407 * Panes can be displayed vertically or horizontally, and contents
23408 * size proportion can be customized (homogeneous by default).
23410 * Smart callbacks one can listen to:
23411 * - "press" - The panes has been pressed (button wasn't released yet).
23412 * - "unpressed" - The panes was released after being pressed.
23413 * - "clicked" - The panes has been clicked>
23414 * - "clicked,double" - The panes has been double clicked
23416 * Available styles for it:
23419 * Default contents parts of the panes widget that you can use for are:
23420 * @li "elm.swallow.left" - A leftside content of the panes
23421 * @li "elm.swallow.right" - A rightside content of the panes
23423 * If panes is displayed vertically, left content will be displayed at
23426 * Here is an example on its usage:
23427 * @li @ref panes_example
23430 #define ELM_PANES_CONTENT_LEFT "elm.swallow.left"
23431 #define ELM_PANES_CONTENT_RIGHT "elm.swallow.right"
23434 * @addtogroup Panes
23439 * Add a new panes widget to the given parent Elementary
23440 * (container) object.
23442 * @param parent The parent object.
23443 * @return a new panes widget handle or @c NULL, on errors.
23445 * This function inserts a new panes widget on the canvas.
23449 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23452 * Set the left content of the panes widget.
23454 * @param obj The panes object.
23455 * @param content The new left content object.
23457 * Once the content object is set, a previously set one will be deleted.
23458 * If you want to keep that old content object, use the
23459 * elm_panes_content_left_unset() function.
23461 * If panes is displayed vertically, left content will be displayed at
23464 * @see elm_panes_content_left_get()
23465 * @see elm_panes_content_right_set() to set content on the other side.
23469 EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23472 * Set the right content of the panes widget.
23474 * @param obj The panes object.
23475 * @param content The new right content object.
23477 * Once the content object is set, a previously set one will be deleted.
23478 * If you want to keep that old content object, use the
23479 * elm_panes_content_right_unset() function.
23481 * If panes is displayed vertically, left content will be displayed at
23484 * @see elm_panes_content_right_get()
23485 * @see elm_panes_content_left_set() to set content on the other side.
23489 EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23492 * Get the left content of the panes.
23494 * @param obj The panes object.
23495 * @return The left content object that is being used.
23497 * Return the left content object which is set for this widget.
23499 * @see elm_panes_content_left_set() for details.
23503 EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23506 * Get the right content of the panes.
23508 * @param obj The panes object
23509 * @return The right content object that is being used
23511 * Return the right content object which is set for this widget.
23513 * @see elm_panes_content_right_set() for details.
23517 EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23520 * Unset the left content used for the panes.
23522 * @param obj The panes object.
23523 * @return The left content object that was being used.
23525 * Unparent and return the left content object which was set for this widget.
23527 * @see elm_panes_content_left_set() for details.
23528 * @see elm_panes_content_left_get().
23532 EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23535 * Unset the right content used for the panes.
23537 * @param obj The panes object.
23538 * @return The right content object that was being used.
23540 * Unparent and return the right content object which was set for this
23543 * @see elm_panes_content_right_set() for details.
23544 * @see elm_panes_content_right_get().
23548 EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23551 * Get the size proportion of panes widget's left side.
23553 * @param obj The panes object.
23554 * @return float value between 0.0 and 1.0 representing size proportion
23557 * @see elm_panes_content_left_size_set() for more details.
23561 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23564 * Set the size proportion of panes widget's left side.
23566 * @param obj The panes object.
23567 * @param size Value between 0.0 and 1.0 representing size proportion
23570 * By default it's homogeneous, i.e., both sides have the same size.
23572 * If something different is required, it can be set with this function.
23573 * For example, if the left content should be displayed over
23574 * 75% of the panes size, @p size should be passed as @c 0.75.
23575 * This way, right content will be resized to 25% of panes size.
23577 * If displayed vertically, left content is displayed at top, and
23578 * right content at bottom.
23580 * @note This proportion will change when user drags the panes bar.
23582 * @see elm_panes_content_left_size_get()
23586 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
23589 * Set the orientation of a given panes widget.
23591 * @param obj The panes object.
23592 * @param horizontal Use @c EINA_TRUE to make @p obj to be
23593 * @b horizontal, @c EINA_FALSE to make it @b vertical.
23595 * Use this function to change how your panes is to be
23596 * disposed: vertically or horizontally.
23598 * By default it's displayed horizontally.
23600 * @see elm_panes_horizontal_get()
23604 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
23607 * Retrieve the orientation of a given panes widget.
23609 * @param obj The panes object.
23610 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
23611 * @c EINA_FALSE if it's @b vertical (and on errors).
23613 * @see elm_panes_horizontal_set() for more details.
23617 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23618 EAPI void elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
23619 EAPI Eina_Bool elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23626 * @defgroup Flip Flip
23628 * @image html img/widget/flip/preview-00.png
23629 * @image latex img/widget/flip/preview-00.eps
23631 * This widget holds 2 content objects(Evas_Object): one on the front and one
23632 * on the back. It allows you to flip from front to back and vice-versa using
23633 * various animations.
23635 * If either the front or back contents are not set the flip will treat that
23636 * as transparent. So if you wore to set the front content but not the back,
23637 * and then call elm_flip_go() you would see whatever is below the flip.
23639 * For a list of supported animations see elm_flip_go().
23641 * Signals that you can add callbacks for are:
23642 * "animate,begin" - when a flip animation was started
23643 * "animate,done" - when a flip animation is finished
23645 * @ref tutorial_flip show how to use most of the API.
23649 typedef enum _Elm_Flip_Mode
23651 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
23652 ELM_FLIP_ROTATE_X_CENTER_AXIS,
23653 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
23654 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
23655 ELM_FLIP_CUBE_LEFT,
23656 ELM_FLIP_CUBE_RIGHT,
23658 ELM_FLIP_CUBE_DOWN,
23659 ELM_FLIP_PAGE_LEFT,
23660 ELM_FLIP_PAGE_RIGHT,
23664 typedef enum _Elm_Flip_Interaction
23666 ELM_FLIP_INTERACTION_NONE,
23667 ELM_FLIP_INTERACTION_ROTATE,
23668 ELM_FLIP_INTERACTION_CUBE,
23669 ELM_FLIP_INTERACTION_PAGE
23670 } Elm_Flip_Interaction;
23671 typedef enum _Elm_Flip_Direction
23673 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
23674 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
23675 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
23676 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
23677 } Elm_Flip_Direction;
23679 * @brief Add a new flip to the parent
23681 * @param parent The parent object
23682 * @return The new object or NULL if it cannot be created
23684 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23686 * @brief Set the front content of the flip widget.
23688 * @param obj The flip object
23689 * @param content The new front content object
23691 * Once the content object is set, a previously set one will be deleted.
23692 * If you want to keep that old content object, use the
23693 * elm_flip_content_front_unset() function.
23695 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23697 * @brief Set the back content of the flip widget.
23699 * @param obj The flip object
23700 * @param content The new back content object
23702 * Once the content object is set, a previously set one will be deleted.
23703 * If you want to keep that old content object, use the
23704 * elm_flip_content_back_unset() function.
23706 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23708 * @brief Get the front content used for the flip
23710 * @param obj The flip object
23711 * @return The front content object that is being used
23713 * Return the front content object which is set for this widget.
23715 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23717 * @brief Get the back content used for the flip
23719 * @param obj The flip object
23720 * @return The back content object that is being used
23722 * Return the back content object which is set for this widget.
23724 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23726 * @brief Unset the front content used for the flip
23728 * @param obj The flip object
23729 * @return The front content object that was being used
23731 * Unparent and return the front content object which was set for this widget.
23733 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23735 * @brief Unset the back content used for the flip
23737 * @param obj The flip object
23738 * @return The back content object that was being used
23740 * Unparent and return the back content object which was set for this widget.
23742 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23744 * @brief Get flip front visibility state
23746 * @param obj The flip objct
23747 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
23750 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23752 * @brief Set flip perspective
23754 * @param obj The flip object
23755 * @param foc The coordinate to set the focus on
23756 * @param x The X coordinate
23757 * @param y The Y coordinate
23759 * @warning This function currently does nothing.
23761 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
23763 * @brief Runs the flip animation
23765 * @param obj The flip object
23766 * @param mode The mode type
23768 * Flips the front and back contents using the @p mode animation. This
23769 * efectively hides the currently visible content and shows the hidden one.
23771 * There a number of possible animations to use for the flipping:
23772 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
23773 * around a horizontal axis in the middle of its height, the other content
23774 * is shown as the other side of the flip.
23775 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
23776 * around a vertical axis in the middle of its width, the other content is
23777 * shown as the other side of the flip.
23778 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
23779 * around a diagonal axis in the middle of its width, the other content is
23780 * shown as the other side of the flip.
23781 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
23782 * around a diagonal axis in the middle of its height, the other content is
23783 * shown as the other side of the flip.
23784 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
23785 * as if the flip was a cube, the other content is show as the right face of
23787 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
23788 * right as if the flip was a cube, the other content is show as the left
23789 * face of the cube.
23790 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
23791 * flip was a cube, the other content is show as the bottom face of the cube.
23792 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
23793 * the flip was a cube, the other content is show as the upper face of the
23795 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
23796 * if the flip was a book, the other content is shown as the page below that.
23797 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
23798 * as if the flip was a book, the other content is shown as the page below
23800 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
23801 * flip was a book, the other content is shown as the page below that.
23802 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
23803 * flip was a book, the other content is shown as the page below that.
23805 * @image html elm_flip.png
23806 * @image latex elm_flip.eps width=\textwidth
23808 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
23810 * @brief Set the interactive flip mode
23812 * @param obj The flip object
23813 * @param mode The interactive flip mode to use
23815 * This sets if the flip should be interactive (allow user to click and
23816 * drag a side of the flip to reveal the back page and cause it to flip).
23817 * By default a flip is not interactive. You may also need to set which
23818 * sides of the flip are "active" for flipping and how much space they use
23819 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
23820 * and elm_flip_interacton_direction_hitsize_set()
23822 * The four avilable mode of interaction are:
23823 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
23824 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
23825 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
23826 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
23828 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
23829 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
23830 * happen, those can only be acheived with elm_flip_go();
23832 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
23834 * @brief Get the interactive flip mode
23836 * @param obj The flip object
23837 * @return The interactive flip mode
23839 * Returns the interactive flip mode set by elm_flip_interaction_set()
23841 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
23843 * @brief Set which directions of the flip respond to interactive flip
23845 * @param obj The flip object
23846 * @param dir The direction to change
23847 * @param enabled If that direction is enabled or not
23849 * By default all directions are disabled, so you may want to enable the
23850 * desired directions for flipping if you need interactive flipping. You must
23851 * call this function once for each direction that should be enabled.
23853 * @see elm_flip_interaction_set()
23855 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
23857 * @brief Get the enabled state of that flip direction
23859 * @param obj The flip object
23860 * @param dir The direction to check
23861 * @return If that direction is enabled or not
23863 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
23865 * @see elm_flip_interaction_set()
23867 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
23869 * @brief Set the amount of the flip that is sensitive to interactive flip
23871 * @param obj The flip object
23872 * @param dir The direction to modify
23873 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
23875 * Set the amount of the flip that is sensitive to interactive flip, with 0
23876 * representing no area in the flip and 1 representing the entire flip. There
23877 * is however a consideration to be made in that the area will never be
23878 * smaller than the finger size set(as set in your Elementary configuration).
23880 * @see elm_flip_interaction_set()
23882 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
23884 * @brief Get the amount of the flip that is sensitive to interactive flip
23886 * @param obj The flip object
23887 * @param dir The direction to check
23888 * @return The size set for that direction
23890 * Returns the amount os sensitive area set by
23891 * elm_flip_interacton_direction_hitsize_set().
23893 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
23898 /* scrolledentry */
23899 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23900 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
23901 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23902 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
23903 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23904 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
23905 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23906 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
23907 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23908 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23909 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
23910 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
23911 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
23912 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23913 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
23914 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
23915 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
23916 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
23917 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
23918 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
23919 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
23920 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
23921 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
23922 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
23923 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
23924 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
23925 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23926 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23927 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23928 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23929 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23930 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
23931 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
23932 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
23933 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
23934 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);
23935 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
23936 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23937 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);
23938 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
23939 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);
23940 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
23941 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23942 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23943 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
23944 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
23945 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23946 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23947 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
23948 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);
23949 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);
23950 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);
23951 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);
23952 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);
23953 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);
23954 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
23955 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
23956 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
23957 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
23958 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23959 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
23960 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
23961 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
23962 EINA_DEPRECATED EAPI void elm_scrolled_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled);
23963 EINA_DEPRECATED EAPI void elm_scrolled_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout);
23964 EINA_DEPRECATED EAPI Ecore_IMF_Context *elm_scrolled_entry_imf_context_get(Evas_Object *obj);
23965 EINA_DEPRECATED EAPI void elm_scrolled_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
23966 EINA_DEPRECATED EAPI void elm_scrolled_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
23969 * @defgroup Conformant Conformant
23970 * @ingroup Elementary
23972 * @image html img/widget/conformant/preview-00.png
23973 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
23975 * @image html img/conformant.png
23976 * @image latex img/conformant.eps width=\textwidth
23978 * The aim is to provide a widget that can be used in elementary apps to
23979 * account for space taken up by the indicator, virtual keypad & softkey
23980 * windows when running the illume2 module of E17.
23982 * So conformant content will be sized and positioned considering the
23983 * space required for such stuff, and when they popup, as a keyboard
23984 * shows when an entry is selected, conformant content won't change.
23986 * Available styles for it:
23989 * Default contents parts of the conformant widget that you can use for are:
23990 * @li "elm.swallow.content" - A content of the conformant
23992 * See how to use this widget in this example:
23993 * @ref conformant_example
23997 * @addtogroup Conformant
24002 * Add a new conformant widget to the given parent Elementary
24003 * (container) object.
24005 * @param parent The parent object.
24006 * @return A new conformant widget handle or @c NULL, on errors.
24008 * This function inserts a new conformant widget on the canvas.
24010 * @ingroup Conformant
24012 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24015 * Set the content of the conformant widget.
24017 * @param obj The conformant object.
24018 * @param content The content to be displayed by the conformant.
24020 * Content will be sized and positioned considering the space required
24021 * to display a virtual keyboard. So it won't fill all the conformant
24022 * size. This way is possible to be sure that content won't resize
24023 * or be re-positioned after the keyboard is displayed.
24025 * Once the content object is set, a previously set one will be deleted.
24026 * If you want to keep that old content object, use the
24027 * elm_object_content_unset() function.
24029 * @see elm_object_content_unset()
24030 * @see elm_object_content_get()
24032 * @ingroup Conformant
24034 EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24037 * Get the content of the conformant widget.
24039 * @param obj The conformant object.
24040 * @return The content that is being used.
24042 * Return the content object which is set for this widget.
24043 * It won't be unparent from conformant. For that, use
24044 * elm_object_content_unset().
24046 * @see elm_object_content_set().
24047 * @see elm_object_content_unset()
24049 * @ingroup Conformant
24051 EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24054 * Unset the content of the conformant widget.
24056 * @param obj The conformant object.
24057 * @return The content that was being used.
24059 * Unparent and return the content object which was set for this widget.
24061 * @see elm_object_content_set().
24063 * @ingroup Conformant
24065 EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24068 * Returns the Evas_Object that represents the content area.
24070 * @param obj The conformant object.
24071 * @return The content area of the widget.
24073 * @ingroup Conformant
24075 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24082 * @defgroup Mapbuf Mapbuf
24083 * @ingroup Elementary
24085 * @image html img/widget/mapbuf/preview-00.png
24086 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
24088 * This holds one content object and uses an Evas Map of transformation
24089 * points to be later used with this content. So the content will be
24090 * moved, resized, etc as a single image. So it will improve performance
24091 * when you have a complex interafce, with a lot of elements, and will
24092 * need to resize or move it frequently (the content object and its
24095 * To set/get/unset the content of the mapbuf, you can use
24096 * elm_object_content_set/get/unset APIs.
24097 * Once the content object is set, a previously set one will be deleted.
24098 * If you want to keep that old content object, use the
24099 * elm_object_content_unset() function.
24101 * To enable map, elm_mapbuf_enabled_set() should be used.
24103 * See how to use this widget in this example:
24104 * @ref mapbuf_example
24108 * @addtogroup Mapbuf
24113 * Add a new mapbuf widget to the given parent Elementary
24114 * (container) object.
24116 * @param parent The parent object.
24117 * @return A new mapbuf widget handle or @c NULL, on errors.
24119 * This function inserts a new mapbuf widget on the canvas.
24123 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24126 * Set the content of the mapbuf.
24128 * @param obj The mapbuf object.
24129 * @param content The content that will be filled in this mapbuf object.
24131 * Once the content object is set, a previously set one will be deleted.
24132 * If you want to keep that old content object, use the
24133 * elm_mapbuf_content_unset() function.
24135 * To enable map, elm_mapbuf_enabled_set() should be used.
24139 EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24142 * Get the content of the mapbuf.
24144 * @param obj The mapbuf object.
24145 * @return The content that is being used.
24147 * Return the content object which is set for this widget.
24149 * @see elm_mapbuf_content_set() for details.
24153 EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24156 * Unset the content of the mapbuf.
24158 * @param obj The mapbuf object.
24159 * @return The content that was being used.
24161 * Unparent and return the content object which was set for this widget.
24163 * @see elm_mapbuf_content_set() for details.
24167 EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24170 * Enable or disable the map.
24172 * @param obj The mapbuf object.
24173 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
24175 * This enables the map that is set or disables it. On enable, the object
24176 * geometry will be saved, and the new geometry will change (position and
24177 * size) to reflect the map geometry set.
24179 * Also, when enabled, alpha and smooth states will be used, so if the
24180 * content isn't solid, alpha should be enabled, for example, otherwise
24181 * a black retangle will fill the content.
24183 * When disabled, the stored map will be freed and geometry prior to
24184 * enabling the map will be restored.
24186 * It's disabled by default.
24188 * @see elm_mapbuf_alpha_set()
24189 * @see elm_mapbuf_smooth_set()
24193 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
24196 * Get a value whether map is enabled or not.
24198 * @param obj The mapbuf object.
24199 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
24200 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24202 * @see elm_mapbuf_enabled_set() for details.
24206 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24209 * Enable or disable smooth map rendering.
24211 * @param obj The mapbuf object.
24212 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
24215 * This sets smoothing for map rendering. If the object is a type that has
24216 * its own smoothing settings, then both the smooth settings for this object
24217 * and the map must be turned off.
24219 * By default smooth maps are enabled.
24223 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
24226 * Get a value whether smooth map rendering is enabled or not.
24228 * @param obj The mapbuf object.
24229 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
24230 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24232 * @see elm_mapbuf_smooth_set() for details.
24236 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24239 * Set or unset alpha flag for map rendering.
24241 * @param obj The mapbuf object.
24242 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
24245 * This sets alpha flag for map rendering. If the object is a type that has
24246 * its own alpha settings, then this will take precedence. Only image objects
24247 * have this currently. It stops alpha blending of the map area, and is
24248 * useful if you know the object and/or all sub-objects is 100% solid.
24250 * Alpha is enabled by default.
24254 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
24257 * Get a value whether alpha blending is enabled or not.
24259 * @param obj The mapbuf object.
24260 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
24261 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24263 * @see elm_mapbuf_alpha_set() for details.
24267 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24274 * @defgroup Flipselector Flip Selector
24276 * A flip selector is a widget to show a set of @b text items, one
24277 * at a time, with the same sheet switching style as the @ref Clock
24278 * "clock" widget, when one changes the current displaying sheet
24279 * (thus, the "flip" in the name).
24281 * User clicks to flip sheets which are @b held for some time will
24282 * make the flip selector to flip continuosly and automatically for
24283 * the user. The interval between flips will keep growing in time,
24284 * so that it helps the user to reach an item which is distant from
24285 * the current selection.
24287 * Smart callbacks one can register to:
24288 * - @c "selected" - when the widget's selected text item is changed
24289 * - @c "overflowed" - when the widget's current selection is changed
24290 * from the first item in its list to the last
24291 * - @c "underflowed" - when the widget's current selection is changed
24292 * from the last item in its list to the first
24294 * Available styles for it:
24297 * Here is an example on its usage:
24298 * @li @ref flipselector_example
24302 * @addtogroup Flipselector
24306 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
24309 * Add a new flip selector widget to the given parent Elementary
24310 * (container) widget
24312 * @param parent The parent object
24313 * @return a new flip selector widget handle or @c NULL, on errors
24315 * This function inserts a new flip selector widget on the canvas.
24317 * @ingroup Flipselector
24319 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24322 * Programmatically select the next item of a flip selector widget
24324 * @param obj The flipselector object
24326 * @note The selection will be animated. Also, if it reaches the
24327 * end of its list of member items, it will continue with the first
24330 * @ingroup Flipselector
24332 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24335 * Programmatically select the previous item of a flip selector
24338 * @param obj The flipselector object
24340 * @note The selection will be animated. Also, if it reaches the
24341 * beginning of its list of member items, it will continue with the
24342 * last one backwards.
24344 * @ingroup Flipselector
24346 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24349 * Append a (text) item to a flip selector widget
24351 * @param obj The flipselector object
24352 * @param label The (text) label of the new item
24353 * @param func Convenience callback function to take place when
24355 * @param data Data passed to @p func, above
24356 * @return A handle to the item added or @c NULL, on errors
24358 * The widget's list of labels to show will be appended with the
24359 * given value. If the user wishes so, a callback function pointer
24360 * can be passed, which will get called when this same item is
24363 * @note The current selection @b won't be modified by appending an
24364 * element to the list.
24366 * @note The maximum length of the text label is going to be
24367 * determined <b>by the widget's theme</b>. Strings larger than
24368 * that value are going to be @b truncated.
24370 * @ingroup Flipselector
24372 EAPI Elm_Flipselector_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24375 * Prepend a (text) item to a flip selector widget
24377 * @param obj The flipselector object
24378 * @param label The (text) label of the new item
24379 * @param func Convenience callback function to take place when
24381 * @param data Data passed to @p func, above
24382 * @return A handle to the item added or @c NULL, on errors
24384 * The widget's list of labels to show will be prepended with the
24385 * given value. If the user wishes so, a callback function pointer
24386 * can be passed, which will get called when this same item is
24389 * @note The current selection @b won't be modified by prepending
24390 * an element to the list.
24392 * @note The maximum length of the text label is going to be
24393 * determined <b>by the widget's theme</b>. Strings larger than
24394 * that value are going to be @b truncated.
24396 * @ingroup Flipselector
24398 EAPI Elm_Flipselector_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24401 * Get the internal list of items in a given flip selector widget.
24403 * @param obj The flipselector object
24404 * @return The list of items (#Elm_Flipselector_Item as data) or @c
24407 * This list is @b not to be modified in any way and must not be
24408 * freed. Use the list members with functions like
24409 * elm_flipselector_item_label_set(),
24410 * elm_flipselector_item_label_get(), elm_flipselector_item_del(),
24411 * elm_flipselector_item_del(),
24412 * elm_flipselector_item_selected_get(),
24413 * elm_flipselector_item_selected_set().
24415 * @warning This list is only valid until @p obj object's internal
24416 * items list is changed. It should be fetched again with another
24417 * call to this function when changes happen.
24419 * @ingroup Flipselector
24421 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24424 * Get the first item in the given flip selector widget's list of
24427 * @param obj The flipselector object
24428 * @return The first item or @c NULL, if it has no items (and on
24431 * @see elm_flipselector_item_append()
24432 * @see elm_flipselector_last_item_get()
24434 * @ingroup Flipselector
24436 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24439 * Get the last item in the given flip selector widget's list of
24442 * @param obj The flipselector object
24443 * @return The last item or @c NULL, if it has no items (and on
24446 * @see elm_flipselector_item_prepend()
24447 * @see elm_flipselector_first_item_get()
24449 * @ingroup Flipselector
24451 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24454 * Get the currently selected item in a flip selector widget.
24456 * @param obj The flipselector object
24457 * @return The selected item or @c NULL, if the widget has no items
24460 * @ingroup Flipselector
24462 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24465 * Set whether a given flip selector widget's item should be the
24466 * currently selected one.
24468 * @param item The flip selector item
24469 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
24471 * This sets whether @p item is or not the selected (thus, under
24472 * display) one. If @p item is different than one under display,
24473 * the latter will be unselected. If the @p item is set to be
24474 * unselected, on the other hand, the @b first item in the widget's
24475 * internal members list will be the new selected one.
24477 * @see elm_flipselector_item_selected_get()
24479 * @ingroup Flipselector
24481 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
24484 * Get whether a given flip selector widget's item is the currently
24487 * @param item The flip selector item
24488 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
24491 * @see elm_flipselector_item_selected_set()
24493 * @ingroup Flipselector
24495 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24498 * Delete a given item from a flip selector widget.
24500 * @param item The item to delete
24502 * @ingroup Flipselector
24504 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24507 * Get the label of a given flip selector widget's item.
24509 * @param item The item to get label from
24510 * @return The text label of @p item or @c NULL, on errors
24512 * @see elm_flipselector_item_label_set()
24514 * @ingroup Flipselector
24516 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24519 * Set the label of a given flip selector widget's item.
24521 * @param item The item to set label on
24522 * @param label The text label string, in UTF-8 encoding
24524 * @see elm_flipselector_item_label_get()
24526 * @ingroup Flipselector
24528 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
24531 * Gets the item before @p item in a flip selector widget's
24532 * internal list of items.
24534 * @param item The item to fetch previous from
24535 * @return The item before the @p item, in its parent's list. If
24536 * there is no previous item for @p item or there's an
24537 * error, @c NULL is returned.
24539 * @see elm_flipselector_item_next_get()
24541 * @ingroup Flipselector
24543 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24546 * Gets the item after @p item in a flip selector widget's
24547 * internal list of items.
24549 * @param item The item to fetch next from
24550 * @return The item after the @p item, in its parent's list. If
24551 * there is no next item for @p item or there's an
24552 * error, @c NULL is returned.
24554 * @see elm_flipselector_item_next_get()
24556 * @ingroup Flipselector
24558 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24561 * Set the interval on time updates for an user mouse button hold
24562 * on a flip selector widget.
24564 * @param obj The flip selector object
24565 * @param interval The (first) interval value in seconds
24567 * This interval value is @b decreased while the user holds the
24568 * mouse pointer either flipping up or flipping doww a given flip
24571 * This helps the user to get to a given item distant from the
24572 * current one easier/faster, as it will start to flip quicker and
24573 * quicker on mouse button holds.
24575 * The calculation for the next flip interval value, starting from
24576 * the one set with this call, is the previous interval divided by
24577 * 1.05, so it decreases a little bit.
24579 * The default starting interval value for automatic flips is
24582 * @see elm_flipselector_interval_get()
24584 * @ingroup Flipselector
24586 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
24589 * Get the interval on time updates for an user mouse button hold
24590 * on a flip selector widget.
24592 * @param obj The flip selector object
24593 * @return The (first) interval value, in seconds, set on it
24595 * @see elm_flipselector_interval_set() for more details
24597 * @ingroup Flipselector
24599 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24606 * @addtogroup Animator Animator
24607 * @ingroup Elementary
24609 * @brief Functions to ease creation of animations.
24611 * elm_animator is designed to provide an easy way to create animations.
24612 * Creating an animation with elm_animator is as simple as setting a
24613 * duration, an operating callback and telling it to run the animation.
24614 * However that is not the full extent of elm_animator's ability, animations
24615 * can be paused and resumed, reversed and the animation need not be linear.
24617 * To run an animation you must specify at least a duration and operation
24618 * callback, not setting any other properties will create a linear animation
24619 * that runs once and is not reversed.
24621 * @ref elm_animator_example_page_01 "This" example should make all of that
24624 * @warning elm_animator is @b not a widget.
24628 * @brief Type of curve desired for animation.
24630 * The speed in which an animation happens doesn't have to be linear, some
24631 * animations will look better if they're accelerating or decelerating, so
24632 * elm_animator provides four options in this regard:
24633 * @image html elm_animator_curve_style.png
24634 * @image latex elm_animator_curve_style.eps width=\textwidth
24635 * As can be seen in the image the speed of the animation will be:
24636 * @li ELM_ANIMATOR_CURVE_LINEAR constant
24637 * @li ELM_ANIMATOR_CURVE_IN_OUT start slow, speed up and then slow down
24638 * @li ELM_ANIMATOR_CURVE_IN start slow and then speed up
24639 * @li ELM_ANIMATOR_CURVE_OUT start fast and then slow down
24643 ELM_ANIMATOR_CURVE_LINEAR,
24644 ELM_ANIMATOR_CURVE_IN_OUT,
24645 ELM_ANIMATOR_CURVE_IN,
24646 ELM_ANIMATOR_CURVE_OUT
24647 } Elm_Animator_Curve_Style;
24648 typedef struct _Elm_Animator Elm_Animator;
24650 * Called back per loop of an elementary animators cycle
24651 * @param data user-data given to elm_animator_operation_callback_set()
24652 * @param animator the animator being run
24653 * @param double the position in the animation
24655 typedef void (*Elm_Animator_Operation_Cb) (void *data, Elm_Animator *animator, double frame);
24657 * Called back when an elementary animator finishes
24658 * @param data user-data given to elm_animator_completion_callback_set()
24660 typedef void (*Elm_Animator_Completion_Cb) (void *data);
24663 * @brief Create a new animator.
24665 * @param[in] parent Parent object
24667 * The @a parent argument can be set to NULL for no parent. If a parent is set
24668 * there is no need to call elm_animator_del(), when the parent is deleted it
24669 * will delete the animator.
24670 * @deprecated Use @ref Transit instead.
24673 EINA_DEPRECATED EAPI Elm_Animator* elm_animator_add(Evas_Object *parent);
24675 * Deletes the animator freeing any resources it used. If the animator was
24676 * created with a NULL parent this must be called, otherwise it will be
24677 * automatically called when the parent is deleted.
24679 * @param[in] animator Animator object
24680 * @deprecated Use @ref Transit instead.
24682 EINA_DEPRECATED EAPI void elm_animator_del(Elm_Animator *animator) EINA_ARG_NONNULL(1);
24684 * Set the duration of the animation.
24686 * @param[in] animator Animator object
24687 * @param[in] duration Duration in second
24688 * @deprecated Use @ref Transit instead.
24690 EINA_DEPRECATED EAPI void elm_animator_duration_set(Elm_Animator *animator, double duration) EINA_ARG_NONNULL(1);
24692 * @brief Set the callback function for animator operation.
24694 * @param[in] animator Animator object
24695 * @param[in] func @ref Elm_Animator_Operation_Cb "Callback" function pointer
24696 * @param[in] data Callback function user argument
24698 * The @p func callback will be called with a frame value in range [0, 1] which
24699 * indicates how far along the animation should be. It is the job of @p func to
24700 * actually change the state of any object(or objects) that are being animated.
24701 * @deprecated Use @ref Transit instead.
24703 EINA_DEPRECATED EAPI void elm_animator_operation_callback_set(Elm_Animator *animator, Elm_Animator_Operation_Cb func, void *data) EINA_ARG_NONNULL(1);
24705 * Set the callback function for the when the animation ends.
24707 * @param[in] animator Animator object
24708 * @param[in] func Callback function pointe
24709 * @param[in] data Callback function user argument
24711 * @warning @a func will not be executed if elm_animator_stop() is called.
24712 * @deprecated Use @ref Transit instead.
24714 EINA_DEPRECATED EAPI void elm_animator_completion_callback_set(Elm_Animator *animator, Elm_Animator_Completion_Cb func, void *data) EINA_ARG_NONNULL(1);
24716 * @brief Stop animator.
24718 * @param[in] animator Animator object
24720 * If called before elm_animator_animate() it does nothing. If there is an
24721 * animation in progress the animation will be stopped(the operation callback
24722 * will not be executed again) and it can't be restarted using
24723 * elm_animator_resume().
24724 * @deprecated Use @ref Transit instead.
24726 EINA_DEPRECATED EAPI void elm_animator_stop(Elm_Animator *animator) EINA_ARG_NONNULL(1);
24728 * Set the animator repeat count.
24730 * @param[in] animator Animator object
24731 * @param[in] repeat_cnt Repeat count
24732 * @deprecated Use @ref Transit instead.
24734 EINA_DEPRECATED EAPI void elm_animator_repeat_set(Elm_Animator *animator, unsigned int repeat_cnt) EINA_ARG_NONNULL(1);
24736 * @brief Start animation.
24738 * @param[in] animator Animator object
24740 * This function starts the animation if the nescessary properties(duration
24741 * and operation callback) have been set. Once started the animation will
24742 * run until complete or elm_animator_stop() is called.
24743 * @deprecated Use @ref Transit instead.
24745 EINA_DEPRECATED EAPI void elm_animator_animate(Elm_Animator *animator) EINA_ARG_NONNULL(1);
24747 * Sets the animation @ref Elm_Animator_Curve_Style "acceleration style".
24749 * @param[in] animator Animator object
24750 * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
24751 * @deprecated Use @ref Transit instead.
24753 EINA_DEPRECATED EAPI void elm_animator_curve_style_set(Elm_Animator *animator, Elm_Animator_Curve_Style cs) EINA_ARG_NONNULL(1);
24755 * Gets the animation @ref Elm_Animator_Curve_Style "acceleration style".
24757 * @param[in] animator Animator object
24758 * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
24759 * @deprecated Use @ref Transit instead.
24761 EINA_DEPRECATED EAPI Elm_Animator_Curve_Style elm_animator_curve_style_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
24763 * @brief Sets wether the animation should be automatically reversed.
24765 * @param[in] animator Animator object
24766 * @param[in] reverse Reverse or not
24768 * This controls wether the animation will be run on reverse imediately after
24769 * running forward. When this is set together with repetition the animation
24770 * will run in reverse once for each time it ran forward.@n
24771 * Runnin an animation in reverse is accomplished by calling the operation
24772 * callback with a frame value starting at 1 and diminshing until 0.
24773 * @deprecated Use @ref Transit instead.
24775 EINA_DEPRECATED EAPI void elm_animator_auto_reverse_set(Elm_Animator *animator, Eina_Bool reverse) EINA_ARG_NONNULL(1);
24777 * Gets wether the animation will automatically reversed
24779 * @param[in] animator Animator object
24780 * @deprecated Use @ref Transit instead.
24782 EINA_DEPRECATED EAPI Eina_Bool elm_animator_auto_reverse_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
24784 * Gets the status for the animator operation. The status of the animator @b
24785 * doesn't take in to account elm_animator_pause() or elm_animator_resume(), it
24786 * only informs if the animation was started and has not ended(either normally
24787 * or through elm_animator_stop()).
24789 * @param[in] animator Animator object
24790 * @deprecated Use @ref Transit instead.
24792 EINA_DEPRECATED EAPI Eina_Bool elm_animator_operating_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
24794 * Gets how many times the animation will be repeated
24796 * @param[in] animator Animator object
24797 * @deprecated Use @ref Transit instead.
24799 EINA_DEPRECATED EAPI unsigned int elm_animator_repeat_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
24801 * Pause the animator.
24803 * @param[in] animator Animator object
24805 * This causes the animation to be temporarily stopped(the operation callback
24806 * will not be called). If the animation is not yet running this is a no-op.
24807 * Once an animation has been paused with this function it can be resumed
24808 * using elm_animator_resume().
24809 * @deprecated Use @ref Transit instead.
24811 EINA_DEPRECATED EAPI void elm_animator_pause(Elm_Animator *animator) EINA_ARG_NONNULL(1);
24813 * @brief Resumes the animator.
24815 * @param[in] animator Animator object
24817 * Resumes an animation that was paused using elm_animator_pause(), after
24818 * calling this function calls to the operation callback will happen
24819 * normally. If an animation is stopped by means of elm_animator_stop it
24820 * @b can't be restarted with this function.@n
24822 * @warning When an animation is resumed it doesn't start from where it was paused, it
24823 * will go to where it would have been if it had not been paused. If an
24824 * animation with a duration of 3 seconds is paused after 1 second for 1 second
24825 * it will resume as if it had ben animating for 2 seconds, the operating
24826 * callback will be called with a frame value of aproximately 2/3.
24827 * @deprecated Use @ref Transit instead.
24829 EINA_DEPRECATED EAPI void elm_animator_resume(Elm_Animator *animator) EINA_ARG_NONNULL(1);
24835 * @addtogroup Calendar
24840 * @enum _Elm_Calendar_Mark_Repeat
24841 * @typedef Elm_Calendar_Mark_Repeat
24843 * Event periodicity, used to define if a mark should be repeated
24844 * @b beyond event's day. It's set when a mark is added.
24846 * So, for a mark added to 13th May with periodicity set to WEEKLY,
24847 * there will be marks every week after this date. Marks will be displayed
24848 * at 13th, 20th, 27th, 3rd June ...
24850 * Values don't work as bitmask, only one can be choosen.
24852 * @see elm_calendar_mark_add()
24854 * @ingroup Calendar
24856 typedef enum _Elm_Calendar_Mark_Repeat
24858 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
24859 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
24860 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
24861 ELM_CALENDAR_MONTHLY, /**< Marks will be displayed every month day that coincides to event day. E.g.: if an event is set to 30th Jan, no marks will be displayed on Feb, but will be displayed on 30th Mar*/
24862 ELM_CALENDAR_ANNUALLY /**< Marks will be displayed every year that coincides to event day (and month). E.g. an event added to 30th Jan 2012 will be repeated on 30th Jan 2013. */
24863 } Elm_Calendar_Mark_Repeat;
24865 typedef struct _Elm_Calendar_Mark Elm_Calendar_Mark; /**< Item handle for a calendar mark. Created with elm_calendar_mark_add() and deleted with elm_calendar_mark_del(). */
24868 * Add a new calendar widget to the given parent Elementary
24869 * (container) object.
24871 * @param parent The parent object.
24872 * @return a new calendar widget handle or @c NULL, on errors.
24874 * This function inserts a new calendar widget on the canvas.
24876 * @ref calendar_example_01
24878 * @ingroup Calendar
24880 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24883 * Get weekdays names displayed by the calendar.
24885 * @param obj The calendar object.
24886 * @return Array of seven strings to be used as weekday names.
24888 * By default, weekdays abbreviations get from system are displayed:
24889 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
24890 * The first string is related to Sunday, the second to Monday...
24892 * @see elm_calendar_weekdays_name_set()
24894 * @ref calendar_example_05
24896 * @ingroup Calendar
24898 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24901 * Set weekdays names to be displayed by the calendar.
24903 * @param obj The calendar object.
24904 * @param weekdays Array of seven strings to be used as weekday names.
24905 * @warning It must have 7 elements, or it will access invalid memory.
24906 * @warning The strings must be NULL terminated ('@\0').
24908 * By default, weekdays abbreviations get from system are displayed:
24909 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
24911 * The first string should be related to Sunday, the second to Monday...
24913 * The usage should be like this:
24915 * const char *weekdays[] =
24917 * "Sunday", "Monday", "Tuesday", "Wednesday",
24918 * "Thursday", "Friday", "Saturday"
24920 * elm_calendar_weekdays_names_set(calendar, weekdays);
24923 * @see elm_calendar_weekdays_name_get()
24925 * @ref calendar_example_02
24927 * @ingroup Calendar
24929 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
24932 * Set the minimum and maximum values for the year
24934 * @param obj The calendar object
24935 * @param min The minimum year, greater than 1901;
24936 * @param max The maximum year;
24938 * Maximum must be greater than minimum, except if you don't wan't to set
24940 * Default values are 1902 and -1.
24942 * If the maximum year is a negative value, it will be limited depending
24943 * on the platform architecture (year 2037 for 32 bits);
24945 * @see elm_calendar_min_max_year_get()
24947 * @ref calendar_example_03
24949 * @ingroup Calendar
24951 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
24954 * Get the minimum and maximum values for the year
24956 * @param obj The calendar object.
24957 * @param min The minimum year.
24958 * @param max The maximum year.
24960 * Default values are 1902 and -1.
24962 * @see elm_calendar_min_max_year_get() for more details.
24964 * @ref calendar_example_05
24966 * @ingroup Calendar
24968 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
24971 * Enable or disable day selection
24973 * @param obj The calendar object.
24974 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
24977 * Enabled by default. If disabled, the user still can select months,
24978 * but not days. Selected days are highlighted on calendar.
24979 * It should be used if you won't need such selection for the widget usage.
24981 * When a day is selected, or month is changed, smart callbacks for
24982 * signal "changed" will be called.
24984 * @see elm_calendar_day_selection_enable_get()
24986 * @ref calendar_example_04
24988 * @ingroup Calendar
24990 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
24993 * Get a value whether day selection is enabled or not.
24995 * @see elm_calendar_day_selection_enable_set() for details.
24997 * @param obj The calendar object.
24998 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
24999 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
25001 * @ref calendar_example_05
25003 * @ingroup Calendar
25005 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25009 * Set selected date to be highlighted on calendar.
25011 * @param obj The calendar object.
25012 * @param selected_time A @b tm struct to represent the selected date.
25014 * Set the selected date, changing the displayed month if needed.
25015 * Selected date changes when the user goes to next/previous month or
25016 * select a day pressing over it on calendar.
25018 * @see elm_calendar_selected_time_get()
25020 * @ref calendar_example_04
25022 * @ingroup Calendar
25024 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
25027 * Get selected date.
25029 * @param obj The calendar object
25030 * @param selected_time A @b tm struct to point to selected date
25031 * @return EINA_FALSE means an error ocurred and returned time shouldn't
25034 * Get date selected by the user or set by function
25035 * elm_calendar_selected_time_set().
25036 * Selected date changes when the user goes to next/previous month or
25037 * select a day pressing over it on calendar.
25039 * @see elm_calendar_selected_time_get()
25041 * @ref calendar_example_05
25043 * @ingroup Calendar
25045 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
25048 * Set a function to format the string that will be used to display
25051 * @param obj The calendar object
25052 * @param format_function Function to set the month-year string given
25053 * the selected date
25055 * By default it uses strftime with "%B %Y" format string.
25056 * It should allocate the memory that will be used by the string,
25057 * that will be freed by the widget after usage.
25058 * A pointer to the string and a pointer to the time struct will be provided.
25063 * _format_month_year(struct tm *selected_time)
25066 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
25067 * return strdup(buf);
25070 * elm_calendar_format_function_set(calendar, _format_month_year);
25073 * @ref calendar_example_02
25075 * @ingroup Calendar
25077 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
25080 * Add a new mark to the calendar
25082 * @param obj The calendar object
25083 * @param mark_type A string used to define the type of mark. It will be
25084 * emitted to the theme, that should display a related modification on these
25085 * days representation.
25086 * @param mark_time A time struct to represent the date of inclusion of the
25087 * mark. For marks that repeats it will just be displayed after the inclusion
25088 * date in the calendar.
25089 * @param repeat Repeat the event following this periodicity. Can be a unique
25090 * mark (that don't repeat), daily, weekly, monthly or annually.
25091 * @return The created mark or @p NULL upon failure.
25093 * Add a mark that will be drawn in the calendar respecting the insertion
25094 * time and periodicity. It will emit the type as signal to the widget theme.
25095 * Default theme supports "holiday" and "checked", but it can be extended.
25097 * It won't immediately update the calendar, drawing the marks.
25098 * For this, call elm_calendar_marks_draw(). However, when user selects
25099 * next or previous month calendar forces marks drawn.
25101 * Marks created with this method can be deleted with
25102 * elm_calendar_mark_del().
25106 * struct tm selected_time;
25107 * time_t current_time;
25109 * current_time = time(NULL) + 5 * 84600;
25110 * localtime_r(¤t_time, &selected_time);
25111 * elm_calendar_mark_add(cal, "holiday", selected_time,
25112 * ELM_CALENDAR_ANNUALLY);
25114 * current_time = time(NULL) + 1 * 84600;
25115 * localtime_r(¤t_time, &selected_time);
25116 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
25118 * elm_calendar_marks_draw(cal);
25121 * @see elm_calendar_marks_draw()
25122 * @see elm_calendar_mark_del()
25124 * @ref calendar_example_06
25126 * @ingroup Calendar
25128 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);
25131 * Delete mark from the calendar.
25133 * @param mark The mark to be deleted.
25135 * If deleting all calendar marks is required, elm_calendar_marks_clear()
25136 * should be used instead of getting marks list and deleting each one.
25138 * @see elm_calendar_mark_add()
25140 * @ref calendar_example_06
25142 * @ingroup Calendar
25144 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
25147 * Remove all calendar's marks
25149 * @param obj The calendar object.
25151 * @see elm_calendar_mark_add()
25152 * @see elm_calendar_mark_del()
25154 * @ingroup Calendar
25156 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25160 * Get a list of all the calendar marks.
25162 * @param obj The calendar object.
25163 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
25165 * @see elm_calendar_mark_add()
25166 * @see elm_calendar_mark_del()
25167 * @see elm_calendar_marks_clear()
25169 * @ingroup Calendar
25171 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25174 * Draw calendar marks.
25176 * @param obj The calendar object.
25178 * Should be used after adding, removing or clearing marks.
25179 * It will go through the entire marks list updating the calendar.
25180 * If lots of marks will be added, add all the marks and then call
25183 * When the month is changed, i.e. user selects next or previous month,
25184 * marks will be drawed.
25186 * @see elm_calendar_mark_add()
25187 * @see elm_calendar_mark_del()
25188 * @see elm_calendar_marks_clear()
25190 * @ref calendar_example_06
25192 * @ingroup Calendar
25194 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
25195 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25196 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25197 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25200 * Set a day text color to the same that represents Saturdays.
25202 * @param obj The calendar object.
25203 * @param pos The text position. Position is the cell counter, from left
25204 * to right, up to down. It starts on 0 and ends on 41.
25206 * @deprecated use elm_calendar_mark_add() instead like:
25209 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
25210 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25213 * @see elm_calendar_mark_add()
25215 * @ingroup Calendar
25217 EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25220 * Set a day text color to the same that represents Sundays.
25222 * @param obj The calendar object.
25223 * @param pos The text position. Position is the cell counter, from left
25224 * to right, up to down. It starts on 0 and ends on 41.
25226 * @deprecated use elm_calendar_mark_add() instead like:
25229 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
25230 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25233 * @see elm_calendar_mark_add()
25235 * @ingroup Calendar
25237 EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25240 * Set a day text color to the same that represents Weekdays.
25242 * @param obj The calendar object
25243 * @param pos The text position. Position is the cell counter, from left
25244 * to right, up to down. It starts on 0 and ends on 41.
25246 * @deprecated use elm_calendar_mark_add() instead like:
25249 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
25251 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
25252 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25253 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
25254 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25255 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
25256 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25257 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
25258 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25259 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
25262 * @see elm_calendar_mark_add()
25264 * @ingroup Calendar
25266 EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25269 * Set the interval on time updates for an user mouse button hold
25270 * on calendar widgets' month selection.
25272 * @param obj The calendar object
25273 * @param interval The (first) interval value in seconds
25275 * This interval value is @b decreased while the user holds the
25276 * mouse pointer either selecting next or previous month.
25278 * This helps the user to get to a given month distant from the
25279 * current one easier/faster, as it will start to change quicker and
25280 * quicker on mouse button holds.
25282 * The calculation for the next change interval value, starting from
25283 * the one set with this call, is the previous interval divided by
25284 * 1.05, so it decreases a little bit.
25286 * The default starting interval value for automatic changes is
25289 * @see elm_calendar_interval_get()
25291 * @ingroup Calendar
25293 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25296 * Get the interval on time updates for an user mouse button hold
25297 * on calendar widgets' month selection.
25299 * @param obj The calendar object
25300 * @return The (first) interval value, in seconds, set on it
25302 * @see elm_calendar_interval_set() for more details
25304 * @ingroup Calendar
25306 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25313 * @defgroup Diskselector Diskselector
25314 * @ingroup Elementary
25316 * @image html img/widget/diskselector/preview-00.png
25317 * @image latex img/widget/diskselector/preview-00.eps
25319 * A diskselector is a kind of list widget. It scrolls horizontally,
25320 * and can contain label and icon objects. Three items are displayed
25321 * with the selected one in the middle.
25323 * It can act like a circular list with round mode and labels can be
25324 * reduced for a defined length for side items.
25326 * Smart callbacks one can listen to:
25327 * - "selected" - when item is selected, i.e. scroller stops.
25329 * Available styles for it:
25332 * List of examples:
25333 * @li @ref diskselector_example_01
25334 * @li @ref diskselector_example_02
25338 * @addtogroup Diskselector
25342 typedef struct _Elm_Diskselector_Item Elm_Diskselector_Item; /**< Item handle for a diskselector item. Created with elm_diskselector_item_append() and deleted with elm_diskselector_item_del(). */
25345 * Add a new diskselector widget to the given parent Elementary
25346 * (container) object.
25348 * @param parent The parent object.
25349 * @return a new diskselector widget handle or @c NULL, on errors.
25351 * This function inserts a new diskselector widget on the canvas.
25353 * @ingroup Diskselector
25355 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25358 * Enable or disable round mode.
25360 * @param obj The diskselector object.
25361 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
25364 * Disabled by default. If round mode is enabled the items list will
25365 * work like a circle list, so when the user reaches the last item,
25366 * the first one will popup.
25368 * @see elm_diskselector_round_get()
25370 * @ingroup Diskselector
25372 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
25375 * Get a value whether round mode is enabled or not.
25377 * @see elm_diskselector_round_set() for details.
25379 * @param obj The diskselector object.
25380 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
25381 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25383 * @ingroup Diskselector
25385 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25388 * Get the side labels max length.
25390 * @deprecated use elm_diskselector_side_label_length_get() instead:
25392 * @param obj The diskselector object.
25393 * @return The max length defined for side labels, or 0 if not a valid
25396 * @ingroup Diskselector
25398 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25401 * Set the side labels max length.
25403 * @deprecated use elm_diskselector_side_label_length_set() instead:
25405 * @param obj The diskselector object.
25406 * @param len The max length defined for side labels.
25408 * @ingroup Diskselector
25410 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25413 * Get the side labels max length.
25415 * @see elm_diskselector_side_label_length_set() for details.
25417 * @param obj The diskselector object.
25418 * @return The max length defined for side labels, or 0 if not a valid
25421 * @ingroup Diskselector
25423 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25426 * Set the side labels max length.
25428 * @param obj The diskselector object.
25429 * @param len The max length defined for side labels.
25431 * Length is the number of characters of items' label that will be
25432 * visible when it's set on side positions. It will just crop
25433 * the string after defined size. E.g.:
25435 * An item with label "January" would be displayed on side position as
25436 * "Jan" if max length is set to 3, or "Janu", if this property
25439 * When it's selected, the entire label will be displayed, except for
25440 * width restrictions. In this case label will be cropped and "..."
25441 * will be concatenated.
25443 * Default side label max length is 3.
25445 * This property will be applyed over all items, included before or
25446 * later this function call.
25448 * @ingroup Diskselector
25450 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25453 * Set the number of items to be displayed.
25455 * @param obj The diskselector object.
25456 * @param num The number of items the diskselector will display.
25458 * Default value is 3, and also it's the minimun. If @p num is less
25459 * than 3, it will be set to 3.
25461 * Also, it can be set on theme, using data item @c display_item_num
25462 * on group "elm/diskselector/item/X", where X is style set.
25465 * group { name: "elm/diskselector/item/X";
25467 * item: "display_item_num" "5";
25470 * @ingroup Diskselector
25472 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
25475 * Get the number of items in the diskselector object.
25477 * @param obj The diskselector object.
25479 * @ingroup Diskselector
25481 EAPI int elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25484 * Set bouncing behaviour when the scrolled content reaches an edge.
25486 * Tell the internal scroller object whether it should bounce or not
25487 * when it reaches the respective edges for each axis.
25489 * @param obj The diskselector object.
25490 * @param h_bounce Whether to bounce or not in the horizontal axis.
25491 * @param v_bounce Whether to bounce or not in the vertical axis.
25493 * @see elm_scroller_bounce_set()
25495 * @ingroup Diskselector
25497 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
25500 * Get the bouncing behaviour of the internal scroller.
25502 * Get whether the internal scroller should bounce when the edge of each
25503 * axis is reached scrolling.
25505 * @param obj The diskselector object.
25506 * @param h_bounce Pointer where to store the bounce state of the horizontal
25508 * @param v_bounce Pointer where to store the bounce state of the vertical
25511 * @see elm_scroller_bounce_get()
25512 * @see elm_diskselector_bounce_set()
25514 * @ingroup Diskselector
25516 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
25519 * Get the scrollbar policy.
25521 * @see elm_diskselector_scroller_policy_get() for details.
25523 * @param obj The diskselector object.
25524 * @param policy_h Pointer where to store horizontal scrollbar policy.
25525 * @param policy_v Pointer where to store vertical scrollbar policy.
25527 * @ingroup Diskselector
25529 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);
25532 * Set the scrollbar policy.
25534 * @param obj The diskselector object.
25535 * @param policy_h Horizontal scrollbar policy.
25536 * @param policy_v Vertical scrollbar policy.
25538 * This sets the scrollbar visibility policy for the given scroller.
25539 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
25540 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
25541 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
25542 * This applies respectively for the horizontal and vertical scrollbars.
25544 * The both are disabled by default, i.e., are set to
25545 * #ELM_SCROLLER_POLICY_OFF.
25547 * @ingroup Diskselector
25549 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
25552 * Remove all diskselector's items.
25554 * @param obj The diskselector object.
25556 * @see elm_diskselector_item_del()
25557 * @see elm_diskselector_item_append()
25559 * @ingroup Diskselector
25561 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25564 * Get a list of all the diskselector items.
25566 * @param obj The diskselector object.
25567 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
25568 * or @c NULL on failure.
25570 * @see elm_diskselector_item_append()
25571 * @see elm_diskselector_item_del()
25572 * @see elm_diskselector_clear()
25574 * @ingroup Diskselector
25576 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25579 * Appends a new item to the diskselector object.
25581 * @param obj The diskselector object.
25582 * @param label The label of the diskselector item.
25583 * @param icon The icon object to use at left side of the item. An
25584 * icon can be any Evas object, but usually it is an icon created
25585 * with elm_icon_add().
25586 * @param func The function to call when the item is selected.
25587 * @param data The data to associate with the item for related callbacks.
25589 * @return The created item or @c NULL upon failure.
25591 * A new item will be created and appended to the diskselector, i.e., will
25592 * be set as last item. Also, if there is no selected item, it will
25593 * be selected. This will always happens for the first appended item.
25595 * If no icon is set, label will be centered on item position, otherwise
25596 * the icon will be placed at left of the label, that will be shifted
25599 * Items created with this method can be deleted with
25600 * elm_diskselector_item_del().
25602 * Associated @p data can be properly freed when item is deleted if a
25603 * callback function is set with elm_diskselector_item_del_cb_set().
25605 * If a function is passed as argument, it will be called everytime this item
25606 * is selected, i.e., the user stops the diskselector with this
25607 * item on center position. If such function isn't needed, just passing
25608 * @c NULL as @p func is enough. The same should be done for @p data.
25610 * Simple example (with no function callback or data associated):
25612 * disk = elm_diskselector_add(win);
25613 * ic = elm_icon_add(win);
25614 * elm_icon_file_set(ic, "path/to/image", NULL);
25615 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
25616 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
25619 * @see elm_diskselector_item_del()
25620 * @see elm_diskselector_item_del_cb_set()
25621 * @see elm_diskselector_clear()
25622 * @see elm_icon_add()
25624 * @ingroup Diskselector
25626 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);
25630 * Delete them item from the diskselector.
25632 * @param it The item of diskselector to be deleted.
25634 * If deleting all diskselector items is required, elm_diskselector_clear()
25635 * should be used instead of getting items list and deleting each one.
25637 * @see elm_diskselector_clear()
25638 * @see elm_diskselector_item_append()
25639 * @see elm_diskselector_item_del_cb_set()
25641 * @ingroup Diskselector
25643 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25646 * Set the function called when a diskselector item is freed.
25648 * @param it The item to set the callback on
25649 * @param func The function called
25651 * If there is a @p func, then it will be called prior item's memory release.
25652 * That will be called with the following arguments:
25654 * @li item's Evas object;
25657 * This way, a data associated to a diskselector item could be properly
25660 * @ingroup Diskselector
25662 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
25665 * Get the data associated to the item.
25667 * @param it The diskselector item
25668 * @return The data associated to @p it
25670 * The return value is a pointer to data associated to @p item when it was
25671 * created, with function elm_diskselector_item_append(). If no data
25672 * was passed as argument, it will return @c NULL.
25674 * @see elm_diskselector_item_append()
25676 * @ingroup Diskselector
25678 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25681 * Set the icon associated to the item.
25683 * @param it The diskselector item
25684 * @param icon The icon object to associate with @p it
25686 * The icon object to use at left side of the item. An
25687 * icon can be any Evas object, but usually it is an icon created
25688 * with elm_icon_add().
25690 * Once the icon object is set, a previously set one will be deleted.
25691 * @warning Setting the same icon for two items will cause the icon to
25692 * dissapear from the first item.
25694 * If an icon was passed as argument on item creation, with function
25695 * elm_diskselector_item_append(), it will be already
25696 * associated to the item.
25698 * @see elm_diskselector_item_append()
25699 * @see elm_diskselector_item_icon_get()
25701 * @ingroup Diskselector
25703 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
25706 * Get the icon associated to the item.
25708 * @param it The diskselector item
25709 * @return The icon associated to @p it
25711 * The return value is a pointer to the icon associated to @p item when it was
25712 * created, with function elm_diskselector_item_append(), or later
25713 * with function elm_diskselector_item_icon_set. If no icon
25714 * was passed as argument, it will return @c NULL.
25716 * @see elm_diskselector_item_append()
25717 * @see elm_diskselector_item_icon_set()
25719 * @ingroup Diskselector
25721 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25724 * Set the label of item.
25726 * @param it The item of diskselector.
25727 * @param label The label of item.
25729 * The label to be displayed by the item.
25731 * If no icon is set, label will be centered on item position, otherwise
25732 * the icon will be placed at left of the label, that will be shifted
25735 * An item with label "January" would be displayed on side position as
25736 * "Jan" if max length is set to 3 with function
25737 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
25740 * When this @p item is selected, the entire label will be displayed,
25741 * except for width restrictions.
25742 * In this case label will be cropped and "..." will be concatenated,
25743 * but only for display purposes. It will keep the entire string, so
25744 * if diskselector is resized the remaining characters will be displayed.
25746 * If a label was passed as argument on item creation, with function
25747 * elm_diskselector_item_append(), it will be already
25748 * displayed by the item.
25750 * @see elm_diskselector_side_label_lenght_set()
25751 * @see elm_diskselector_item_label_get()
25752 * @see elm_diskselector_item_append()
25754 * @ingroup Diskselector
25756 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
25759 * Get the label of item.
25761 * @param it The item of diskselector.
25762 * @return The label of item.
25764 * The return value is a pointer to the label associated to @p item when it was
25765 * created, with function elm_diskselector_item_append(), or later
25766 * with function elm_diskselector_item_label_set. If no label
25767 * was passed as argument, it will return @c NULL.
25769 * @see elm_diskselector_item_label_set() for more details.
25770 * @see elm_diskselector_item_append()
25772 * @ingroup Diskselector
25774 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25777 * Get the selected item.
25779 * @param obj The diskselector object.
25780 * @return The selected diskselector item.
25782 * The selected item can be unselected with function
25783 * elm_diskselector_item_selected_set(), and the first item of
25784 * diskselector will be selected.
25786 * The selected item always will be centered on diskselector, with
25787 * full label displayed, i.e., max lenght set to side labels won't
25788 * apply on the selected item. More details on
25789 * elm_diskselector_side_label_length_set().
25791 * @ingroup Diskselector
25793 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25796 * Set the selected state of an item.
25798 * @param it The diskselector item
25799 * @param selected The selected state
25801 * This sets the selected state of the given item @p it.
25802 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
25804 * If a new item is selected the previosly selected will be unselected.
25805 * Previoulsy selected item can be get with function
25806 * elm_diskselector_selected_item_get().
25808 * If the item @p it is unselected, the first item of diskselector will
25811 * Selected items will be visible on center position of diskselector.
25812 * So if it was on another position before selected, or was invisible,
25813 * diskselector will animate items until the selected item reaches center
25816 * @see elm_diskselector_item_selected_get()
25817 * @see elm_diskselector_selected_item_get()
25819 * @ingroup Diskselector
25821 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
25824 * Get whether the @p item is selected or not.
25826 * @param it The diskselector item.
25827 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
25828 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
25830 * @see elm_diskselector_selected_item_set() for details.
25831 * @see elm_diskselector_item_selected_get()
25833 * @ingroup Diskselector
25835 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25838 * Get the first item of the diskselector.
25840 * @param obj The diskselector object.
25841 * @return The first item, or @c NULL if none.
25843 * The list of items follows append order. So it will return the first
25844 * item appended to the widget that wasn't deleted.
25846 * @see elm_diskselector_item_append()
25847 * @see elm_diskselector_items_get()
25849 * @ingroup Diskselector
25851 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25854 * Get the last item of the diskselector.
25856 * @param obj The diskselector object.
25857 * @return The last item, or @c NULL if none.
25859 * The list of items follows append order. So it will return last first
25860 * item appended to the widget that wasn't deleted.
25862 * @see elm_diskselector_item_append()
25863 * @see elm_diskselector_items_get()
25865 * @ingroup Diskselector
25867 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25870 * Get the item before @p item in diskselector.
25872 * @param it The diskselector item.
25873 * @return The item before @p item, or @c NULL if none or on failure.
25875 * The list of items follows append order. So it will return item appended
25876 * just before @p item and that wasn't deleted.
25878 * If it is the first item, @c NULL will be returned.
25879 * First item can be get by elm_diskselector_first_item_get().
25881 * @see elm_diskselector_item_append()
25882 * @see elm_diskselector_items_get()
25884 * @ingroup Diskselector
25886 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25889 * Get the item after @p item in diskselector.
25891 * @param it The diskselector item.
25892 * @return The item after @p item, or @c NULL if none or on failure.
25894 * The list of items follows append order. So it will return item appended
25895 * just after @p item and that wasn't deleted.
25897 * If it is the last item, @c NULL will be returned.
25898 * Last item can be get by elm_diskselector_last_item_get().
25900 * @see elm_diskselector_item_append()
25901 * @see elm_diskselector_items_get()
25903 * @ingroup Diskselector
25905 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25908 * Set the text to be shown in the diskselector item.
25910 * @param item Target item
25911 * @param text The text to set in the content
25913 * Setup the text as tooltip to object. The item can have only one tooltip,
25914 * so any previous tooltip data is removed.
25916 * @see elm_object_tooltip_text_set() for more details.
25918 * @ingroup Diskselector
25920 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
25923 * Set the content to be shown in the tooltip item.
25925 * Setup the tooltip to item. The item can have only one tooltip,
25926 * so any previous tooltip data is removed. @p func(with @p data) will
25927 * be called every time that need show the tooltip and it should
25928 * return a valid Evas_Object. This object is then managed fully by
25929 * tooltip system and is deleted when the tooltip is gone.
25931 * @param item the diskselector item being attached a tooltip.
25932 * @param func the function used to create the tooltip contents.
25933 * @param data what to provide to @a func as callback data/context.
25934 * @param del_cb called when data is not needed anymore, either when
25935 * another callback replaces @p func, the tooltip is unset with
25936 * elm_diskselector_item_tooltip_unset() or the owner @a item
25937 * dies. This callback receives as the first parameter the
25938 * given @a data, and @c event_info is the item.
25940 * @see elm_object_tooltip_content_cb_set() for more details.
25942 * @ingroup Diskselector
25944 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);
25947 * Unset tooltip from item.
25949 * @param item diskselector item to remove previously set tooltip.
25951 * Remove tooltip from item. The callback provided as del_cb to
25952 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
25953 * it is not used anymore.
25955 * @see elm_object_tooltip_unset() for more details.
25956 * @see elm_diskselector_item_tooltip_content_cb_set()
25958 * @ingroup Diskselector
25960 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25964 * Sets a different style for this item tooltip.
25966 * @note before you set a style you should define a tooltip with
25967 * elm_diskselector_item_tooltip_content_cb_set() or
25968 * elm_diskselector_item_tooltip_text_set()
25970 * @param item diskselector item with tooltip already set.
25971 * @param style the theme style to use (default, transparent, ...)
25973 * @see elm_object_tooltip_style_set() for more details.
25975 * @ingroup Diskselector
25977 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
25980 * Get the style for this item tooltip.
25982 * @param item diskselector item with tooltip already set.
25983 * @return style the theme style in use, defaults to "default". If the
25984 * object does not have a tooltip set, then NULL is returned.
25986 * @see elm_object_tooltip_style_get() for more details.
25987 * @see elm_diskselector_item_tooltip_style_set()
25989 * @ingroup Diskselector
25991 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25994 * Set the cursor to be shown when mouse is over the diskselector item
25996 * @param item Target item
25997 * @param cursor the cursor name to be used.
25999 * @see elm_object_cursor_set() for more details.
26001 * @ingroup Diskselector
26003 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
26006 * Get the cursor to be shown when mouse is over the diskselector item
26008 * @param item diskselector item with cursor already set.
26009 * @return the cursor name.
26011 * @see elm_object_cursor_get() for more details.
26012 * @see elm_diskselector_cursor_set()
26014 * @ingroup Diskselector
26016 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26020 * Unset the cursor to be shown when mouse is over the diskselector item
26022 * @param item Target item
26024 * @see elm_object_cursor_unset() for more details.
26025 * @see elm_diskselector_cursor_set()
26027 * @ingroup Diskselector
26029 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26032 * Sets a different style for this item cursor.
26034 * @note before you set a style you should define a cursor with
26035 * elm_diskselector_item_cursor_set()
26037 * @param item diskselector item with cursor already set.
26038 * @param style the theme style to use (default, transparent, ...)
26040 * @see elm_object_cursor_style_set() for more details.
26042 * @ingroup Diskselector
26044 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26048 * Get the style for this item cursor.
26050 * @param item diskselector item with cursor already set.
26051 * @return style the theme style in use, defaults to "default". If the
26052 * object does not have a cursor set, then @c NULL is returned.
26054 * @see elm_object_cursor_style_get() for more details.
26055 * @see elm_diskselector_item_cursor_style_set()
26057 * @ingroup Diskselector
26059 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26063 * Set if the cursor set should be searched on the theme or should use
26064 * the provided by the engine, only.
26066 * @note before you set if should look on theme you should define a cursor
26067 * with elm_diskselector_item_cursor_set().
26068 * By default it will only look for cursors provided by the engine.
26070 * @param item widget item with cursor already set.
26071 * @param engine_only boolean to define if cursors set with
26072 * elm_diskselector_item_cursor_set() should be searched only
26073 * between cursors provided by the engine or searched on widget's
26076 * @see elm_object_cursor_engine_only_set() for more details.
26078 * @ingroup Diskselector
26080 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
26083 * Get the cursor engine only usage for this item cursor.
26085 * @param item widget item with cursor already set.
26086 * @return engine_only boolean to define it cursors should be looked only
26087 * between the provided by the engine or searched on widget's theme as well.
26088 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
26090 * @see elm_object_cursor_engine_only_get() for more details.
26091 * @see elm_diskselector_item_cursor_engine_only_set()
26093 * @ingroup Diskselector
26095 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26102 * @page tutorial_colorselector Color selector example
26103 * @dontinclude colorselector_example_01.c
26105 * This example shows how to change the color of a rectangle using a color
26106 * selector. We aren't going to explain a lot of the code since it's the
26107 * usual setup code:
26108 * @until show(rect)
26110 * Now that we have a window with background and a rectangle we can create
26111 * our color_selector and set it's initial color to fully opaque blue:
26114 * Next we tell ask to be notified whenever the color changes:
26117 * We follow that we some more run of the mill setup code:
26118 * @until ELM_MAIN()
26120 * And now get to the callback that sets the color of the rectangle:
26123 * This example will look like this:
26124 * @image html screenshots/colorselector_example_01.png
26125 * @image latex screenshots/colorselector_example_01.eps
26127 * @example colorselector_example_01.c
26130 * @defgroup Colorselector Colorselector
26134 * @brief Widget for user to select a color.
26136 * Signals that you can add callbacks for are:
26137 * "changed" - When the color value changes(event_info is NULL).
26139 * See @ref tutorial_colorselector.
26142 * @brief Add a new colorselector to the parent
26144 * @param parent The parent object
26145 * @return The new object or NULL if it cannot be created
26147 * @ingroup Colorselector
26149 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26151 * Set a color for the colorselector
26153 * @param obj Colorselector object
26154 * @param r r-value of color
26155 * @param g g-value of color
26156 * @param b b-value of color
26157 * @param a a-value of color
26159 * @ingroup Colorselector
26161 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
26163 * Get a color from the colorselector
26165 * @param obj Colorselector object
26166 * @param r integer pointer for r-value of color
26167 * @param g integer pointer for g-value of color
26168 * @param b integer pointer for b-value of color
26169 * @param a integer pointer for a-value of color
26171 * @ingroup Colorselector
26173 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
26179 * @defgroup Ctxpopup Ctxpopup
26181 * @image html img/widget/ctxpopup/preview-00.png
26182 * @image latex img/widget/ctxpopup/preview-00.eps
26184 * @brief Context popup widet.
26186 * A ctxpopup is a widget that, when shown, pops up a list of items.
26187 * It automatically chooses an area inside its parent object's view
26188 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
26189 * optimally fit into it. In the default theme, it will also point an
26190 * arrow to it's top left position at the time one shows it. Ctxpopup
26191 * items have a label and/or an icon. It is intended for a small
26192 * number of items (hence the use of list, not genlist).
26194 * @note Ctxpopup is a especialization of @ref Hover.
26196 * Signals that you can add callbacks for are:
26197 * "dismissed" - the ctxpopup was dismissed
26199 * Default contents parts of the ctxpopup widget that you can use for are:
26200 * @li "elm.swallow.content" - A content of the ctxpopup
26202 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
26205 typedef enum _Elm_Ctxpopup_Direction
26207 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
26209 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
26210 the clicked area */
26211 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
26212 the clicked area */
26213 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
26215 ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
26216 } Elm_Ctxpopup_Direction;
26217 #define Elm_Ctxpopup_Item Elm_Object_Item
26220 * @brief Add a new Ctxpopup object to the parent.
26222 * @param parent Parent object
26223 * @return New object or @c NULL, if it cannot be created
26225 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26227 * @brief Set the Ctxpopup's parent
26229 * @param obj The ctxpopup object
26230 * @param area The parent to use
26232 * Set the parent object.
26234 * @note elm_ctxpopup_add() will automatically call this function
26235 * with its @c parent argument.
26237 * @see elm_ctxpopup_add()
26238 * @see elm_hover_parent_set()
26240 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
26242 * @brief Get the Ctxpopup's parent
26244 * @param obj The ctxpopup object
26246 * @see elm_ctxpopup_hover_parent_set() for more information
26248 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26250 * @brief Clear all items in the given ctxpopup object.
26252 * @param obj Ctxpopup object
26254 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26256 * @brief Change the ctxpopup's orientation to horizontal or vertical.
26258 * @param obj Ctxpopup object
26259 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
26261 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
26263 * @brief Get the value of current ctxpopup object's orientation.
26265 * @param obj Ctxpopup object
26266 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
26268 * @see elm_ctxpopup_horizontal_set()
26270 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26272 * @brief Add a new item to a ctxpopup object.
26274 * @param obj Ctxpopup object
26275 * @param icon Icon to be set on new item
26276 * @param label The Label of the new item
26277 * @param func Convenience function called when item selected
26278 * @param data Data passed to @p func
26279 * @return A handle to the item added or @c NULL, on errors
26281 * @warning Ctxpopup can't hold both an item list and a content at the same
26282 * time. When an item is added, any previous content will be removed.
26284 * @see elm_ctxpopup_content_set()
26286 Elm_Object_Item *elm_ctxpopup_item_append(Evas_Object *obj, const char *label, Evas_Object *icon, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
26288 * @brief Delete the given item in a ctxpopup object.
26290 * @param it Ctxpopup item to be deleted
26292 * @see elm_ctxpopup_item_append()
26294 EAPI void elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26296 * @brief Set the ctxpopup item's state as disabled or enabled.
26298 * @param it Ctxpopup item to be enabled/disabled
26299 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
26301 * When disabled the item is greyed out to indicate it's state.
26303 EAPI void elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
26305 * @brief Get the ctxpopup item's disabled/enabled state.
26307 * @param it Ctxpopup item to be enabled/disabled
26308 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
26310 * @see elm_ctxpopup_item_disabled_set()
26312 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26314 * @brief Get the icon object for the given ctxpopup item.
26316 * @param it Ctxpopup item
26317 * @return icon object or @c NULL, if the item does not have icon or an error
26320 * @see elm_ctxpopup_item_append()
26321 * @see elm_ctxpopup_item_icon_set()
26323 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26325 * @brief Sets the side icon associated with the ctxpopup item
26327 * @param it Ctxpopup item
26328 * @param icon Icon object to be set
26330 * Once the icon object is set, a previously set one will be deleted.
26331 * @warning Setting the same icon for two items will cause the icon to
26332 * dissapear from the first item.
26334 * @see elm_ctxpopup_item_append()
26336 EAPI void elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26338 * @brief Get the label for the given ctxpopup item.
26340 * @param it Ctxpopup item
26341 * @return label string or @c NULL, if the item does not have label or an
26344 * @see elm_ctxpopup_item_append()
26345 * @see elm_ctxpopup_item_label_set()
26347 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26349 * @brief (Re)set the label on the given ctxpopup item.
26351 * @param it Ctxpopup item
26352 * @param label String to set as label
26354 EAPI void elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26356 * @brief Set an elm widget as the content of the ctxpopup.
26358 * @param obj Ctxpopup object
26359 * @param content Content to be swallowed
26361 * If the content object is already set, a previous one will bedeleted. If
26362 * you want to keep that old content object, use the
26363 * elm_ctxpopup_content_unset() function.
26365 * @deprecated use elm_object_content_set()
26367 * @warning Ctxpopup can't hold both a item list and a content at the same
26368 * time. When a content is set, any previous items will be removed.
26370 EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
26372 * @brief Unset the ctxpopup content
26374 * @param obj Ctxpopup object
26375 * @return The content that was being used
26377 * Unparent and return the content object which was set for this widget.
26379 * @deprecated use elm_object_content_unset()
26381 * @see elm_ctxpopup_content_set()
26383 EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
26385 * @brief Set the direction priority of a ctxpopup.
26387 * @param obj Ctxpopup object
26388 * @param first 1st priority of direction
26389 * @param second 2nd priority of direction
26390 * @param third 3th priority of direction
26391 * @param fourth 4th priority of direction
26393 * This functions gives a chance to user to set the priority of ctxpopup
26394 * showing direction. This doesn't guarantee the ctxpopup will appear in the
26395 * requested direction.
26397 * @see Elm_Ctxpopup_Direction
26399 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);
26401 * @brief Get the direction priority of a ctxpopup.
26403 * @param obj Ctxpopup object
26404 * @param first 1st priority of direction to be returned
26405 * @param second 2nd priority of direction to be returned
26406 * @param third 3th priority of direction to be returned
26407 * @param fourth 4th priority of direction to be returned
26409 * @see elm_ctxpopup_direction_priority_set() for more information.
26411 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);
26414 * @brief Get the current direction of a ctxpopup.
26416 * @param obj Ctxpopup object
26417 * @return current direction of a ctxpopup
26419 * @warning Once the ctxpopup showed up, the direction would be determined
26421 EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26430 * @defgroup Transit Transit
26431 * @ingroup Elementary
26433 * Transit is designed to apply various animated transition effects to @c
26434 * Evas_Object, such like translation, rotation, etc. For using these
26435 * effects, create an @ref Elm_Transit and add the desired transition effects.
26437 * Once the effects are added into transit, they will be automatically
26438 * managed (their callback will be called until the duration is ended, and
26439 * they will be deleted on completion).
26443 * Elm_Transit *trans = elm_transit_add();
26444 * elm_transit_object_add(trans, obj);
26445 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
26446 * elm_transit_duration_set(transit, 1);
26447 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
26448 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
26449 * elm_transit_repeat_times_set(transit, 3);
26452 * Some transition effects are used to change the properties of objects. They
26454 * @li @ref elm_transit_effect_translation_add
26455 * @li @ref elm_transit_effect_color_add
26456 * @li @ref elm_transit_effect_rotation_add
26457 * @li @ref elm_transit_effect_wipe_add
26458 * @li @ref elm_transit_effect_zoom_add
26459 * @li @ref elm_transit_effect_resizing_add
26461 * Other transition effects are used to make one object disappear and another
26462 * object appear on its old place. These effects are:
26464 * @li @ref elm_transit_effect_flip_add
26465 * @li @ref elm_transit_effect_resizable_flip_add
26466 * @li @ref elm_transit_effect_fade_add
26467 * @li @ref elm_transit_effect_blend_add
26469 * It's also possible to make a transition chain with @ref
26470 * elm_transit_chain_transit_add.
26472 * @warning We strongly recommend to use elm_transit just when edje can not do
26473 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
26474 * animations can be manipulated inside the theme.
26476 * List of examples:
26477 * @li @ref transit_example_01_explained
26478 * @li @ref transit_example_02_explained
26479 * @li @ref transit_example_03_c
26480 * @li @ref transit_example_04_c
26486 * @enum Elm_Transit_Tween_Mode
26488 * The type of acceleration used in the transition.
26492 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
26493 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
26494 over time, then decrease again
26496 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
26498 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
26500 } Elm_Transit_Tween_Mode;
26503 * @enum Elm_Transit_Effect_Flip_Axis
26505 * The axis where flip effect should be applied.
26509 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
26510 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
26511 } Elm_Transit_Effect_Flip_Axis;
26513 * @enum Elm_Transit_Effect_Wipe_Dir
26515 * The direction where the wipe effect should occur.
26519 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
26520 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
26521 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
26522 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
26523 } Elm_Transit_Effect_Wipe_Dir;
26524 /** @enum Elm_Transit_Effect_Wipe_Type
26526 * Whether the wipe effect should show or hide the object.
26530 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
26532 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
26534 } Elm_Transit_Effect_Wipe_Type;
26537 * @typedef Elm_Transit
26539 * The Transit created with elm_transit_add(). This type has the information
26540 * about the objects which the transition will be applied, and the
26541 * transition effects that will be used. It also contains info about
26542 * duration, number of repetitions, auto-reverse, etc.
26544 typedef struct _Elm_Transit Elm_Transit;
26545 typedef void Elm_Transit_Effect;
26547 * @typedef Elm_Transit_Effect_Transition_Cb
26549 * Transition callback called for this effect on each transition iteration.
26551 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
26553 * Elm_Transit_Effect_End_Cb
26555 * Transition callback called for this effect when the transition is over.
26557 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
26560 * Elm_Transit_Del_Cb
26562 * A callback called when the transit is deleted.
26564 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
26569 * @note Is not necessary to delete the transit object, it will be deleted at
26570 * the end of its operation.
26571 * @note The transit will start playing when the program enter in the main loop, is not
26572 * necessary to give a start to the transit.
26574 * @return The transit object.
26578 EAPI Elm_Transit *elm_transit_add(void);
26581 * Stops the animation and delete the @p transit object.
26583 * Call this function if you wants to stop the animation before the duration
26584 * time. Make sure the @p transit object is still alive with
26585 * elm_transit_del_cb_set() function.
26586 * All added effects will be deleted, calling its repective data_free_cb
26587 * functions. The function setted by elm_transit_del_cb_set() will be called.
26589 * @see elm_transit_del_cb_set()
26591 * @param transit The transit object to be deleted.
26594 * @warning Just call this function if you are sure the transit is alive.
26596 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
26599 * Add a new effect to the transit.
26601 * @note The cb function and the data are the key to the effect. If you try to
26602 * add an already added effect, nothing is done.
26603 * @note After the first addition of an effect in @p transit, if its
26604 * effect list become empty again, the @p transit will be killed by
26605 * elm_transit_del(transit) function.
26609 * Elm_Transit *transit = elm_transit_add();
26610 * elm_transit_effect_add(transit,
26611 * elm_transit_effect_blend_op,
26612 * elm_transit_effect_blend_context_new(),
26613 * elm_transit_effect_blend_context_free);
26616 * @param transit The transit object.
26617 * @param transition_cb The operation function. It is called when the
26618 * animation begins, it is the function that actually performs the animation.
26619 * It is called with the @p data, @p transit and the time progression of the
26620 * animation (a double value between 0.0 and 1.0).
26621 * @param effect The context data of the effect.
26622 * @param end_cb The function to free the context data, it will be called
26623 * at the end of the effect, it must finalize the animation and free the
26627 * @warning The transit free the context data at the and of the transition with
26628 * the data_free_cb function, do not use the context data in another transit.
26630 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);
26633 * Delete an added effect.
26635 * This function will remove the effect from the @p transit, calling the
26636 * data_free_cb to free the @p data.
26638 * @see elm_transit_effect_add()
26640 * @note If the effect is not found, nothing is done.
26641 * @note If the effect list become empty, this function will call
26642 * elm_transit_del(transit), that is, it will kill the @p transit.
26644 * @param transit The transit object.
26645 * @param transition_cb The operation function.
26646 * @param effect The context data of the effect.
26650 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);
26653 * Add new object to apply the effects.
26655 * @note After the first addition of an object in @p transit, if its
26656 * object list become empty again, the @p transit will be killed by
26657 * elm_transit_del(transit) function.
26658 * @note If the @p obj belongs to another transit, the @p obj will be
26659 * removed from it and it will only belong to the @p transit. If the old
26660 * transit stays without objects, it will die.
26661 * @note When you add an object into the @p transit, its state from
26662 * evas_object_pass_events_get(obj) is saved, and it is applied when the
26663 * transit ends, if you change this state whith evas_object_pass_events_set()
26664 * after add the object, this state will change again when @p transit stops to
26667 * @param transit The transit object.
26668 * @param obj Object to be animated.
26671 * @warning It is not allowed to add a new object after transit begins to go.
26673 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
26676 * Removes an added object from the transit.
26678 * @note If the @p obj is not in the @p transit, nothing is done.
26679 * @note If the list become empty, this function will call
26680 * elm_transit_del(transit), that is, it will kill the @p transit.
26682 * @param transit The transit object.
26683 * @param obj Object to be removed from @p transit.
26686 * @warning It is not allowed to remove objects after transit begins to go.
26688 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
26691 * Get the objects of the transit.
26693 * @param transit The transit object.
26694 * @return a Eina_List with the objects from the transit.
26698 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26701 * Enable/disable keeping up the objects states.
26702 * If it is not kept, the objects states will be reset when transition ends.
26704 * @note @p transit can not be NULL.
26705 * @note One state includes geometry, color, map data.
26707 * @param transit The transit object.
26708 * @param state_keep Keeping or Non Keeping.
26712 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
26715 * Get a value whether the objects states will be reset or not.
26717 * @note @p transit can not be NULL
26719 * @see elm_transit_objects_final_state_keep_set()
26721 * @param transit The transit object.
26722 * @return EINA_TRUE means the states of the objects will be reset.
26723 * If @p transit is NULL, EINA_FALSE is returned
26727 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26730 * Set the event enabled when transit is operating.
26732 * If @p enabled is EINA_TRUE, the objects of the transit will receives
26733 * events from mouse and keyboard during the animation.
26734 * @note When you add an object with elm_transit_object_add(), its state from
26735 * evas_object_pass_events_get(obj) is saved, and it is applied when the
26736 * transit ends, if you change this state with evas_object_pass_events_set()
26737 * after adding the object, this state will change again when @p transit stops
26740 * @param transit The transit object.
26741 * @param enabled Events are received when enabled is @c EINA_TRUE, and
26742 * ignored otherwise.
26746 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
26749 * Get the value of event enabled status.
26751 * @see elm_transit_event_enabled_set()
26753 * @param transit The Transit object
26754 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
26755 * EINA_FALSE is returned
26759 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26762 * Set the user-callback function when the transit is deleted.
26764 * @note Using this function twice will overwrite the first function setted.
26765 * @note the @p transit object will be deleted after call @p cb function.
26767 * @param transit The transit object.
26768 * @param cb Callback function pointer. This function will be called before
26769 * the deletion of the transit.
26770 * @param data Callback funtion user data. It is the @p op parameter.
26774 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
26777 * Set reverse effect automatically.
26779 * If auto reverse is setted, after running the effects with the progress
26780 * parameter from 0 to 1, it will call the effecs again with the progress
26781 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
26782 * where the duration was setted with the function elm_transit_add and
26783 * the repeat with the function elm_transit_repeat_times_set().
26785 * @param transit The transit object.
26786 * @param reverse EINA_TRUE means the auto_reverse is on.
26790 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
26793 * Get if the auto reverse is on.
26795 * @see elm_transit_auto_reverse_set()
26797 * @param transit The transit object.
26798 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
26799 * EINA_FALSE is returned
26803 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26806 * Set the transit repeat count. Effect will be repeated by repeat count.
26808 * This function sets the number of repetition the transit will run after
26809 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
26810 * If the @p repeat is a negative number, it will repeat infinite times.
26812 * @note If this function is called during the transit execution, the transit
26813 * will run @p repeat times, ignoring the times it already performed.
26815 * @param transit The transit object
26816 * @param repeat Repeat count
26820 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
26823 * Get the transit repeat count.
26825 * @see elm_transit_repeat_times_set()
26827 * @param transit The Transit object.
26828 * @return The repeat count. If @p transit is NULL
26833 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26836 * Set the transit animation acceleration type.
26838 * This function sets the tween mode of the transit that can be:
26839 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
26840 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
26841 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
26842 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
26844 * @param transit The transit object.
26845 * @param tween_mode The tween type.
26849 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
26852 * Get the transit animation acceleration type.
26854 * @note @p transit can not be NULL
26856 * @param transit The transit object.
26857 * @return The tween type. If @p transit is NULL
26858 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
26862 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26865 * Set the transit animation time
26867 * @note @p transit can not be NULL
26869 * @param transit The transit object.
26870 * @param duration The animation time.
26874 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
26877 * Get the transit animation time
26879 * @note @p transit can not be NULL
26881 * @param transit The transit object.
26883 * @return The transit animation time.
26887 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26890 * Starts the transition.
26891 * Once this API is called, the transit begins to measure the time.
26893 * @note @p transit can not be NULL
26895 * @param transit The transit object.
26899 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
26902 * Pause/Resume the transition.
26904 * If you call elm_transit_go again, the transit will be started from the
26905 * beginning, and will be unpaused.
26907 * @note @p transit can not be NULL
26909 * @param transit The transit object.
26910 * @param paused Whether the transition should be paused or not.
26914 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
26917 * Get the value of paused status.
26919 * @see elm_transit_paused_set()
26921 * @note @p transit can not be NULL
26923 * @param transit The transit object.
26924 * @return EINA_TRUE means transition is paused. If @p transit is NULL
26925 * EINA_FALSE is returned
26929 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26932 * Get the time progression of the animation (a double value between 0.0 and 1.0).
26934 * The value returned is a fraction (current time / total time). It
26935 * represents the progression position relative to the total.
26937 * @note @p transit can not be NULL
26939 * @param transit The transit object.
26941 * @return The time progression value. If @p transit is NULL
26946 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26949 * Makes the chain relationship between two transits.
26951 * @note @p transit can not be NULL. Transit would have multiple chain transits.
26952 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
26954 * @param transit The transit object.
26955 * @param chain_transit The chain transit object. This transit will be operated
26956 * after transit is done.
26958 * This function adds @p chain_transit transition to a chain after the @p
26959 * transit, and will be started as soon as @p transit ends. See @ref
26960 * transit_example_02_explained for a full example.
26964 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
26967 * Cut off the chain relationship between two transits.
26969 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
26970 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
26972 * @param transit The transit object.
26973 * @param chain_transit The chain transit object.
26975 * This function remove the @p chain_transit transition from the @p transit.
26979 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
26982 * Get the current chain transit list.
26984 * @note @p transit can not be NULL.
26986 * @param transit The transit object.
26987 * @return chain transit list.
26991 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
26994 * Add the Resizing Effect to Elm_Transit.
26996 * @note This API is one of the facades. It creates resizing effect context
26997 * and add it's required APIs to elm_transit_effect_add.
26999 * @see elm_transit_effect_add()
27001 * @param transit Transit object.
27002 * @param from_w Object width size when effect begins.
27003 * @param from_h Object height size when effect begins.
27004 * @param to_w Object width size when effect ends.
27005 * @param to_h Object height size when effect ends.
27006 * @return Resizing effect context data.
27010 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);
27013 * Add the Translation Effect to Elm_Transit.
27015 * @note This API is one of the facades. It creates translation effect context
27016 * and add it's required APIs to elm_transit_effect_add.
27018 * @see elm_transit_effect_add()
27020 * @param transit Transit object.
27021 * @param from_dx X Position variation when effect begins.
27022 * @param from_dy Y Position variation when effect begins.
27023 * @param to_dx X Position variation when effect ends.
27024 * @param to_dy Y Position variation when effect ends.
27025 * @return Translation effect context data.
27028 * @warning It is highly recommended just create a transit with this effect when
27029 * the window that the objects of the transit belongs has already been created.
27030 * This is because this effect needs the geometry information about the objects,
27031 * and if the window was not created yet, it can get a wrong information.
27033 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);
27036 * Add the Zoom Effect to Elm_Transit.
27038 * @note This API is one of the facades. It creates zoom effect context
27039 * and add it's required APIs to elm_transit_effect_add.
27041 * @see elm_transit_effect_add()
27043 * @param transit Transit object.
27044 * @param from_rate Scale rate when effect begins (1 is current rate).
27045 * @param to_rate Scale rate when effect ends.
27046 * @return Zoom effect context data.
27049 * @warning It is highly recommended just create a transit with this effect when
27050 * the window that the objects of the transit belongs has already been created.
27051 * This is because this effect needs the geometry information about the objects,
27052 * and if the window was not created yet, it can get a wrong information.
27054 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
27057 * Add the Flip Effect to Elm_Transit.
27059 * @note This API is one of the facades. It creates flip effect context
27060 * and add it's required APIs to elm_transit_effect_add.
27061 * @note This effect is applied to each pair of objects in the order they are listed
27062 * in the transit list of objects. The first object in the pair will be the
27063 * "front" object and the second will be the "back" object.
27065 * @see elm_transit_effect_add()
27067 * @param transit Transit object.
27068 * @param axis Flipping Axis(X or Y).
27069 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27070 * @return Flip effect context data.
27073 * @warning It is highly recommended just create a transit with this effect when
27074 * the window that the objects of the transit belongs has already been created.
27075 * This is because this effect needs the geometry information about the objects,
27076 * and if the window was not created yet, it can get a wrong information.
27078 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27081 * Add the Resizable Flip Effect to Elm_Transit.
27083 * @note This API is one of the facades. It creates resizable flip effect context
27084 * and add it's required APIs to elm_transit_effect_add.
27085 * @note This effect is applied to each pair of objects in the order they are listed
27086 * in the transit list of objects. The first object in the pair will be the
27087 * "front" object and the second will be the "back" object.
27089 * @see elm_transit_effect_add()
27091 * @param transit Transit object.
27092 * @param axis Flipping Axis(X or Y).
27093 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27094 * @return Resizable flip effect context data.
27097 * @warning It is highly recommended just create a transit with this effect when
27098 * the window that the objects of the transit belongs has already been created.
27099 * This is because this effect needs the geometry information about the objects,
27100 * and if the window was not created yet, it can get a wrong information.
27102 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27105 * Add the Wipe Effect to Elm_Transit.
27107 * @note This API is one of the facades. It creates wipe effect context
27108 * and add it's required APIs to elm_transit_effect_add.
27110 * @see elm_transit_effect_add()
27112 * @param transit Transit object.
27113 * @param type Wipe type. Hide or show.
27114 * @param dir Wipe Direction.
27115 * @return Wipe effect context data.
27118 * @warning It is highly recommended just create a transit with this effect when
27119 * the window that the objects of the transit belongs has already been created.
27120 * This is because this effect needs the geometry information about the objects,
27121 * and if the window was not created yet, it can get a wrong information.
27123 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
27126 * Add the Color Effect to Elm_Transit.
27128 * @note This API is one of the facades. It creates color effect context
27129 * and add it's required APIs to elm_transit_effect_add.
27131 * @see elm_transit_effect_add()
27133 * @param transit Transit object.
27134 * @param from_r RGB R when effect begins.
27135 * @param from_g RGB G when effect begins.
27136 * @param from_b RGB B when effect begins.
27137 * @param from_a RGB A when effect begins.
27138 * @param to_r RGB R when effect ends.
27139 * @param to_g RGB G when effect ends.
27140 * @param to_b RGB B when effect ends.
27141 * @param to_a RGB A when effect ends.
27142 * @return Color effect context data.
27146 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);
27149 * Add the Fade Effect to Elm_Transit.
27151 * @note This API is one of the facades. It creates fade effect context
27152 * and add it's required APIs to elm_transit_effect_add.
27153 * @note This effect is applied to each pair of objects in the order they are listed
27154 * in the transit list of objects. The first object in the pair will be the
27155 * "before" object and the second will be the "after" object.
27157 * @see elm_transit_effect_add()
27159 * @param transit Transit object.
27160 * @return Fade effect context data.
27163 * @warning It is highly recommended just create a transit with this effect when
27164 * the window that the objects of the transit belongs has already been created.
27165 * This is because this effect needs the color information about the objects,
27166 * and if the window was not created yet, it can get a wrong information.
27168 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
27171 * Add the Blend Effect to Elm_Transit.
27173 * @note This API is one of the facades. It creates blend effect context
27174 * and add it's required APIs to elm_transit_effect_add.
27175 * @note This effect is applied to each pair of objects in the order they are listed
27176 * in the transit list of objects. The first object in the pair will be the
27177 * "before" object and the second will be the "after" object.
27179 * @see elm_transit_effect_add()
27181 * @param transit Transit object.
27182 * @return Blend effect context data.
27185 * @warning It is highly recommended just create a transit with this effect when
27186 * the window that the objects of the transit belongs has already been created.
27187 * This is because this effect needs the color information about the objects,
27188 * and if the window was not created yet, it can get a wrong information.
27190 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
27193 * Add the Rotation Effect to Elm_Transit.
27195 * @note This API is one of the facades. It creates rotation effect context
27196 * and add it's required APIs to elm_transit_effect_add.
27198 * @see elm_transit_effect_add()
27200 * @param transit Transit object.
27201 * @param from_degree Degree when effect begins.
27202 * @param to_degree Degree when effect is ends.
27203 * @return Rotation effect context data.
27206 * @warning It is highly recommended just create a transit with this effect when
27207 * the window that the objects of the transit belongs has already been created.
27208 * This is because this effect needs the geometry information about the objects,
27209 * and if the window was not created yet, it can get a wrong information.
27211 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
27214 * Add the ImageAnimation Effect to Elm_Transit.
27216 * @note This API is one of the facades. It creates image animation effect context
27217 * and add it's required APIs to elm_transit_effect_add.
27218 * The @p images parameter is a list images paths. This list and
27219 * its contents will be deleted at the end of the effect by
27220 * elm_transit_effect_image_animation_context_free() function.
27224 * char buf[PATH_MAX];
27225 * Eina_List *images = NULL;
27226 * Elm_Transit *transi = elm_transit_add();
27228 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
27229 * images = eina_list_append(images, eina_stringshare_add(buf));
27231 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
27232 * images = eina_list_append(images, eina_stringshare_add(buf));
27233 * elm_transit_effect_image_animation_add(transi, images);
27237 * @see elm_transit_effect_add()
27239 * @param transit Transit object.
27240 * @param images Eina_List of images file paths. This list and
27241 * its contents will be deleted at the end of the effect by
27242 * elm_transit_effect_image_animation_context_free() function.
27243 * @return Image Animation effect context data.
27247 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
27253 typedef struct _Elm_Store Elm_Store;
27254 typedef struct _Elm_Store_DBsystem Elm_Store_DBsystem;
27255 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
27256 typedef struct _Elm_Store_Item Elm_Store_Item;
27257 typedef struct _Elm_Store_Item_DBsystem Elm_Store_Item_DBsystem;
27258 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
27259 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
27260 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
27261 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
27262 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
27263 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
27264 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
27265 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
27267 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
27268 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
27269 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
27270 typedef void (*Elm_Store_Item_Select_Cb) (void *data, Elm_Store_Item *sti);
27271 typedef int (*Elm_Store_Item_Sort_Cb) (void *data, Elm_Store_Item_Info *info1, Elm_Store_Item_Info *info2);
27272 typedef void (*Elm_Store_Item_Free_Cb) (void *data, Elm_Store_Item_Info *info);
27273 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
27277 ELM_STORE_ITEM_MAPPING_NONE = 0,
27278 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
27279 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
27280 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
27281 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
27282 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
27283 // can add more here as needed by common apps
27284 ELM_STORE_ITEM_MAPPING_LAST
27285 } Elm_Store_Item_Mapping_Type;
27287 struct _Elm_Store_Item_Mapping_Icon
27289 // FIXME: allow edje file icons
27291 Elm_Icon_Lookup_Order lookup_order;
27292 Eina_Bool standard_name : 1;
27293 Eina_Bool no_scale : 1;
27294 Eina_Bool smooth : 1;
27295 Eina_Bool scale_up : 1;
27296 Eina_Bool scale_down : 1;
27299 struct _Elm_Store_Item_Mapping_Empty
27304 struct _Elm_Store_Item_Mapping_Photo
27309 struct _Elm_Store_Item_Mapping_Custom
27311 Elm_Store_Item_Mapping_Cb func;
27314 struct _Elm_Store_Item_Mapping
27316 Elm_Store_Item_Mapping_Type type;
27321 Elm_Store_Item_Mapping_Empty empty;
27322 Elm_Store_Item_Mapping_Icon icon;
27323 Elm_Store_Item_Mapping_Photo photo;
27324 Elm_Store_Item_Mapping_Custom custom;
27325 // add more types here
27329 struct _Elm_Store_Item_Info
27334 Eina_Bool rec_item;
27335 int pre_group_index;
27337 Elm_Genlist_Item_Class *item_class;
27338 const Elm_Store_Item_Mapping *mapping;
27343 struct _Elm_Store_Item_Info_Filesystem
27345 Elm_Store_Item_Info base;
27349 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
27350 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
27352 EAPI Elm_Store *elm_store_dbsystem_new(void);
27353 EAPI void elm_store_item_count_set(Elm_Store *st, int count) EINA_ARG_NONNULL(1);
27354 EAPI void elm_store_item_select_func_set(Elm_Store *st, Elm_Store_Item_Select_Cb func, const void *data) EINA_ARG_NONNULL(1);
27355 EAPI void elm_store_item_sort_func_set(Elm_Store *st, Elm_Store_Item_Sort_Cb func, const void *data) EINA_ARG_NONNULL(1);
27356 EAPI void elm_store_item_free_func_set(Elm_Store *st, Elm_Store_Item_Free_Cb func, const void *data) EINA_ARG_NONNULL(1);
27357 EAPI int elm_store_item_data_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27358 EAPI void *elm_store_dbsystem_db_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27359 EAPI void elm_store_dbsystem_db_set(Elm_Store *store, void *pDB) EINA_ARG_NONNULL(1);
27360 EAPI int elm_store_item_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27361 EAPI Elm_Store_Item *elm_store_item_add(Elm_Store *st, Elm_Store_Item_Info *info) EINA_ARG_NONNULL(1);
27362 EAPI void elm_store_item_update(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27363 EAPI void elm_store_visible_items_update(Elm_Store *st) EINA_ARG_NONNULL(1);
27364 EAPI void elm_store_item_del(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27365 EAPI void elm_store_free(Elm_Store *st);
27366 EAPI Elm_Store *elm_store_filesystem_new(void);
27367 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
27368 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27369 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27370 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
27371 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
27372 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27373 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27374 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27375 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
27376 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27377 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27378 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
27379 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27380 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
27381 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27382 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27383 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27386 * @defgroup SegmentControl SegmentControl
27387 * @ingroup Elementary
27389 * @image html img/widget/segment_control/preview-00.png
27390 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
27392 * @image html img/segment_control.png
27393 * @image latex img/segment_control.eps width=\textwidth
27395 * Segment control widget is a horizontal control made of multiple segment
27396 * items, each segment item functioning similar to discrete two state button.
27397 * A segment control groups the items together and provides compact
27398 * single button with multiple equal size segments.
27400 * Segment item size is determined by base widget
27401 * size and the number of items added.
27402 * Only one segment item can be at selected state. A segment item can display
27403 * combination of Text and any Evas_Object like Images or other widget.
27405 * Smart callbacks one can listen to:
27406 * - "changed" - When the user clicks on a segment item which is not
27407 * previously selected and get selected. The event_info parameter is the
27408 * segment item pointer.
27410 * Available styles for it:
27413 * Here is an example on its usage:
27414 * @li @ref segment_control_example
27418 * @addtogroup SegmentControl
27422 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
27425 * Add a new segment control widget to the given parent Elementary
27426 * (container) object.
27428 * @param parent The parent object.
27429 * @return a new segment control widget handle or @c NULL, on errors.
27431 * This function inserts a new segment control widget on the canvas.
27433 * @ingroup SegmentControl
27435 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27438 * Append a new item to the segment control object.
27440 * @param obj The segment control object.
27441 * @param icon The icon object to use for the left side of the item. An
27442 * icon can be any Evas object, but usually it is an icon created
27443 * with elm_icon_add().
27444 * @param label The label of the item.
27445 * Note that, NULL is different from empty string "".
27446 * @return The created item or @c NULL upon failure.
27448 * A new item will be created and appended to the segment control, i.e., will
27449 * be set as @b last item.
27451 * If it should be inserted at another position,
27452 * elm_segment_control_item_insert_at() should be used instead.
27454 * Items created with this function can be deleted with function
27455 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27457 * @note @p label set to @c NULL is different from empty string "".
27459 * only has icon, it will be displayed bigger and centered. If it has
27460 * icon and label, even that an empty string, icon will be smaller and
27461 * positioned at left.
27465 * sc = elm_segment_control_add(win);
27466 * ic = elm_icon_add(win);
27467 * elm_icon_file_set(ic, "path/to/image", NULL);
27468 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
27469 * elm_segment_control_item_add(sc, ic, "label");
27470 * evas_object_show(sc);
27473 * @see elm_segment_control_item_insert_at()
27474 * @see elm_segment_control_item_del()
27476 * @ingroup SegmentControl
27478 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
27481 * Insert a new item to the segment control object at specified position.
27483 * @param obj The segment control object.
27484 * @param icon The icon object to use for the left side of the item. An
27485 * icon can be any Evas object, but usually it is an icon created
27486 * with elm_icon_add().
27487 * @param label The label of the item.
27488 * @param index Item position. Value should be between 0 and items count.
27489 * @return The created item or @c NULL upon failure.
27491 * Index values must be between @c 0, when item will be prepended to
27492 * segment control, and items count, that can be get with
27493 * elm_segment_control_item_count_get(), case when item will be appended
27494 * to segment control, just like elm_segment_control_item_add().
27496 * Items created with this function can be deleted with function
27497 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27499 * @note @p label set to @c NULL is different from empty string "".
27501 * only has icon, it will be displayed bigger and centered. If it has
27502 * icon and label, even that an empty string, icon will be smaller and
27503 * positioned at left.
27505 * @see elm_segment_control_item_add()
27506 * @see elm_segment_control_item_count_get()
27507 * @see elm_segment_control_item_del()
27509 * @ingroup SegmentControl
27511 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);
27514 * Remove a segment control item from its parent, deleting it.
27516 * @param it The item to be removed.
27518 * Items can be added with elm_segment_control_item_add() or
27519 * elm_segment_control_item_insert_at().
27521 * @ingroup SegmentControl
27523 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27526 * Remove a segment control item at given index from its parent,
27529 * @param obj The segment control object.
27530 * @param index The position of the segment control item to be deleted.
27532 * Items can be added with elm_segment_control_item_add() or
27533 * elm_segment_control_item_insert_at().
27535 * @ingroup SegmentControl
27537 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27540 * Get the Segment items count from segment control.
27542 * @param obj The segment control object.
27543 * @return Segment items count.
27545 * It will just return the number of items added to segment control @p obj.
27547 * @ingroup SegmentControl
27549 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27552 * Get the item placed at specified index.
27554 * @param obj The segment control object.
27555 * @param index The index of the segment item.
27556 * @return The segment control item or @c NULL on failure.
27558 * Index is the position of an item in segment control widget. Its
27559 * range is from @c 0 to <tt> count - 1 </tt>.
27560 * Count is the number of items, that can be get with
27561 * elm_segment_control_item_count_get().
27563 * @ingroup SegmentControl
27565 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27568 * Get the label of item.
27570 * @param obj The segment control object.
27571 * @param index The index of the segment item.
27572 * @return The label of the item at @p index.
27574 * The return value is a pointer to the label associated to the item when
27575 * it was created, with function elm_segment_control_item_add(), or later
27576 * with function elm_segment_control_item_label_set. If no label
27577 * was passed as argument, it will return @c NULL.
27579 * @see elm_segment_control_item_label_set() for more details.
27580 * @see elm_segment_control_item_add()
27582 * @ingroup SegmentControl
27584 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27587 * Set the label of item.
27589 * @param it The item of segment control.
27590 * @param text The label of item.
27592 * The label to be displayed by the item.
27593 * Label will be at right of the icon (if set).
27595 * If a label was passed as argument on item creation, with function
27596 * elm_control_segment_item_add(), it will be already
27597 * displayed by the item.
27599 * @see elm_segment_control_item_label_get()
27600 * @see elm_segment_control_item_add()
27602 * @ingroup SegmentControl
27604 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
27607 * Get the icon associated to the item.
27609 * @param obj The segment control object.
27610 * @param index The index of the segment item.
27611 * @return The left side icon associated to the item at @p index.
27613 * The return value is a pointer to the icon associated to the item when
27614 * it was created, with function elm_segment_control_item_add(), or later
27615 * with function elm_segment_control_item_icon_set(). If no icon
27616 * was passed as argument, it will return @c NULL.
27618 * @see elm_segment_control_item_add()
27619 * @see elm_segment_control_item_icon_set()
27621 * @ingroup SegmentControl
27623 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27626 * Set the icon associated to the item.
27628 * @param it The segment control item.
27629 * @param icon The icon object to associate with @p it.
27631 * The icon object to use at left side of the item. An
27632 * icon can be any Evas object, but usually it is an icon created
27633 * with elm_icon_add().
27635 * Once the icon object is set, a previously set one will be deleted.
27636 * @warning Setting the same icon for two items will cause the icon to
27637 * dissapear from the first item.
27639 * If an icon was passed as argument on item creation, with function
27640 * elm_segment_control_item_add(), it will be already
27641 * associated to the item.
27643 * @see elm_segment_control_item_add()
27644 * @see elm_segment_control_item_icon_get()
27646 * @ingroup SegmentControl
27648 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
27651 * Get the index of an item.
27653 * @param it The segment control item.
27654 * @return The position of item in segment control widget.
27656 * Index is the position of an item in segment control widget. Its
27657 * range is from @c 0 to <tt> count - 1 </tt>.
27658 * Count is the number of items, that can be get with
27659 * elm_segment_control_item_count_get().
27661 * @ingroup SegmentControl
27663 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27666 * Get the base object of the item.
27668 * @param it The segment control item.
27669 * @return The base object associated with @p it.
27671 * Base object is the @c Evas_Object that represents that item.
27673 * @ingroup SegmentControl
27675 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27678 * Get the selected item.
27680 * @param obj The segment control object.
27681 * @return The selected item or @c NULL if none of segment items is
27684 * The selected item can be unselected with function
27685 * elm_segment_control_item_selected_set().
27687 * The selected item always will be highlighted on segment control.
27689 * @ingroup SegmentControl
27691 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27694 * Set the selected state of an item.
27696 * @param it The segment control item
27697 * @param select The selected state
27699 * This sets the selected state of the given item @p it.
27700 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
27702 * If a new item is selected the previosly selected will be unselected.
27703 * Previoulsy selected item can be get with function
27704 * elm_segment_control_item_selected_get().
27706 * The selected item always will be highlighted on segment control.
27708 * @see elm_segment_control_item_selected_get()
27710 * @ingroup SegmentControl
27712 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
27719 * @defgroup Grid Grid
27721 * The grid is a grid layout widget that lays out a series of children as a
27722 * fixed "grid" of widgets using a given percentage of the grid width and
27723 * height each using the child object.
27725 * The Grid uses a "Virtual resolution" that is stretched to fill the grid
27726 * widgets size itself. The default is 100 x 100, so that means the
27727 * position and sizes of children will effectively be percentages (0 to 100)
27728 * of the width or height of the grid widget
27734 * Add a new grid to the parent
27736 * @param parent The parent object
27737 * @return The new object or NULL if it cannot be created
27741 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
27744 * Set the virtual size of the grid
27746 * @param obj The grid object
27747 * @param w The virtual width of the grid
27748 * @param h The virtual height of the grid
27752 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
27755 * Get the virtual size of the grid
27757 * @param obj The grid object
27758 * @param w Pointer to integer to store the virtual width of the grid
27759 * @param h Pointer to integer to store the virtual height of the grid
27763 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
27766 * Pack child at given position and size
27768 * @param obj The grid object
27769 * @param subobj The child to pack
27770 * @param x The virtual x coord at which to pack it
27771 * @param y The virtual y coord at which to pack it
27772 * @param w The virtual width at which to pack it
27773 * @param h The virtual height at which to pack it
27777 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
27780 * Unpack a child from a grid object
27782 * @param obj The grid object
27783 * @param subobj The child to unpack
27787 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
27790 * Faster way to remove all child objects from a grid object.
27792 * @param obj The grid object
27793 * @param clear If true, it will delete just removed children
27797 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
27800 * Set packing of an existing child at to position and size
27802 * @param subobj The child to set packing of
27803 * @param x The virtual x coord at which to pack it
27804 * @param y The virtual y coord at which to pack it
27805 * @param w The virtual width at which to pack it
27806 * @param h The virtual height at which to pack it
27810 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
27813 * get packing of a child
27815 * @param subobj The child to query
27816 * @param x Pointer to integer to store the virtual x coord
27817 * @param y Pointer to integer to store the virtual y coord
27818 * @param w Pointer to integer to store the virtual width
27819 * @param h Pointer to integer to store the virtual height
27823 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
27829 EAPI Evas_Object *elm_genscroller_add(Evas_Object *parent);
27830 EAPI void elm_genscroller_world_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h);
27833 * @defgroup Video Video
27835 * @addtogroup Video
27838 * Elementary comes with two object that help design application that need
27839 * to display video. The main one, Elm_Video, display a video by using Emotion.
27840 * It does embedded the video inside an Edje object, so you can do some
27841 * animation depending on the video state change. It does also implement a
27842 * ressource management policy to remove this burden from the application writer.
27844 * The second one, Elm_Player is a video player that need to be linked with and Elm_Video.
27845 * It take care of updating its content according to Emotion event and provide a
27846 * way to theme itself. It also does automatically raise the priority of the
27847 * linked Elm_Video so it will use the video decoder if available. It also does
27848 * activate the remember function on the linked Elm_Video object.
27850 * Signals that you can add callback for are :
27852 * "forward,clicked" - the user clicked the forward button.
27853 * "info,clicked" - the user clicked the info button.
27854 * "next,clicked" - the user clicked the next button.
27855 * "pause,clicked" - the user clicked the pause button.
27856 * "play,clicked" - the user clicked the play button.
27857 * "prev,clicked" - the user clicked the prev button.
27858 * "rewind,clicked" - the user clicked the rewind button.
27859 * "stop,clicked" - the user clicked the stop button.
27861 * To set the video of the player, you can use elm_object_content_set() API.
27866 * @brief Add a new Elm_Player object to the given parent Elementary (container) object.
27868 * @param parent The parent object
27869 * @return a new player widget handle or @c NULL, on errors.
27871 * This function inserts a new player widget on the canvas.
27873 * @see elm_object_content_set()
27877 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
27880 * @brief Link a Elm_Payer with an Elm_Video object.
27882 * @param player the Elm_Player object.
27883 * @param video The Elm_Video object.
27885 * This mean that action on the player widget will affect the
27886 * video object and the state of the video will be reflected in
27887 * the player itself.
27889 * @see elm_player_add()
27890 * @see elm_video_add()
27894 EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
27897 * @brief Add a new Elm_Video object to the given parent Elementary (container) object.
27899 * @param parent The parent object
27900 * @return a new video widget handle or @c NULL, on errors.
27902 * This function inserts a new video widget on the canvas.
27904 * @seeelm_video_file_set()
27905 * @see elm_video_uri_set()
27909 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
27912 * @brief Define the file that will be the video source.
27914 * @param video The video object to define the file for.
27915 * @param filename The file to target.
27917 * This function will explicitly define a filename as a source
27918 * for the video of the Elm_Video object.
27920 * @see elm_video_uri_set()
27921 * @see elm_video_add()
27922 * @see elm_player_add()
27926 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
27929 * @brief Define the uri that will be the video source.
27931 * @param video The video object to define the file for.
27932 * @param uri The uri to target.
27934 * This function will define an uri as a source for the video of the
27935 * Elm_Video object. URI could be remote source of video, like http:// or local source
27936 * like for example WebCam who are most of the time v4l2:// (but that depend and
27937 * you should use Emotion API to request and list the available Webcam on your system).
27939 * @see elm_video_file_set()
27940 * @see elm_video_add()
27941 * @see elm_player_add()
27945 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
27948 * @brief Get the underlying Emotion object.
27950 * @param video The video object to proceed the request on.
27951 * @return the underlying Emotion object.
27955 EAPI Evas_Object *elm_video_emotion_get(const Evas_Object *video);
27958 * @brief Start to play the video
27960 * @param video The video object to proceed the request on.
27962 * Start to play the video and cancel all suspend state.
27966 EAPI void elm_video_play(Evas_Object *video);
27969 * @brief Pause the video
27971 * @param video The video object to proceed the request on.
27973 * Pause the video and start a timer to trigger suspend mode.
27977 EAPI void elm_video_pause(Evas_Object *video);
27980 * @brief Stop the video
27982 * @param video The video object to proceed the request on.
27984 * Stop the video and put the emotion in deep sleep mode.
27988 EAPI void elm_video_stop(Evas_Object *video);
27991 * @brief Is the video actually playing.
27993 * @param video The video object to proceed the request on.
27994 * @return EINA_TRUE if the video is actually playing.
27996 * You should consider watching event on the object instead of polling
27997 * the object state.
28001 EAPI Eina_Bool elm_video_is_playing(const Evas_Object *video);
28004 * @brief Is it possible to seek inside the video.
28006 * @param video The video object to proceed the request on.
28007 * @return EINA_TRUE if is possible to seek inside the video.
28011 EAPI Eina_Bool elm_video_is_seekable(const Evas_Object *video);
28014 * @brief Is the audio muted.
28016 * @param video The video object to proceed the request on.
28017 * @return EINA_TRUE if the audio is muted.
28021 EAPI Eina_Bool elm_video_audio_mute_get(const Evas_Object *video);
28024 * @brief Change the mute state of the Elm_Video object.
28026 * @param video The video object to proceed the request on.
28027 * @param mute The new mute state.
28031 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
28034 * @brief Get the audio level of the current video.
28036 * @param video The video object to proceed the request on.
28037 * @return the current audio level.
28041 EAPI double elm_video_audio_level_get(const Evas_Object *video);
28044 * @brief Set the audio level of anElm_Video object.
28046 * @param video The video object to proceed the request on.
28047 * @param volume The new audio volume.
28051 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
28053 EAPI double elm_video_play_position_get(const Evas_Object *video);
28054 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
28055 EAPI double elm_video_play_length_get(const Evas_Object *video);
28056 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
28057 EAPI Eina_Bool elm_video_remember_position_get(const Evas_Object *video);
28058 EAPI const char *elm_video_title_get(const Evas_Object *video);
28063 // FIXME: incomplete - carousel. don't use this until this comment is removed
28064 typedef struct _Elm_Carousel_Item Elm_Carousel_Item;
28065 EAPI Evas_Object *elm_carousel_add(Evas_Object *parent);
28066 EAPI Elm_Carousel_Item *elm_carousel_item_add(Evas_Object *obj, Evas_Object *icon, const char *label, Evas_Smart_Cb func, const void *data);
28067 EAPI void elm_carousel_item_del(Elm_Carousel_Item *item);
28068 EAPI void elm_carousel_item_select(Elm_Carousel_Item *item);
28069 /* smart callbacks called:
28070 * "clicked" - when the user clicks on a carousel item and becomes selected
28075 typedef enum _Elm_Datefield_ItemType
28077 ELM_DATEFIELD_YEAR = 0,
28078 ELM_DATEFIELD_MONTH,
28079 ELM_DATEFIELD_DATE,
28080 ELM_DATEFIELD_HOUR,
28081 ELM_DATEFIELD_MINUTE,
28083 } Elm_Datefield_ItemType;
28085 EAPI Evas_Object *elm_datefield_add(Evas_Object *parent);
28086 EAPI void elm_datefield_format_set(Evas_Object *obj, const char *fmt);
28087 EAPI char *elm_datefield_format_get(const Evas_Object *obj);
28088 EAPI void elm_datefield_item_enabled_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, Eina_Bool enable);
28089 EAPI Eina_Bool elm_datefield_item_enabled_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28090 EAPI void elm_datefield_item_value_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value);
28091 EAPI int elm_datefield_item_value_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28092 EAPI void elm_datefield_item_min_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value, Eina_Bool abs_limit);
28093 EAPI int elm_datefield_item_min_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28094 EAPI Eina_Bool elm_datefield_item_min_is_absolute(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28095 EAPI void elm_datefield_item_max_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value, Eina_Bool abs_limit);
28096 EAPI int elm_datefield_item_max_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28097 EAPI Eina_Bool elm_datefield_item_max_is_absolute(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28099 /* smart callbacks called:
28100 * "changed" - when datefield value is changed, this signal is sent.
28103 ////////////////////// DEPRECATED ///////////////////////////////////
28105 typedef enum _Elm_Datefield_Layout
28107 ELM_DATEFIELD_LAYOUT_TIME,
28108 ELM_DATEFIELD_LAYOUT_DATE,
28109 ELM_DATEFIELD_LAYOUT_DATEANDTIME
28110 } Elm_Datefield_Layout;
28112 EINA_DEPRECATED EAPI void elm_datefield_layout_set(Evas_Object *obj, Elm_Datefield_Layout layout);
28113 EINA_DEPRECATED EAPI Elm_Datefield_Layout elm_datefield_layout_get(const Evas_Object *obj);
28114 EINA_DEPRECATED EAPI void elm_datefield_date_format_set(Evas_Object *obj, const char *fmt);
28115 EINA_DEPRECATED EAPI const char *elm_datefield_date_format_get(const Evas_Object *obj);
28116 EINA_DEPRECATED EAPI void elm_datefield_time_mode_set(Evas_Object *obj, Eina_Bool mode);
28117 EINA_DEPRECATED EAPI Eina_Bool elm_datefield_time_mode_get(const Evas_Object *obj);
28118 EINA_DEPRECATED EAPI void elm_datefield_date_set(Evas_Object *obj, int year, int month, int day, int hour, int min);
28119 EINA_DEPRECATED EAPI void elm_datefield_date_get(const Evas_Object *obj, int *year, int *month, int *day, int *hour, int *min);
28120 EINA_DEPRECATED EAPI Eina_Bool elm_datefield_date_max_set(Evas_Object *obj, int year, int month, int day);
28121 EINA_DEPRECATED EAPI void elm_datefield_date_max_get(const Evas_Object *obj, int *year, int *month, int *day);
28122 EINA_DEPRECATED EAPI Eina_Bool elm_datefield_date_min_set(Evas_Object *obj, int year, int month, int day);
28123 EINA_DEPRECATED EAPI void elm_datefield_date_min_get(const Evas_Object *obj, int *year, int *month, int *day);
28124 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);
28125 EINA_DEPRECATED EAPI void elm_datefield_input_panel_state_callback_del(Evas_Object *obj, void (*pEventCallbackFunc) (void *data, Evas_Object *obj, int value));
28126 /////////////////////////////////////////////////////////////////////
28129 typedef enum _Elm_Popup_Response
28131 ELM_POPUP_RESPONSE_NONE = -1,
28132 ELM_POPUP_RESPONSE_TIMEOUT = -2,
28133 ELM_POPUP_RESPONSE_OK = -3,
28134 ELM_POPUP_RESPONSE_CANCEL = -4,
28135 ELM_POPUP_RESPONSE_CLOSE = -5
28136 } Elm_Popup_Response;
28138 typedef enum _Elm_Popup_Mode
28140 ELM_POPUP_TYPE_NONE = 0,
28141 ELM_POPUP_TYPE_ALERT = (1 << 0)
28144 typedef enum _Elm_Popup_Orient
28146 ELM_POPUP_ORIENT_TOP,
28147 ELM_POPUP_ORIENT_CENTER,
28148 ELM_POPUP_ORIENT_BOTTOM,
28149 ELM_POPUP_ORIENT_LEFT,
28150 ELM_POPUP_ORIENT_RIGHT,
28151 ELM_POPUP_ORIENT_TOP_LEFT,
28152 ELM_POPUP_ORIENT_TOP_RIGHT,
28153 ELM_POPUP_ORIENT_BOTTOM_LEFT,
28154 ELM_POPUP_ORIENT_BOTTOM_RIGHT
28155 } Elm_Popup_Orient;
28157 /* smart callbacks called:
28158 * "response" - when ever popup is closed, this signal is sent with appropriate response id.".
28161 EAPI Evas_Object *elm_popup_add(Evas_Object *parent);
28162 EAPI void elm_popup_desc_set(Evas_Object *obj, const char *text);
28163 EAPI const char *elm_popup_desc_get(Evas_Object *obj);
28164 EAPI void elm_popup_title_label_set(Evas_Object *obj, const char *text);
28165 EAPI const char *elm_popup_title_label_get(Evas_Object *obj);
28166 EAPI void elm_popup_title_icon_set(Evas_Object *obj, Evas_Object *icon);
28167 EAPI Evas_Object *elm_popup_title_icon_get(Evas_Object *obj);
28168 EAPI void elm_popup_content_set(Evas_Object *obj, Evas_Object *content);
28169 EAPI Evas_Object *elm_popup_content_get(Evas_Object *obj);
28170 EAPI void elm_popup_buttons_add(Evas_Object *obj,int no_of_buttons, const char *first_button_text, ...);
28171 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, ... );
28172 EAPI void elm_popup_timeout_set(Evas_Object *obj, double timeout);
28173 EAPI void elm_popup_mode_set(Evas_Object *obj, Elm_Popup_Mode mode);
28174 EAPI void elm_popup_response(Evas_Object *obj, int response_id);
28175 EAPI void elm_popup_orient_set(Evas_Object *obj, Elm_Popup_Orient orient);
28176 EAPI int elm_popup_run(Evas_Object *obj);
28178 /* NavigationBar */
28179 #define NAVIBAR_TITLEOBJ_INSTANT_HIDE "elm,state,hide,noanimate,title", "elm"
28180 #define NAVIBAR_TITLEOBJ_INSTANT_SHOW "elm,state,show,noanimate,title", "elm"
28184 ELM_NAVIGATIONBAR_FUNCTION_BUTTON1,
28185 ELM_NAVIGATIONBAR_FUNCTION_BUTTON2,
28186 ELM_NAVIGATIONBAR_FUNCTION_BUTTON3,
28187 ELM_NAVIGATIONBAR_BACK_BUTTON
28188 } Elm_Navi_Button_Type;
28190 EAPI Evas_Object *elm_navigationbar_add(Evas_Object *parent);
28191 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);
28192 EAPI void elm_navigationbar_pop(Evas_Object *obj);
28193 EAPI void elm_navigationbar_to_content_pop(Evas_Object *obj, Evas_Object *content);
28194 EAPI void elm_navigationbar_title_label_set(Evas_Object *obj, Evas_Object *content, const char *title);
28195 EAPI const char *elm_navigationbar_title_label_get(Evas_Object *obj, Evas_Object *content);
28196 EAPI void elm_navigationbar_title_object_add(Evas_Object *obj, Evas_Object *content, Evas_Object *title_obj);
28197 EAPI Evas_Object *elm_navigationbar_title_object_get(Evas_Object *obj, Evas_Object *content);
28198 EAPI Eina_List *elm_navigationbar_title_object_list_get(Evas_Object *obj, Evas_Object *content);
28199 EAPI Evas_Object *elm_navigationbar_content_top_get(Evas_Object *obj);
28200 EAPI Evas_Object *elm_navigationbar_content_bottom_get(Evas_Object *obj);
28201 EAPI void elm_navigationbar_hidden_set(Evas_Object *obj, Eina_Bool hidden);
28202 EAPI void elm_navigationbar_title_button_set(Evas_Object *obj, Evas_Object *content, Evas_Object *button, Elm_Navi_Button_Type button_type);
28203 EAPI Evas_Object *elm_navigationbar_title_button_get(Evas_Object *obj, Evas_Object *content, Elm_Navi_Button_Type button_type);
28204 EAPI const char *elm_navigationbar_subtitle_label_get(Evas_Object *obj, Evas_Object *content);
28205 EAPI void elm_navigationbar_subtitle_label_set(Evas_Object *obj, Evas_Object *content, const char *subtitle);
28206 EAPI void elm_navigationbar_title_object_list_unset(Evas_Object *obj, Evas_Object *content, Eina_List **list);
28207 EAPI void elm_navigationbar_animation_disabled_set(Evas_Object *obj, Eina_Bool disable);
28208 EAPI void elm_navigationbar_title_object_visible_set(Evas_Object *obj, Evas_Object *content, Eina_Bool visible);
28209 Eina_Bool elm_navigationbar_title_object_visible_get(Evas_Object *obj, Evas_Object *content);
28210 EAPI void elm_navigationbar_title_icon_set(Evas_Object *obj, Evas_Object *content, Evas_Object *icon);
28211 EAPI Evas_Object *elm_navigationbar_title_icon_get(Evas_Object *obj, Evas_Object *content);
28213 /* NavigationBar */
28214 #define NAVIBAR_EX_TITLEOBJ_INSTANT_HIDE "elm,state,hide,noanimate,title", "elm"
28215 #define NAVIBAR_EX_TITLEOBJ_INSTANT_SHOW "elm,state,show,noanimate,title", "elm"
28219 ELM_NAVIGATIONBAR_EX_BACK_BUTTON,
28220 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON1,
28221 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON2,
28222 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON3,
28223 ELM_NAVIGATIONBAR_EX_MAX
28224 } Elm_Navi_ex_Button_Type;
28225 typedef struct _Elm_Navigationbar_ex_Item Elm_Navigationbar_ex_Item;
28227 EAPI Evas_Object *elm_navigationbar_ex_add(Evas_Object *parent);
28228 EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_push(Evas_Object *obj, Evas_Object *content, const char *item_style);
28229 EAPI void elm_navigationbar_ex_item_pop(Evas_Object *obj);
28230 EAPI void elm_navigationbar_ex_item_promote(Elm_Navigationbar_ex_Item* item);
28231 EAPI void elm_navigationbar_ex_to_item_pop(Elm_Navigationbar_ex_Item* item);
28232 EAPI void elm_navigationbar_ex_item_title_label_set(Elm_Navigationbar_ex_Item *item, const char *title);
28233 EAPI const char *elm_navigationbar_ex_item_title_label_get(Elm_Navigationbar_ex_Item* item);
28234 EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_top_get(const Evas_Object *obj);
28235 EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_bottom_get(const Evas_Object *obj);
28236 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);
28237 EAPI Evas_Object *elm_navigationbar_ex_item_title_button_get(Elm_Navigationbar_ex_Item* item, int button_type);
28238 EAPI void elm_navigationbar_ex_item_title_object_set(Elm_Navigationbar_ex_Item* item, Evas_Object *title_obj);
28239 EAPI Evas_Object *elm_navigationbar_ex_item_title_object_unset(Elm_Navigationbar_ex_Item* item);
28240 EAPI void elm_navigationbar_ex_item_title_hidden_set(Elm_Navigationbar_ex_Item* item, Eina_Bool hidden);
28241 EAPI Evas_Object *elm_navigationbar_ex_item_title_object_get(Elm_Navigationbar_ex_Item* item);
28242 EAPI const char *elm_navigationbar_ex_item_subtitle_label_get(Elm_Navigationbar_ex_Item* item);
28243 EAPI void elm_navigationbar_ex_item_subtitle_label_set( Elm_Navigationbar_ex_Item* item, const char *subtitle);
28244 EAPI void elm_navigationbar_ex_item_style_set(Elm_Navigationbar_ex_Item* item, const char* item_style);
28245 EAPI const char *elm_navigationbar_ex_item_style_get(Elm_Navigationbar_ex_Item* item);
28246 EAPI Evas_Object *elm_navigationbar_ex_item_content_unset(Elm_Navigationbar_ex_Item* item);
28247 EAPI Evas_Object *elm_navigationbar_ex_item_content_get(Elm_Navigationbar_ex_Item* item);
28248 EAPI void elm_navigationbar_ex_delete_on_pop_set(Evas_Object *obj, Eina_Bool del_on_pop);
28249 EAPI Evas_Object *elm_navigationbar_ex_item_icon_get(Elm_Navigationbar_ex_Item* item);
28250 EAPI void elm_navigationbar_ex_item_icon_set(Elm_Navigationbar_ex_Item* item, Evas_Object *icon);
28251 EAPI Evas_Object *elm_navigationbar_ex_item_title_button_unset(Elm_Navigationbar_ex_Item* item, int button_type);
28252 EAPI void elm_navigationbar_ex_animation_disable_set(Evas_Object *obj, Eina_Bool disable);
28253 EAPI void elm_navigationbar_ex_title_object_visible_set(Elm_Navigationbar_ex_Item* item, Eina_Bool visible);
28254 Eina_Bool elm_navigationbar_ex_title_object_visible_get(Elm_Navigationbar_ex_Item* item);
28257 #define ELM_NAVIFRAME_ITEM_CONTENT "elm.swallow.content"
28258 #define ELM_NAVIFRAME_ITEM_ICON "elm.swallow.icon"
28259 #define ELM_NAVIFRAME_ITEM_OPTIONHEADER "elm.swallow.optionheader"
28260 #define ELM_NAVIFRAME_ITEM_OPTIONHEADER2 "elm.swallow.optionheader2"
28261 #define ELM_NAVIFRAME_ITEM_TITLE_LABEL "elm.text.title"
28262 #define ELM_NAVIFRAME_ITEM_PREV_BTN "elm.swallow.prev_btn"
28263 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_CLOSE "elm,state,optionheader,close", ""
28264 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_OPEN "elm,state,optionheader,open", ""
28265 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_INSTANT_CLOSE "elm,state,optionheader,instant_close", ""
28266 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_INSTANT_OPEN "elm,state,optionheader,instant_open", ""
28269 * @defgroup Naviframe Naviframe
28271 * @brief Naviframe is a kind of view manager for the applications.
28273 * Naviframe provides functions to switch different pages with stack
28274 * mechanism. It means if one page(item) needs to be changed to the new one,
28275 * then naviframe would push the new page to it's internal stack. Of course,
28276 * it can be back to the previous page by popping the top page. Naviframe
28277 * provides some transition effect while the pages are switching (same as
28280 * Since each item could keep the different styles, users could keep the
28281 * same look & feel for the pages or different styles for the items in it's
28284 * Signals that you can add callback for are:
28286 * @li "transition,finished" - When the transition is finished in changing
28288 * @li "title,clicked" - User clicked title area
28290 * Default contents parts for the naviframe items that you can use for are:
28292 * @li "elm.swallow.content" - The main content of the page
28293 * @li "elm.swallow.prev_btn" - The button to go to the previous page
28294 * @li "elm.swallow.next_btn" - The button to go to the next page
28296 * Default text parts of naviframe items that you can be used are:
28298 * @li "elm.text.title" - The title label in the title area
28300 * @ref tutorial_naviframe gives a good overview of the usage of the API.
28304 * @brief Add a new Naviframe object to the parent.
28306 * @param parent Parent object
28307 * @return New object or @c NULL, if it cannot be created
28309 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28311 * @brief Push a new item to the top of the naviframe stack (and show it).
28313 * @param obj The naviframe object
28314 * @param title_label The label in the title area. The name of the title
28315 * label part is "elm.text.title"
28316 * @param prev_btn The button to go to the previous item. If it is NULL,
28317 * then naviframe will create a back button automatically. The name of
28318 * the prev_btn part is "elm.swallow.prev_btn"
28319 * @param next_btn The button to go to the next item. Or It could be just an
28320 * extra function button. The name of the next_btn part is
28321 * "elm.swallow.next_btn"
28322 * @param content The main content object. The name of content part is
28323 * "elm.swallow.content"
28324 * @param item_style The current item style name. @c NULL would be default.
28325 * @return The created item or @c NULL upon failure.
28327 * The item pushed becomes one page of the naviframe, this item will be
28328 * deleted when it is popped.
28330 * @see also elm_naviframe_item_style_set()
28332 * The following styles are available for this item:
28335 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);
28337 * @brief Pop an item that is on top of the stack
28339 * @param obj The naviframe object
28340 * @return @c NULL or the content object(if the
28341 * elm_naviframe_content_preserve_on_pop_get is true).
28343 * This pops an item that is on the top(visible) of the naviframe, makes it
28344 * disappear, then deletes the item. The item that was underneath it on the
28345 * stack will become visible.
28347 * @see also elm_naviframe_content_preserve_on_pop_get()
28349 * @ingroup Naviframe
28351 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
28353 * @brief Pop the items between the top and the above one on the given item.
28355 * @param it The naviframe item
28357 * @ingroup Naviframe
28359 EAPI void elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28361 * Promote an item already in the naviframe stack to the top of the stack
28363 * @param it The naviframe item
28365 * This will take the indicated item and promote it to the top of the stack
28366 * as if it had been pushed there. The item must already be inside the
28367 * naviframe stack to work.
28370 EAPI void elm_naviframe_item_promote(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28372 * @brief Delete the given item instantly.
28374 * @param it The naviframe item
28376 * This just deletes the given item from the naviframe item list instantly.
28377 * So this would not emit any signals for view transitions but just change
28378 * the current view if the given item is a top one.
28380 * @ingroup Naviframe
28382 EAPI void elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28384 * @brief preserve the content objects when items are popped.
28386 * @param obj The naviframe object
28387 * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
28389 * @see also elm_naviframe_content_preserve_on_pop_get()
28391 * @ingroup Naviframe
28393 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
28395 * @brief Get a value whether preserve mode is enabled or not.
28397 * @param obj The naviframe object
28398 * @return If @c EINA_TRUE, preserve mode is enabled
28400 * @see also elm_naviframe_content_preserve_on_pop_set()
28402 * @ingroup Naviframe
28404 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28406 * @brief Get a top item on the naviframe stack
28408 * @param obj The naviframe object
28409 * @return The top item on the naviframe stack or @c NULL, if the stack is
28412 * @ingroup Naviframe
28414 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28416 * @brief Get a bottom item on the naviframe stack
28418 * @param obj The naviframe object
28419 * @return The bottom item on the naviframe stack or @c NULL, if the stack is
28422 * @ingroup Naviframe
28424 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28426 * @brief Set an item style
28428 * @param obj The naviframe item
28429 * @param item_style The current item style name. @c NULL would be default
28431 * The following styles are available for this item:
28434 * @see also elm_naviframe_item_style_get()
28436 * @ingroup Naviframe
28438 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
28440 * @brief Get an item style
28442 * @param obj The naviframe item
28443 * @return The current item style name
28445 * @see also elm_naviframe_item_style_set()
28447 * @ingroup Naviframe
28449 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28451 * @brief Show/Hide the title area
28453 * @param it The naviframe item
28454 * @param visible If @c EINA_TRUE, title area will be visible, hidden
28457 * When the title area is invisible, then the controls would be hidden so as * to expand the content area to full-size.
28459 * @see also elm_naviframe_item_title_visible_get()
28461 * @ingroup Naviframe
28463 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
28465 * @brief Get a value whether title area is visible or not.
28467 * @param it The naviframe item
28468 * @return If @c EINA_TRUE, title area is visible
28470 * @see also elm_naviframe_item_title_visible_set()
28472 * @ingroup Naviframe
28474 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28477 * @brief Set creating prev button automatically or not
28479 * @param obj The naviframe object
28480 * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
28481 * be created internally when you pass the @c NULL to the prev_btn
28482 * parameter in elm_naviframe_item_push
28484 * @see also elm_naviframe_item_push()
28486 EAPI void elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
28488 * @brief Get a value whether prev button(back button) will be auto pushed or
28491 * @param obj The naviframe object
28492 * @return If @c EINA_TRUE, prev button will be auto pushed.
28494 * @see also elm_naviframe_item_push()
28495 * elm_naviframe_prev_btn_auto_pushed_set()
28497 EAPI Eina_Bool elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
28500 #define CONTROLBAR_SYSTEM_ICON_ALBUMS "controlbar_albums"
28501 #define CONTROLBAR_SYSTEM_ICON_ARTISTS "controlbar_artists"
28502 #define CONTROLBAR_SYSTEM_ICON_SONGS "controlbar_songs"
28503 #define CONTROLBAR_SYSTEM_ICON_PLAYLIST "controlbar_playlist"
28504 #define CONTROLBAR_SYSTEM_ICON_MORE "controlbar_more"
28505 #define CONTROLBAR_SYSTEM_ICON_CONTACTS "controlbar_contacts"
28506 #define CONTROLBAR_SYSTEM_ICON_DIALER "controlbar_dialer"
28507 #define CONTROLBAR_SYSTEM_ICON_FAVORITES "controlbar_favorites"
28508 #define CONTROLBAR_SYSTEM_ICON_LOGS "controlbar_logs"
28510 typedef enum _Elm_Controlbar_Mode_Type
28512 ELM_CONTROLBAR_MODE_DEFAULT = 0,
28513 ELM_CONTROLBAR_MODE_TRANSLUCENCE,
28514 ELM_CONTROLBAR_MODE_TRANSPARENCY,
28515 ELM_CONTROLBAR_MODE_LARGE,
28516 ELM_CONTROLBAR_MODE_SMALL,
28517 ELM_CONTROLBAR_MODE_LEFT,
28518 ELM_CONTROLBAR_MODE_RIGHT
28519 } Elm_Controlbar_Mode_Type;
28521 typedef struct _Elm_Controlbar_Item Elm_Controlbar_Item;
28522 EAPI Evas_Object *elm_controlbar_add(Evas_Object *parent);
28523 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_append(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
28524 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_prepend(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
28525 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);
28526 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);
28527 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);
28528 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);
28529 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);
28530 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);
28531 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_append(Evas_Object *obj, Evas_Object *obj_item, const int sel);
28532 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_prepend(Evas_Object *obj, Evas_Object *obj_item, const int sel);
28533 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_before(Evas_Object *obj, Elm_Controlbar_Item *before, Evas_Object *obj_item, const int sel);
28534 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_after(Evas_Object *obj, Elm_Controlbar_Item *after, Evas_Object *obj_item, const int sel);
28535 EAPI Evas_Object *elm_controlbar_object_item_object_get(const Elm_Controlbar_Item *it);
28536 EAPI void elm_controlbar_item_del(Elm_Controlbar_Item *it);
28537 EAPI void elm_controlbar_item_select(Elm_Controlbar_Item *it);
28538 EAPI void elm_controlbar_item_visible_set(Elm_Controlbar_Item *it, Eina_Bool bar);
28539 EAPI Eina_Bool elm_controlbar_item_visible_get(const Elm_Controlbar_Item * it);
28540 EAPI void elm_controlbar_item_disabled_set(Elm_Controlbar_Item * it, Eina_Bool disabled);
28541 EAPI Eina_Bool elm_controlbar_item_disabled_get(const Elm_Controlbar_Item * it);
28542 EAPI void elm_controlbar_item_icon_set(Elm_Controlbar_Item *it, const char *icon_path);
28543 EAPI Evas_Object *elm_controlbar_item_icon_get(const Elm_Controlbar_Item *it);
28544 EAPI void elm_controlbar_item_label_set(Elm_Controlbar_Item *it, const char *label);
28545 EAPI const char *elm_controlbar_item_label_get(const Elm_Controlbar_Item *it);
28546 EAPI Elm_Controlbar_Item *elm_controlbar_selected_item_get(const Evas_Object *obj);
28547 EAPI Elm_Controlbar_Item *elm_controlbar_first_item_get(const Evas_Object *obj);
28548 EAPI Elm_Controlbar_Item *elm_controlbar_last_item_get(const Evas_Object *obj);
28549 EAPI const Eina_List *elm_controlbar_items_get(const Evas_Object *obj);
28550 EAPI Elm_Controlbar_Item *elm_controlbar_item_prev(Elm_Controlbar_Item *it);
28551 EAPI Elm_Controlbar_Item *elm_controlbar_item_next(Elm_Controlbar_Item *it);
28552 EAPI void elm_controlbar_item_view_set(Elm_Controlbar_Item *it, Evas_Object * view);
28553 EAPI Evas_Object *elm_controlbar_item_view_get(const Elm_Controlbar_Item *it);
28554 EAPI Evas_Object *elm_controlbar_item_view_unset(Elm_Controlbar_Item *it);
28555 EAPI Evas_Object *elm_controlbar_item_button_get(const Elm_Controlbar_Item *it);
28556 EAPI void elm_controlbar_mode_set(Evas_Object *obj, int mode);
28557 EAPI void elm_controlbar_alpha_set(Evas_Object *obj, int alpha);
28558 EAPI void elm_controlbar_item_auto_align_set(Evas_Object *obj, Eina_Bool auto_align);
28559 EAPI void elm_controlbar_vertical_set(Evas_Object *obj, Eina_Bool vertical);
28562 EAPI Evas_Object *elm_searchbar_add(Evas_Object *parent);
28563 EAPI void elm_searchbar_text_set(Evas_Object *obj, const char *entry);
28564 EAPI const char *elm_searchbar_text_get(Evas_Object *obj);
28565 EAPI Evas_Object *elm_searchbar_entry_get(Evas_Object *obj);
28566 EAPI Evas_Object *elm_searchbar_editfield_get(Evas_Object *obj);
28567 EAPI void elm_searchbar_cancel_button_animation_set(Evas_Object *obj, Eina_Bool cancel_btn_ani_flag);
28568 EAPI void elm_searchbar_cancel_button_set(Evas_Object *obj, Eina_Bool visible);
28569 EAPI void elm_searchbar_clear(Evas_Object *obj);
28570 EAPI void elm_searchbar_boundary_rect_set(Evas_Object *obj, Eina_Bool boundary);
28572 EAPI Evas_Object *elm_page_control_add(Evas_Object *parent);
28573 EAPI void elm_page_control_page_count_set(Evas_Object *obj, unsigned int page_count);
28574 EAPI void elm_page_control_page_id_set(Evas_Object *obj, unsigned int page_id);
28575 EAPI unsigned int elm_page_control_page_id_get(Evas_Object *obj);
28578 EAPI Evas_Object *elm_nocontents_add(Evas_Object *parent);
28579 EAPI void elm_nocontents_label_set(Evas_Object *obj, const char *label);
28580 EAPI const char *elm_nocontents_label_get(const Evas_Object *obj);
28581 EAPI void elm_nocontents_custom_set(const Evas_Object *obj, Evas_Object *custom);
28582 EAPI Evas_Object *elm_nocontents_custom_get(const Evas_Object *obj);
28587 ELM_TICKERNOTI_ORIENT_TOP = 0,
28588 ELM_TICKERNOTI_ORIENT_BOTTOM,
28589 ELM_TICKERNOTI_ORIENT_LAST
28590 } Elm_Tickernoti_Orient;
28592 EAPI Evas_Object *elm_tickernoti_add (Evas_Object *parent);
28593 EAPI void elm_tickernoti_orient_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
28594 EAPI Elm_Tickernoti_Orient elm_tickernoti_orient_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28595 EAPI int elm_tickernoti_rotation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28596 EAPI void elm_tickernoti_rotation_set (Evas_Object *obj, int angle) EINA_ARG_NONNULL(1);
28597 EAPI Evas_Object *elm_tickernoti_win_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28598 /* #### Below APIs and data structures are going to be deprecated, announcment will be made soon ####*/
28601 ELM_TICKERNOTI_DEFAULT,
28602 ELM_TICKERNOTI_DETAILVIEW
28603 } Elm_Tickernoti_Mode;
28604 EAPI void elm_tickernoti_detailview_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
28605 EAPI const char *elm_tickernoti_detailview_label_get (const Evas_Object *obj)EINA_ARG_NONNULL(1);
28606 EAPI void elm_tickernoti_detailview_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(2);
28607 EAPI Evas_Object *elm_tickernoti_detailview_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28608 EAPI void elm_tickernoti_detailview_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
28609 EAPI Evas_Object *elm_tickernoti_detailview_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28610 EAPI Evas_Object *elm_tickernoti_detailview_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28611 EAPI void elm_tickernoti_mode_set (Evas_Object *obj, Elm_Tickernoti_Mode mode) EINA_ARG_NONNULL(1);
28612 EAPI Elm_Tickernoti_Mode elm_tickernoti_mode_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28613 EAPI void elm_tickernoti_orientation_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
28614 EAPI Elm_Tickernoti_Orient elm_tickernoti_orientation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28615 EAPI void elm_tickernoti_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
28616 EAPI const char *elm_tickernoti_label_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28617 EAPI void elm_tickernoti_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
28618 EAPI Evas_Object *elm_tickernoti_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28619 EAPI void elm_tickernoti_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(1);
28620 EAPI Evas_Object *elm_tickernoti_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28621 /* ############################################################################### */
28623 * Parts which can be used with elm_object_text_part_set() and
28624 * elm_object_text_part_get():
28626 * @li NULL/"default" - Operates on tickernoti content-text
28628 * Parts which can be used with elm_object_content_part_set() and
28629 * elm_object_content_part_get():
28631 * @li "icon" - Operates on tickernoti's icon
28632 * @li "button" - Operates on tickernoti's button
28634 * smart callbacks called:
28635 * @li "clicked" - emitted when tickernoti is clicked, except at the
28636 * swallow/button region, if any.
28637 * @li "hide" - emitted when the tickernoti is completely hidden. In case of
28638 * any hide animation, this signal is emitted after the animation.
28642 typedef struct _Colorpalette_Color Elm_Colorpalette_Color;
28644 struct _Colorpalette_Color
28646 unsigned int r, g, b;
28649 EAPI Evas_Object *elm_colorpalette_add(Evas_Object *parent);
28650 EAPI void elm_colorpalette_color_set(Evas_Object *obj, int color_num, Elm_Colorpalette_Color *color);
28651 EAPI void elm_colorpalette_row_column_set(Evas_Object *obj, int row, int col);
28652 /* smart callbacks called:
28653 * "clicked" - when image clicked
28657 EAPI Evas_Object *elm_editfield_add(Evas_Object *parent);
28658 EAPI void elm_editfield_label_set(Evas_Object *obj, const char *label);
28659 EAPI const char *elm_editfield_label_get(Evas_Object *obj);
28660 EAPI void elm_editfield_guide_text_set(Evas_Object *obj, const char *text);
28661 EAPI const char *elm_editfield_guide_text_get(Evas_Object *obj);
28662 EAPI Evas_Object *elm_editfield_entry_get(Evas_Object *obj);
28663 // EAPI Evas_Object *elm_editfield_clear_button_show(Evas_Object *obj, Eina_Bool show);
28664 EAPI void elm_editfield_right_icon_set(Evas_Object *obj, Evas_Object *icon);
28665 EAPI Evas_Object *elm_editfield_right_icon_get(Evas_Object *obj);
28666 EAPI void elm_editfield_left_icon_set(Evas_Object *obj, Evas_Object *icon);
28667 EAPI Evas_Object *elm_editfield_left_icon_get(Evas_Object *obj);
28668 EAPI void elm_editfield_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line);
28669 EAPI Eina_Bool elm_editfield_entry_single_line_get(Evas_Object *obj);
28670 EAPI void elm_editfield_eraser_set(Evas_Object *obj, Eina_Bool visible);
28671 EAPI Eina_Bool elm_editfield_eraser_get(Evas_Object *obj);
28672 /* smart callbacks called:
28673 * "clicked" - when an editfield is clicked
28674 * "unfocused" - when an editfield is unfocused
28678 /* Sliding Drawer */
28679 typedef enum _Elm_SlidingDrawer_Pos
28681 ELM_SLIDINGDRAWER_BOTTOM,
28682 ELM_SLIDINGDRAWER_LEFT,
28683 ELM_SLIDINGDRAWER_RIGHT,
28684 ELM_SLIDINGDRAWER_TOP
28685 } Elm_SlidingDrawer_Pos;
28687 typedef struct _Elm_SlidingDrawer_Drag_Value
28690 } Elm_SlidingDrawer_Drag_Value;
28692 EINA_DEPRECATED EAPI Evas_Object *elm_slidingdrawer_add(Evas_Object *parent);
28693 EINA_DEPRECATED EAPI void elm_slidingdrawer_content_set (Evas_Object *obj, Evas_Object *content);
28694 EINA_DEPRECATED EAPI Evas_Object *elm_slidingdrawer_content_unset(Evas_Object *obj);
28695 EINA_DEPRECATED EAPI void elm_slidingdrawer_pos_set(Evas_Object *obj, Elm_SlidingDrawer_Pos pos);
28696 EINA_DEPRECATED EAPI void elm_slidingdrawer_max_drag_value_set(Evas_Object *obj, double dw, double dh);
28697 EINA_DEPRECATED EAPI void elm_slidingdrawer_drag_value_set(Evas_Object *obj, double dx, double dy);
28699 /* multibuttonentry */
28700 typedef struct _Multibuttonentry_Item Elm_Multibuttonentry_Item;
28701 typedef Eina_Bool (*Elm_Multibuttonentry_Item_Verify_Callback) (Evas_Object *obj, const char *item_label, void *item_data, void *data);
28702 EAPI Evas_Object *elm_multibuttonentry_add(Evas_Object *parent);
28703 EAPI const char *elm_multibuttonentry_label_get(Evas_Object *obj);
28704 EAPI void elm_multibuttonentry_label_set(Evas_Object *obj, const char *label);
28705 EAPI Evas_Object *elm_multibuttonentry_entry_get(Evas_Object *obj);
28706 EAPI const char * elm_multibuttonentry_guide_text_get(Evas_Object *obj);
28707 EAPI void elm_multibuttonentry_guide_text_set(Evas_Object *obj, const char *guidetext);
28708 EAPI int elm_multibuttonentry_contracted_state_get(Evas_Object *obj);
28709 EAPI void elm_multibuttonentry_contracted_state_set(Evas_Object *obj, int contracted);
28710 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_start(Evas_Object *obj, const char *label, void *data);
28711 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_end(Evas_Object *obj, const char *label, void *data);
28712 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_before(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *before, void *data);
28713 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_after(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *after, void *data);
28714 EAPI const Eina_List *elm_multibuttonentry_items_get(Evas_Object *obj);
28715 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_first_get(Evas_Object *obj);
28716 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_last_get(Evas_Object *obj);
28717 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_selected_get(Evas_Object *obj);
28718 EAPI void elm_multibuttonentry_item_selected_set(Elm_Multibuttonentry_Item *item);
28719 EAPI void elm_multibuttonentry_item_unselect_all(Evas_Object *obj);
28720 EAPI void elm_multibuttonentry_item_del(Elm_Multibuttonentry_Item *item);
28721 EAPI void elm_multibuttonentry_items_del(Evas_Object *obj);
28722 EAPI const char *elm_multibuttonentry_item_label_get(Elm_Multibuttonentry_Item *item);
28723 EAPI void elm_multibuttonentry_item_label_set(Elm_Multibuttonentry_Item *item, const char *str);
28724 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prev(Elm_Multibuttonentry_Item *item);
28725 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_next(Elm_Multibuttonentry_Item *item);
28726 EAPI void *elm_multibuttonentry_item_data_get(Elm_Multibuttonentry_Item *item);
28727 EAPI void elm_multibuttonentry_item_data_set(Elm_Multibuttonentry_Item *item, void *data);
28728 EAPI void elm_multibuttonentry_item_verify_callback_set(Evas_Object *obj, Elm_Multibuttonentry_Item_Verify_Callback func, void *data);
28729 /* smart callback called:
28730 * "selected" - This signal is emitted when the selected item of multibuttonentry is changed.
28731 * "added" - This signal is emitted when a new multibuttonentry item is added.
28732 * "deleted" - This signal is emitted when a multibuttonentry item is deleted.
28733 * "expanded" - This signal is emitted when a multibuttonentry is expanded.
28734 * "contracted" - This signal is emitted when a multibuttonentry is contracted.
28735 * "contracted,state,changed" - This signal is emitted when the contracted state of multibuttonentry is changed.
28736 * "item,selected" - This signal is emitted when the selected item of multibuttonentry is changed.
28737 * "item,added" - This signal is emitted when a new multibuttonentry item is added.
28738 * "item,deleted" - This signal is emitted when a multibuttonentry item is deleted.
28739 * "item,clicked" - This signal is emitted when a multibuttonentry item is clicked.
28740 * "clicked" - This signal is emitted when a multibuttonentry is clicked.
28741 * "unfocused" - This signal is emitted when a multibuttonentry is unfocused.
28743 /* available styles:
28748 typedef struct _Stackedicon_Item Elm_Stackedicon_Item;
28749 EAPI Evas_Object *elm_stackedicon_add(Evas_Object *parent);
28750 EAPI Elm_Stackedicon_Item *elm_stackedicon_item_append(Evas_Object *obj, const char *path);
28751 EAPI Elm_Stackedicon_Item *elm_stackedicon_item_prepend(Evas_Object *obj, const char *path);
28752 EAPI void elm_stackedicon_item_del(Elm_Stackedicon_Item *it);
28753 EAPI Eina_List *elm_stackedicon_item_list_get(Evas_Object *obj);
28754 /* smart callback called:
28755 * "expanded" - This signal is emitted when a stackedicon is expanded.
28756 * "clicked" - This signal is emitted when a stackedicon is clicked.
28758 /* available styles:
28762 /* dialoguegroup */
28763 typedef struct _Dialogue_Item Dialogue_Item;
28765 typedef enum _Elm_Dialoguegourp_Item_Style
28767 ELM_DIALOGUEGROUP_ITEM_STYLE_DEFAULT = 0,
28768 ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD = (1 << 0),
28769 ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD_WITH_TITLE = (1 << 1),
28770 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_TITLE = (1 << 2),
28771 ELM_DIALOGUEGROUP_ITEM_STYLE_HIDDEN = (1 << 3),
28772 ELM_DIALOGUEGROUP_ITEM_STYLE_DATAVIEW = (1 << 4),
28773 ELM_DIALOGUEGROUP_ITEM_STYLE_NO_BG = (1 << 5),
28774 ELM_DIALOGUEGROUP_ITEM_STYLE_SUB = (1 << 6),
28775 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT = (1 << 7),
28776 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_MERGE = (1 << 8),
28777 ELM_DIALOGUEGROUP_ITEM_STYLE_LAST = (1 << 9)
28778 } Elm_Dialoguegroup_Item_Style;
28780 EINA_DEPRECATED EAPI Evas_Object *elm_dialoguegroup_add(Evas_Object *parent);
28781 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_append(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
28782 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_prepend(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
28783 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_after(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *after, Elm_Dialoguegroup_Item_Style style);
28784 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_before(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *before, Elm_Dialoguegroup_Item_Style style);
28785 EINA_DEPRECATED EAPI void elm_dialoguegroup_remove(Dialogue_Item *item);
28786 EINA_DEPRECATED EAPI void elm_dialoguegroup_remove_all(Evas_Object *obj);
28787 EINA_DEPRECATED EAPI void elm_dialoguegroup_title_set(Evas_Object *obj, const char *title);
28788 EINA_DEPRECATED EAPI const char *elm_dialoguegroup_title_get(Evas_Object *obj);
28789 EINA_DEPRECATED EAPI void elm_dialoguegroup_press_effect_set(Dialogue_Item *item, Eina_Bool press);
28790 EINA_DEPRECATED EAPI Eina_Bool elm_dialoguegroup_press_effect_get(Dialogue_Item *item);
28791 EINA_DEPRECATED EAPI Evas_Object *elm_dialoguegroup_item_content_get(Dialogue_Item *item);
28792 EINA_DEPRECATED EAPI void elm_dialoguegroup_item_style_set(Dialogue_Item *item, Elm_Dialoguegroup_Item_Style style);
28793 EINA_DEPRECATED EAPI Elm_Dialoguegroup_Item_Style elm_dialoguegroup_item_style_get(Dialogue_Item *item);
28794 EINA_DEPRECATED EAPI void elm_dialoguegroup_item_disabled_set(Dialogue_Item *item, Eina_Bool disabled);
28795 EINA_DEPRECATED EAPI Eina_Bool elm_dialoguegroup_item_disabled_get(Dialogue_Item *item);
28800 ELM_DAYSELECTOR_SUN,
28801 ELM_DAYSELECTOR_MON,
28802 ELM_DAYSELECTOR_TUE,
28803 ELM_DAYSELECTOR_WED,
28804 ELM_DAYSELECTOR_THU,
28805 ELM_DAYSELECTOR_FRI,
28806 ELM_DAYSELECTOR_SAT
28807 } Elm_DaySelector_Day;
28809 EAPI Evas_Object *elm_dayselector_add(Evas_Object *parent);
28810 EAPI Eina_Bool elm_dayselector_check_state_get(Evas_Object *obj, Elm_DaySelector_Day day);
28811 EAPI void elm_dayselector_check_state_set(Evas_Object *obj, Elm_DaySelector_Day day, Eina_Bool checked);
28814 typedef struct _Imageslider_Item Elm_Imageslider_Item;
28815 typedef void (*Elm_Imageslider_Cb)(void *data, Evas_Object *obj, void *event_info);
28816 EAPI Evas_Object *elm_imageslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28817 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);
28818 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);
28819 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);
28820 EAPI void elm_imageslider_item_del(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
28821 EAPI Elm_Imageslider_Item *elm_imageslider_selected_item_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
28822 EAPI Eina_Bool elm_imageslider_item_selected_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
28823 EAPI void elm_imageslider_item_selected_set(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
28824 EAPI const char *elm_imageslider_item_photo_file_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
28825 EAPI Elm_Imageslider_Item *elm_imageslider_item_prev(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
28826 EAPI Elm_Imageslider_Item *elm_imageslider_item_next(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
28827 EAPI void elm_imageslider_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
28828 EAPI void elm_imageslider_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
28829 EAPI void elm_imageslider_item_photo_file_set(Elm_Imageslider_Item *it, const char *photo_file) EINA_ARG_NONNULL(1,2);
28830 EAPI void elm_imageslider_item_update(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);