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 * #GridItemLabelGetFunc.
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 #GridItemIconGetFunc.
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 #GridItemStateGetFunc.
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 #GridItemDelFunc.
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 *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
7975 typedef Evas_Object *(*GridItemIconGetFunc) (void *data, Evas_Object *obj, const char *part); /**< Content (swallowed object) fetching class function for gengrid item classes. */
7976 typedef Eina_Bool (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for gengrid item classes. */
7977 typedef void (*GridItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
7980 * @struct _Elm_Gengrid_Item_Class
7982 * Gengrid item class definition. See @ref Gengrid_Item_Class for
7985 struct _Elm_Gengrid_Item_Class
7987 const char *item_style;
7988 struct _Elm_Gengrid_Item_Class_Func
7990 GridItemLabelGetFunc label_get;
7991 GridItemIconGetFunc icon_get;
7992 GridItemStateGetFunc state_get;
7993 GridItemDelFunc del;
7995 }; /**< #Elm_Gengrid_Item_Class member definitions */
7997 * Add a new gengrid widget to the given parent Elementary
7998 * (container) object
8000 * @param parent The parent object
8001 * @return a new gengrid widget handle or @c NULL, on errors
8003 * This function inserts a new gengrid widget on the canvas.
8005 * @see elm_gengrid_item_size_set()
8006 * @see elm_gengrid_group_item_size_set()
8007 * @see elm_gengrid_horizontal_set()
8008 * @see elm_gengrid_item_append()
8009 * @see elm_gengrid_item_del()
8010 * @see elm_gengrid_clear()
8014 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8017 * Set the size for the items of a given gengrid widget
8019 * @param obj The gengrid object.
8020 * @param w The items' width.
8021 * @param h The items' height;
8023 * A gengrid, after creation, has still no information on the size
8024 * to give to each of its cells. So, you most probably will end up
8025 * with squares one @ref Fingers "finger" wide, the default
8026 * size. Use this function to force a custom size for you items,
8027 * making them as big as you wish.
8029 * @see elm_gengrid_item_size_get()
8033 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8036 * Get the size set for the items of a given gengrid widget
8038 * @param obj The gengrid object.
8039 * @param w Pointer to a variable where to store the items' width.
8040 * @param h Pointer to a variable where to store the items' height.
8042 * @note Use @c NULL pointers on the size values you're not
8043 * interested in: they'll be ignored by the function.
8045 * @see elm_gengrid_item_size_get() for more details
8049 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8052 * Set the items grid's alignment within a given gengrid widget
8054 * @param obj The gengrid object.
8055 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8056 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8058 * This sets the alignment of the whole grid of items of a gengrid
8059 * within its given viewport. By default, those values are both
8060 * 0.5, meaning that the gengrid will have its items grid placed
8061 * exactly in the middle of its viewport.
8063 * @note If given alignment values are out of the cited ranges,
8064 * they'll be changed to the nearest boundary values on the valid
8067 * @see elm_gengrid_align_get()
8071 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8074 * Get the items grid's alignment values within a given gengrid
8077 * @param obj The gengrid object.
8078 * @param align_x Pointer to a variable where to store the
8079 * horizontal alignment.
8080 * @param align_y Pointer to a variable where to store the vertical
8083 * @note Use @c NULL pointers on the alignment values you're not
8084 * interested in: they'll be ignored by the function.
8086 * @see elm_gengrid_align_set() for more details
8090 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8093 * Set whether a given gengrid widget is or not able have items
8096 * @param obj The gengrid object
8097 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8098 * @c EINA_FALSE to turn it off
8100 * If a gengrid is set to allow reordering, a click held for more
8101 * than 0.5 over a given item will highlight it specially,
8102 * signalling the gengrid has entered the reordering state. From
8103 * that time on, the user will be able to, while still holding the
8104 * mouse button down, move the item freely in the gengrid's
8105 * viewport, replacing to said item to the locations it goes to.
8106 * The replacements will be animated and, whenever the user
8107 * releases the mouse button, the item being replaced gets a new
8108 * definitive place in the grid.
8110 * @see elm_gengrid_reorder_mode_get()
8114 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8117 * Get whether a given gengrid widget is or not able have items
8120 * @param obj The gengrid object
8121 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8124 * @see elm_gengrid_reorder_mode_set() for more details
8128 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8131 * Append a new item in a given gengrid widget.
8133 * @param obj The gengrid object.
8134 * @param gic The item class for the item.
8135 * @param data The item data.
8136 * @param func Convenience function called when the item is
8138 * @param func_data Data to be passed to @p func.
8139 * @return A handle to the item added or @c NULL, on errors.
8141 * This adds an item to the beginning of the gengrid.
8143 * @see elm_gengrid_item_prepend()
8144 * @see elm_gengrid_item_insert_before()
8145 * @see elm_gengrid_item_insert_after()
8146 * @see elm_gengrid_item_del()
8150 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);
8153 * Prepend a new item in a given gengrid widget.
8155 * @param obj The gengrid object.
8156 * @param gic The item class for the item.
8157 * @param data The item data.
8158 * @param func Convenience function called when the item is
8160 * @param func_data Data to be passed to @p func.
8161 * @return A handle to the item added or @c NULL, on errors.
8163 * This adds an item to the end of the gengrid.
8165 * @see elm_gengrid_item_append()
8166 * @see elm_gengrid_item_insert_before()
8167 * @see elm_gengrid_item_insert_after()
8168 * @see elm_gengrid_item_del()
8172 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);
8175 * Insert an item before another in a gengrid widget
8177 * @param obj The gengrid object.
8178 * @param gic The item class for the item.
8179 * @param data The item data.
8180 * @param relative The item to place this new one before.
8181 * @param func Convenience function called when the item is
8183 * @param func_data Data to be passed to @p func.
8184 * @return A handle to the item added or @c NULL, on errors.
8186 * This inserts an item before another in the gengrid.
8188 * @see elm_gengrid_item_append()
8189 * @see elm_gengrid_item_prepend()
8190 * @see elm_gengrid_item_insert_after()
8191 * @see elm_gengrid_item_del()
8195 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);
8198 * Insert an item after another in a gengrid widget
8200 * @param obj The gengrid object.
8201 * @param gic The item class for the item.
8202 * @param data The item data.
8203 * @param relative The item to place this new one after.
8204 * @param func Convenience function called when the item is
8206 * @param func_data Data to be passed to @p func.
8207 * @return A handle to the item added or @c NULL, on errors.
8209 * This inserts an item after another in the gengrid.
8211 * @see elm_gengrid_item_append()
8212 * @see elm_gengrid_item_prepend()
8213 * @see elm_gengrid_item_insert_after()
8214 * @see elm_gengrid_item_del()
8218 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);
8221 * Insert an item in a gengrid widget using a user-defined sort function.
8223 * @param obj The gengrid object.
8224 * @param gic The item class for the item.
8225 * @param data The item data.
8226 * @param comp User defined comparison function that defines the sort order based on
8227 * Elm_Gen_Item and its data param.
8228 * @param func Convenience function called when the item is selected.
8229 * @param func_data Data to be passed to @p func.
8230 * @return A handle to the item added or @c NULL, on errors.
8232 * This inserts an item in the gengrid based on user defined comparison function.
8234 * @see elm_gengrid_item_append()
8235 * @see elm_gengrid_item_prepend()
8236 * @see elm_gengrid_item_insert_after()
8237 * @see elm_gengrid_item_del()
8238 * @see elm_gengrid_item_direct_sorted_insert()
8242 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);
8245 * Insert an item in a gengrid widget using a user-defined sort function.
8247 * @param obj The gengrid object.
8248 * @param gic The item class for the item.
8249 * @param data The item data.
8250 * @param comp User defined comparison function that defines the sort order based on
8252 * @param func Convenience function called when the item is selected.
8253 * @param func_data Data to be passed to @p func.
8254 * @return A handle to the item added or @c NULL, on errors.
8256 * This inserts an item in the gengrid based on user defined comparison function.
8258 * @see elm_gengrid_item_append()
8259 * @see elm_gengrid_item_prepend()
8260 * @see elm_gengrid_item_insert_after()
8261 * @see elm_gengrid_item_del()
8262 * @see elm_gengrid_item_sorted_insert()
8266 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);
8269 * Set whether items on a given gengrid widget are to get their
8270 * selection callbacks issued for @b every subsequent selection
8271 * click on them or just for the first click.
8273 * @param obj The gengrid object
8274 * @param always_select @c EINA_TRUE to make items "always
8275 * selected", @c EINA_FALSE, otherwise
8277 * By default, grid items will only call their selection callback
8278 * function when firstly getting selected, any subsequent further
8279 * clicks will do nothing. With this call, you make those
8280 * subsequent clicks also to issue the selection callbacks.
8282 * @note <b>Double clicks</b> will @b always be reported on items.
8284 * @see elm_gengrid_always_select_mode_get()
8288 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8291 * Get whether items on a given gengrid widget have their selection
8292 * callbacks issued for @b every subsequent selection click on them
8293 * or just for the first click.
8295 * @param obj The gengrid object.
8296 * @return @c EINA_TRUE if the gengrid items are "always selected",
8297 * @c EINA_FALSE, otherwise
8299 * @see elm_gengrid_always_select_mode_set() for more details
8303 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8306 * Set whether items on a given gengrid widget can be selected or not.
8308 * @param obj The gengrid object
8309 * @param no_select @c EINA_TRUE to make items selectable,
8310 * @c EINA_FALSE otherwise
8312 * This will make items in @p obj selectable or not. In the latter
8313 * case, any user interaction on the gengrid items will neither make
8314 * them appear selected nor them call their selection callback
8317 * @see elm_gengrid_no_select_mode_get()
8321 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8324 * Get whether items on a given gengrid widget can be selected or
8327 * @param obj The gengrid object
8328 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8331 * @see elm_gengrid_no_select_mode_set() for more details
8335 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8338 * Enable or disable multi-selection in a given gengrid widget
8340 * @param obj The gengrid object.
8341 * @param multi @c EINA_TRUE, to enable multi-selection,
8342 * @c EINA_FALSE to disable it.
8344 * Multi-selection is the ability to have @b more than one
8345 * item selected, on a given gengrid, simultaneously. When it is
8346 * enabled, a sequence of clicks on different items will make them
8347 * all selected, progressively. A click on an already selected item
8348 * will unselect it. If interacting via the keyboard,
8349 * multi-selection is enabled while holding the "Shift" key.
8351 * @note By default, multi-selection is @b disabled on gengrids
8353 * @see elm_gengrid_multi_select_get()
8357 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8360 * Get whether multi-selection is enabled or disabled for a given
8363 * @param obj The gengrid object.
8364 * @return @c EINA_TRUE, if multi-selection is enabled, @c
8365 * EINA_FALSE otherwise
8367 * @see elm_gengrid_multi_select_set() for more details
8371 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8374 * Enable or disable bouncing effect for a given gengrid widget
8376 * @param obj The gengrid object
8377 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8378 * @c EINA_FALSE to disable it
8379 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8380 * @c EINA_FALSE to disable it
8382 * The bouncing effect occurs whenever one reaches the gengrid's
8383 * edge's while panning it -- it will scroll past its limits a
8384 * little bit and return to the edge again, in a animated for,
8387 * @note By default, gengrids have bouncing enabled on both axis
8389 * @see elm_gengrid_bounce_get()
8393 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8396 * Get whether bouncing effects are enabled or disabled, for a
8397 * given gengrid widget, on each axis
8399 * @param obj The gengrid object
8400 * @param h_bounce Pointer to a variable where to store the
8401 * horizontal bouncing flag.
8402 * @param v_bounce Pointer to a variable where to store the
8403 * vertical bouncing flag.
8405 * @see elm_gengrid_bounce_set() for more details
8409 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8412 * Set a given gengrid widget's scrolling page size, relative to
8413 * its viewport size.
8415 * @param obj The gengrid object
8416 * @param h_pagerel The horizontal page (relative) size
8417 * @param v_pagerel The vertical page (relative) size
8419 * The gengrid's scroller is capable of binding scrolling by the
8420 * user to "pages". It means that, while scrolling and, specially
8421 * after releasing the mouse button, the grid will @b snap to the
8422 * nearest displaying page's area. When page sizes are set, the
8423 * grid's continuous content area is split into (equal) page sized
8426 * This function sets the size of a page <b>relatively to the
8427 * viewport dimensions</b> of the gengrid, for each axis. A value
8428 * @c 1.0 means "the exact viewport's size", in that axis, while @c
8429 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8430 * a viewport". Sane usable values are, than, between @c 0.0 and @c
8431 * 1.0. Values beyond those will make it behave behave
8432 * inconsistently. If you only want one axis to snap to pages, use
8433 * the value @c 0.0 for the other one.
8435 * There is a function setting page size values in @b absolute
8436 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8437 * is mutually exclusive to this one.
8439 * @see elm_gengrid_page_relative_get()
8443 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8446 * Get a given gengrid widget's scrolling page size, relative to
8447 * its viewport size.
8449 * @param obj The gengrid object
8450 * @param h_pagerel Pointer to a variable where to store the
8451 * horizontal page (relative) size
8452 * @param v_pagerel Pointer to a variable where to store the
8453 * vertical page (relative) size
8455 * @see elm_gengrid_page_relative_set() for more details
8459 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8462 * Set a given gengrid widget's scrolling page size
8464 * @param obj The gengrid object
8465 * @param h_pagerel The horizontal page size, in pixels
8466 * @param v_pagerel The vertical page size, in pixels
8468 * The gengrid's scroller is capable of binding scrolling by the
8469 * user to "pages". It means that, while scrolling and, specially
8470 * after releasing the mouse button, the grid will @b snap to the
8471 * nearest displaying page's area. When page sizes are set, the
8472 * grid's continuous content area is split into (equal) page sized
8475 * This function sets the size of a page of the gengrid, in pixels,
8476 * for each axis. Sane usable values are, between @c 0 and the
8477 * dimensions of @p obj, for each axis. Values beyond those will
8478 * make it behave behave inconsistently. If you only want one axis
8479 * to snap to pages, use the value @c 0 for the other one.
8481 * There is a function setting page size values in @b relative
8482 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8483 * use is mutually exclusive to this one.
8487 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8490 * Set the direction in which a given gengrid widget will expand while
8491 * placing its items.
8493 * @param obj The gengrid object.
8494 * @param setting @c EINA_TRUE to make the gengrid expand
8495 * horizontally, @c EINA_FALSE to expand vertically.
8497 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8498 * in @b columns, from top to bottom and, when the space for a
8499 * column is filled, another one is started on the right, thus
8500 * expanding the grid horizontally. When in "vertical mode"
8501 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8502 * to right and, when the space for a row is filled, another one is
8503 * started below, thus expanding the grid vertically.
8505 * @see elm_gengrid_horizontal_get()
8509 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8512 * Get for what direction a given gengrid widget will expand while
8513 * placing its items.
8515 * @param obj The gengrid object.
8516 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8517 * @c EINA_FALSE if it's set to expand vertically.
8519 * @see elm_gengrid_horizontal_set() for more detais
8523 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8526 * Get the first item in a given gengrid widget
8528 * @param obj The gengrid object
8529 * @return The first item's handle or @c NULL, if there are no
8530 * items in @p obj (and on errors)
8532 * This returns the first item in the @p obj's internal list of
8535 * @see elm_gengrid_last_item_get()
8539 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8542 * Get the last item in a given gengrid widget
8544 * @param obj The gengrid object
8545 * @return The last item's handle or @c NULL, if there are no
8546 * items in @p obj (and on errors)
8548 * This returns the last item in the @p obj's internal list of
8551 * @see elm_gengrid_first_item_get()
8555 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8558 * Get the @b next item in a gengrid widget's internal list of items,
8559 * given a handle to one of those items.
8561 * @param item The gengrid item to fetch next from
8562 * @return The item after @p item, or @c NULL if there's none (and
8565 * This returns the item placed after the @p item, on the container
8568 * @see elm_gengrid_item_prev_get()
8572 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8575 * Get the @b previous item in a gengrid widget's internal list of items,
8576 * given a handle to one of those items.
8578 * @param item The gengrid item to fetch previous from
8579 * @return The item before @p item, or @c NULL if there's none (and
8582 * This returns the item placed before the @p item, on the container
8585 * @see elm_gengrid_item_next_get()
8589 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8592 * Get the gengrid object's handle which contains a given gengrid
8595 * @param item The item to fetch the container from
8596 * @return The gengrid (parent) object
8598 * This returns the gengrid object itself that an item belongs to.
8602 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8605 * Remove a gengrid item from its parent, deleting it.
8607 * @param item The item to be removed.
8608 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8610 * @see elm_gengrid_clear(), to remove all items in a gengrid at
8615 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8618 * Update the contents of a given gengrid item
8620 * @param item The gengrid item
8622 * This updates an item by calling all the item class functions
8623 * again to get the contents, labels and states. Use this when the
8624 * original item data has changed and you want the changes to be
8629 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8632 * Get the Gengrid Item class for the given Gengrid Item.
8634 * @param item The gengrid item
8636 * This returns the Gengrid_Item_Class for the given item. It can be used to examine
8637 * the function pointers and item_style.
8641 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8644 * Get the Gengrid Item class for the given Gengrid Item.
8646 * This sets the Gengrid_Item_Class for the given item. It can be used to examine
8647 * the function pointers and item_style.
8649 * @param item The gengrid item
8650 * @param gic The gengrid item class describing the function pointers and the item style.
8654 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
8657 * Return the data associated to a given gengrid item
8659 * @param item The gengrid item.
8660 * @return the data associated with this item.
8662 * This returns the @c data value passed on the
8663 * elm_gengrid_item_append() and related item addition calls.
8665 * @see elm_gengrid_item_append()
8666 * @see elm_gengrid_item_data_set()
8670 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8673 * Set the data associated with a given gengrid item
8675 * @param item The gengrid item
8676 * @param data The data pointer to set on it
8678 * This @b overrides the @c data value passed on the
8679 * elm_gengrid_item_append() and related item addition calls. This
8680 * function @b won't call elm_gengrid_item_update() automatically,
8681 * so you'd issue it afterwards if you want to have the item
8682 * updated to reflect the new data.
8684 * @see elm_gengrid_item_data_get()
8685 * @see elm_gengrid_item_update()
8689 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
8692 * Get a given gengrid item's position, relative to the whole
8693 * gengrid's grid area.
8695 * @param item The Gengrid item.
8696 * @param x Pointer to variable to store the item's <b>row number</b>.
8697 * @param y Pointer to variable to store the item's <b>column number</b>.
8699 * This returns the "logical" position of the item within the
8700 * gengrid. For example, @c (0, 1) would stand for first row,
8705 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
8708 * Set whether a given gengrid item is selected or not
8710 * @param item The gengrid item
8711 * @param selected Use @c EINA_TRUE, to make it selected, @c
8712 * EINA_FALSE to make it unselected
8714 * This sets the selected state of an item. If multi-selection is
8715 * not enabled on the containing gengrid and @p selected is @c
8716 * EINA_TRUE, any other previously selected items will get
8717 * unselected in favor of this new one.
8719 * @see elm_gengrid_item_selected_get()
8723 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
8726 * Get whether a given gengrid item is selected or not
8728 * @param item The gengrid item
8729 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
8731 * This API returns EINA_TRUE for all the items selected in multi-select mode as well.
8733 * @see elm_gengrid_item_selected_set() for more details
8737 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8740 * Get the real Evas object created to implement the view of a
8741 * given gengrid item
8743 * @param item The gengrid item.
8744 * @return the Evas object implementing this item's view.
8746 * This returns the actual Evas object used to implement the
8747 * specified gengrid item's view. This may be @c NULL, as it may
8748 * not have been created or may have been deleted, at any time, by
8749 * the gengrid. <b>Do not modify this object</b> (move, resize,
8750 * show, hide, etc.), as the gengrid is controlling it. This
8751 * function is for querying, emitting custom signals or hooking
8752 * lower level callbacks for events on that object. Do not delete
8753 * this object under any circumstances.
8755 * @see elm_gengrid_item_data_get()
8759 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8762 * Show the portion of a gengrid's internal grid containing a given
8763 * item, @b immediately.
8765 * @param item The item to display
8767 * This causes gengrid to @b redraw its viewport's contents to the
8768 * region contining the given @p item item, if it is not fully
8771 * @see elm_gengrid_item_bring_in()
8775 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8778 * Animatedly bring in, to the visible area of a gengrid, a given
8781 * @param item The gengrid item to display
8783 * This causes gengrid to jump to the given @p item and show
8784 * it (by scrolling), if it is not fully visible. This will use
8785 * animation to do so and take a period of time to complete.
8787 * @see elm_gengrid_item_show()
8791 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8794 * Set whether a given gengrid item is disabled or not.
8796 * @param item The gengrid item
8797 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
8798 * to enable it back.
8800 * A disabled item cannot be selected or unselected. It will also
8801 * change its appearance, to signal the user it's disabled.
8803 * @see elm_gengrid_item_disabled_get()
8807 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
8810 * Get whether a given gengrid item is disabled or not.
8812 * @param item The gengrid item
8813 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
8816 * @see elm_gengrid_item_disabled_set() for more details
8820 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8823 * Set the text to be shown in a given gengrid item's tooltips.
8825 * @param item The gengrid item
8826 * @param text The text to set in the content
8828 * This call will setup the text to be used as tooltip to that item
8829 * (analogous to elm_object_tooltip_text_set(), but being item
8830 * tooltips with higher precedence than object tooltips). It can
8831 * have only one tooltip at a time, so any previous tooltip data
8836 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
8839 * Set the content to be shown in a given gengrid item's tooltip
8841 * @param item The gengrid item.
8842 * @param func The function returning the tooltip contents.
8843 * @param data What to provide to @a func as callback data/context.
8844 * @param del_cb Called when data is not needed anymore, either when
8845 * another callback replaces @p func, the tooltip is unset with
8846 * elm_gengrid_item_tooltip_unset() or the owner @p item
8847 * dies. This callback receives as its first parameter the
8848 * given @p data, being @c event_info the item handle.
8850 * This call will setup the tooltip's contents to @p item
8851 * (analogous to elm_object_tooltip_content_cb_set(), but being
8852 * item tooltips with higher precedence than object tooltips). It
8853 * can have only one tooltip at a time, so any previous tooltip
8854 * content will get removed. @p func (with @p data) will be called
8855 * every time Elementary needs to show the tooltip and it should
8856 * return a valid Evas object, which will be fully managed by the
8857 * tooltip system, getting deleted when the tooltip is gone.
8861 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);
8864 * Unset a tooltip from a given gengrid item
8866 * @param item gengrid item to remove a previously set tooltip from.
8868 * This call removes any tooltip set on @p item. The callback
8869 * provided as @c del_cb to
8870 * elm_gengrid_item_tooltip_content_cb_set() will be called to
8871 * notify it is not used anymore (and have resources cleaned, if
8874 * @see elm_gengrid_item_tooltip_content_cb_set()
8878 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8881 * Set a different @b style for a given gengrid item's tooltip.
8883 * @param item gengrid item with tooltip set
8884 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
8885 * "default", @c "transparent", etc)
8887 * Tooltips can have <b>alternate styles</b> to be displayed on,
8888 * which are defined by the theme set on Elementary. This function
8889 * works analogously as elm_object_tooltip_style_set(), but here
8890 * applied only to gengrid item objects. The default style for
8891 * tooltips is @c "default".
8893 * @note before you set a style you should define a tooltip with
8894 * elm_gengrid_item_tooltip_content_cb_set() or
8895 * elm_gengrid_item_tooltip_text_set()
8897 * @see elm_gengrid_item_tooltip_style_get()
8901 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
8904 * Get the style set a given gengrid item's tooltip.
8906 * @param item gengrid item with tooltip already set on.
8907 * @return style the theme style in use, which defaults to
8908 * "default". If the object does not have a tooltip set,
8909 * then @c NULL is returned.
8911 * @see elm_gengrid_item_tooltip_style_set() for more details
8915 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8917 * Set the type of mouse pointer/cursor decoration to be shown,
8918 * when the mouse pointer is over the given gengrid widget item
8920 * @param item gengrid item to customize cursor on
8921 * @param cursor the cursor type's name
8923 * This function works analogously as elm_object_cursor_set(), but
8924 * here the cursor's changing area is restricted to the item's
8925 * area, and not the whole widget's. Note that that item cursors
8926 * have precedence over widget cursors, so that a mouse over @p
8927 * item will always show cursor @p type.
8929 * If this function is called twice for an object, a previously set
8930 * cursor will be unset on the second call.
8932 * @see elm_object_cursor_set()
8933 * @see elm_gengrid_item_cursor_get()
8934 * @see elm_gengrid_item_cursor_unset()
8938 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
8941 * Get the type of mouse pointer/cursor decoration set to be shown,
8942 * when the mouse pointer is over the given gengrid widget item
8944 * @param item gengrid item with custom cursor set
8945 * @return the cursor type's name or @c NULL, if no custom cursors
8946 * were set to @p item (and on errors)
8948 * @see elm_object_cursor_get()
8949 * @see elm_gengrid_item_cursor_set() for more details
8950 * @see elm_gengrid_item_cursor_unset()
8954 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8957 * Unset any custom mouse pointer/cursor decoration set to be
8958 * shown, when the mouse pointer is over the given gengrid widget
8959 * item, thus making it show the @b default cursor again.
8961 * @param item a gengrid item
8963 * Use this call to undo any custom settings on this item's cursor
8964 * decoration, bringing it back to defaults (no custom style set).
8966 * @see elm_object_cursor_unset()
8967 * @see elm_gengrid_item_cursor_set() for more details
8971 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8974 * Set a different @b style for a given custom cursor set for a
8977 * @param item gengrid item with custom cursor set
8978 * @param style the <b>theme style</b> to use (e.g. @c "default",
8979 * @c "transparent", etc)
8981 * This function only makes sense when one is using custom mouse
8982 * cursor decorations <b>defined in a theme file</b> , which can
8983 * have, given a cursor name/type, <b>alternate styles</b> on
8984 * it. It works analogously as elm_object_cursor_style_set(), but
8985 * here applied only to gengrid item objects.
8987 * @warning Before you set a cursor style you should have defined a
8988 * custom cursor previously on the item, with
8989 * elm_gengrid_item_cursor_set()
8991 * @see elm_gengrid_item_cursor_engine_only_set()
8992 * @see elm_gengrid_item_cursor_style_get()
8996 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
8999 * Get the current @b style set for a given gengrid item's custom
9002 * @param item gengrid item with custom cursor set.
9003 * @return style the cursor style in use. If the object does not
9004 * have a cursor set, then @c NULL is returned.
9006 * @see elm_gengrid_item_cursor_style_set() for more details
9010 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9013 * Set if the (custom) cursor for a given gengrid item should be
9014 * searched in its theme, also, or should only rely on the
9017 * @param item item with custom (custom) cursor already set on
9018 * @param engine_only Use @c EINA_TRUE to have cursors looked for
9019 * only on those provided by the rendering engine, @c EINA_FALSE to
9020 * have them searched on the widget's theme, as well.
9022 * @note This call is of use only if you've set a custom cursor
9023 * for gengrid items, with elm_gengrid_item_cursor_set().
9025 * @note By default, cursors will only be looked for between those
9026 * provided by the rendering engine.
9030 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9033 * Get if the (custom) cursor for a given gengrid item is being
9034 * searched in its theme, also, or is only relying on the rendering
9037 * @param item a gengrid item
9038 * @return @c EINA_TRUE, if cursors are being looked for only on
9039 * those provided by the rendering engine, @c EINA_FALSE if they
9040 * are being searched on the widget's theme, as well.
9042 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
9046 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9049 * Remove all items from a given gengrid widget
9051 * @param obj The gengrid object.
9053 * This removes (and deletes) all items in @p obj, leaving it
9056 * @see elm_gengrid_item_del(), to remove just one item.
9060 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9063 * Get the selected item in a given gengrid widget
9065 * @param obj The gengrid object.
9066 * @return The selected item's handleor @c NULL, if none is
9067 * selected at the moment (and on errors)
9069 * This returns the selected item in @p obj. If multi selection is
9070 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
9071 * the first item in the list is selected, which might not be very
9072 * useful. For that case, see elm_gengrid_selected_items_get().
9076 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9079 * Get <b>a list</b> of selected items in a given gengrid
9081 * @param obj The gengrid object.
9082 * @return The list of selected items or @c NULL, if none is
9083 * selected at the moment (and on errors)
9085 * This returns a list of the selected items, in the order that
9086 * they appear in the grid. This list is only valid as long as no
9087 * more items are selected or unselected (or unselected implictly
9088 * by deletion). The list contains #Elm_Gengrid_Item pointers as
9091 * @see elm_gengrid_selected_item_get()
9095 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9102 * @defgroup Clock Clock
9104 * This is a @b digital clock widget. In its default theme, it has a
9105 * vintage "flipping numbers clock" appearance, which will animate
9106 * sheets of individual algarisms individually as time goes by.
9108 * A newly created clock will fetch system's time (already
9109 * considering local time adjustments) to start with, and will tick
9110 * accondingly. It may or may not show seconds.
9112 * Clocks have an @b edition mode. When in it, the sheets will
9113 * display extra arrow indications on the top and bottom and the
9114 * user may click on them to raise or lower the time values. After
9115 * it's told to exit edition mode, it will keep ticking with that
9116 * new time set (it keeps the difference from local time).
9118 * Also, when under edition mode, user clicks on the cited arrows
9119 * which are @b held for some time will make the clock to flip the
9120 * sheet, thus editing the time, continuosly and automatically for
9121 * the user. The interval between sheet flips will keep growing in
9122 * time, so that it helps the user to reach a time which is distant
9125 * The time display is, by default, in military mode (24h), but an
9126 * am/pm indicator may be optionally shown, too, when it will
9129 * Smart callbacks one can register to:
9130 * - "changed" - the clock's user changed the time
9132 * Here is an example on its usage:
9133 * @li @ref clock_example
9142 * Identifiers for which clock digits should be editable, when a
9143 * clock widget is in edition mode. Values may be ORed together to
9144 * make a mask, naturally.
9146 * @see elm_clock_edit_set()
9147 * @see elm_clock_digit_edit_set()
9149 typedef enum _Elm_Clock_Digedit
9151 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9152 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9153 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
9154 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9155 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
9156 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9157 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
9158 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
9159 } Elm_Clock_Digedit;
9162 * Add a new clock widget to the given parent Elementary
9163 * (container) object
9165 * @param parent The parent object
9166 * @return a new clock widget handle or @c NULL, on errors
9168 * This function inserts a new clock widget on the canvas.
9172 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9175 * Set a clock widget's time, programmatically
9177 * @param obj The clock widget object
9178 * @param hrs The hours to set
9179 * @param min The minutes to set
9180 * @param sec The secondes to set
9182 * This function updates the time that is showed by the clock
9185 * Values @b must be set within the following ranges:
9186 * - 0 - 23, for hours
9187 * - 0 - 59, for minutes
9188 * - 0 - 59, for seconds,
9190 * even if the clock is not in "military" mode.
9192 * @warning The behavior for values set out of those ranges is @b
9197 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9200 * Get a clock widget's time values
9202 * @param obj The clock object
9203 * @param[out] hrs Pointer to the variable to get the hours value
9204 * @param[out] min Pointer to the variable to get the minutes value
9205 * @param[out] sec Pointer to the variable to get the seconds value
9207 * This function gets the time set for @p obj, returning
9208 * it on the variables passed as the arguments to function
9210 * @note Use @c NULL pointers on the time values you're not
9211 * interested in: they'll be ignored by the function.
9215 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9218 * Set whether a given clock widget is under <b>edition mode</b> or
9219 * under (default) displaying-only mode.
9221 * @param obj The clock object
9222 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9223 * put it back to "displaying only" mode
9225 * This function makes a clock's time to be editable or not <b>by
9226 * user interaction</b>. When in edition mode, clocks @b stop
9227 * ticking, until one brings them back to canonical mode. The
9228 * elm_clock_digit_edit_set() function will influence which digits
9229 * of the clock will be editable. By default, all of them will be
9230 * (#ELM_CLOCK_NONE).
9232 * @note am/pm sheets, if being shown, will @b always be editable
9233 * under edition mode.
9235 * @see elm_clock_edit_get()
9239 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9242 * Retrieve whether a given clock widget is under <b>edition
9243 * mode</b> or under (default) displaying-only mode.
9245 * @param obj The clock object
9246 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9249 * This function retrieves whether the clock's time can be edited
9250 * or not by user interaction.
9252 * @see elm_clock_edit_set() for more details
9256 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9259 * Set what digits of the given clock widget should be editable
9260 * when in edition mode.
9262 * @param obj The clock object
9263 * @param digedit Bit mask indicating the digits to be editable
9264 * (values in #Elm_Clock_Digedit).
9266 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9267 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9270 * @see elm_clock_digit_edit_get()
9274 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9277 * Retrieve what digits of the given clock widget should be
9278 * editable when in edition mode.
9280 * @param obj The clock object
9281 * @return Bit mask indicating the digits to be editable
9282 * (values in #Elm_Clock_Digedit).
9284 * @see elm_clock_digit_edit_set() for more details
9288 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9291 * Set if the given clock widget must show hours in military or
9294 * @param obj The clock object
9295 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9298 * This function sets if the clock must show hours in military or
9299 * am/pm mode. In some countries like Brazil the military mode
9300 * (00-24h-format) is used, in opposition to the USA, where the
9301 * am/pm mode is more commonly used.
9303 * @see elm_clock_show_am_pm_get()
9307 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9310 * Get if the given clock widget shows hours in military or am/pm
9313 * @param obj The clock object
9314 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9317 * This function gets if the clock shows hours in military or am/pm
9320 * @see elm_clock_show_am_pm_set() for more details
9324 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9327 * Set if the given clock widget must show time with seconds or not
9329 * @param obj The clock object
9330 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9332 * This function sets if the given clock must show or not elapsed
9333 * seconds. By default, they are @b not shown.
9335 * @see elm_clock_show_seconds_get()
9339 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9342 * Get whether the given clock widget is showing time with seconds
9345 * @param obj The clock object
9346 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9348 * This function gets whether @p obj is showing or not the elapsed
9351 * @see elm_clock_show_seconds_set()
9355 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9358 * Set the interval on time updates for an user mouse button hold
9359 * on clock widgets' time edition.
9361 * @param obj The clock object
9362 * @param interval The (first) interval value in seconds
9364 * This interval value is @b decreased while the user holds the
9365 * mouse pointer either incrementing or decrementing a given the
9366 * clock digit's value.
9368 * This helps the user to get to a given time distant from the
9369 * current one easier/faster, as it will start to flip quicker and
9370 * quicker on mouse button holds.
9372 * The calculation for the next flip interval value, starting from
9373 * the one set with this call, is the previous interval divided by
9374 * 1.05, so it decreases a little bit.
9376 * The default starting interval value for automatic flips is
9379 * @see elm_clock_interval_get()
9383 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9386 * Get the interval on time updates for an user mouse button hold
9387 * on clock widgets' time edition.
9389 * @param obj The clock object
9390 * @return The (first) interval value, in seconds, set on it
9392 * @see elm_clock_interval_set() for more details
9396 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9403 * @defgroup Layout Layout
9405 * @image html img/widget/layout/preview-00.png
9406 * @image latex img/widget/layout/preview-00.eps width=\textwidth
9408 * @image html img/layout-predefined.png
9409 * @image latex img/layout-predefined.eps width=\textwidth
9411 * This is a container widget that takes a standard Edje design file and
9412 * wraps it very thinly in a widget.
9414 * An Edje design (theme) file has a very wide range of possibilities to
9415 * describe the behavior of elements added to the Layout. Check out the Edje
9416 * documentation and the EDC reference to get more information about what can
9417 * be done with Edje.
9419 * Just like @ref List, @ref Box, and other container widgets, any
9420 * object added to the Layout will become its child, meaning that it will be
9421 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9423 * The Layout widget can contain as many Contents, Boxes or Tables as
9424 * described in its theme file. For instance, objects can be added to
9425 * different Tables by specifying the respective Table part names. The same
9426 * is valid for Content and Box.
9428 * The objects added as child of the Layout will behave as described in the
9429 * part description where they were added. There are 3 possible types of
9430 * parts where a child can be added:
9432 * @section secContent Content (SWALLOW part)
9434 * Only one object can be added to the @c SWALLOW part (but you still can
9435 * have many @c SWALLOW parts and one object on each of them). Use the @c
9436 * elm_object_content_set/get/unset functions to set, retrieve and unset
9437 * objects as content of the @c SWALLOW. After being set to this part, the
9438 * object size, position, visibility, clipping and other description
9439 * properties will be totally controled by the description of the given part
9440 * (inside the Edje theme file).
9442 * One can use @c evas_object_size_hint_* functions on the child to have some
9443 * kind of control over its behavior, but the resulting behavior will still
9444 * depend heavily on the @c SWALLOW part description.
9446 * The Edje theme also can change the part description, based on signals or
9447 * scripts running inside the theme. This change can also be animated. All of
9448 * this will affect the child object set as content accordingly. The object
9449 * size will be changed if the part size is changed, it will animate move if
9450 * the part is moving, and so on.
9452 * The following picture demonstrates a Layout widget with a child object
9453 * added to its @c SWALLOW:
9455 * @image html layout_swallow.png
9456 * @image latex layout_swallow.eps width=\textwidth
9458 * @section secBox Box (BOX part)
9460 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9461 * allows one to add objects to the box and have them distributed along its
9462 * area, accordingly to the specified @a layout property (now by @a layout we
9463 * mean the chosen layouting design of the Box, not the Layout widget
9466 * A similar effect for having a box with its position, size and other things
9467 * controled by the Layout theme would be to create an Elementary @ref Box
9468 * widget and add it as a Content in the @c SWALLOW part.
9470 * The main difference of using the Layout Box is that its behavior, the box
9471 * properties like layouting format, padding, align, etc. will be all
9472 * controled by the theme. This means, for example, that a signal could be
9473 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9474 * handled the signal by changing the box padding, or align, or both. Using
9475 * the Elementary @ref Box widget is not necessarily harder or easier, it
9476 * just depends on the circunstances and requirements.
9478 * The Layout Box can be used through the @c elm_layout_box_* set of
9481 * The following picture demonstrates a Layout widget with many child objects
9482 * added to its @c BOX part:
9484 * @image html layout_box.png
9485 * @image latex layout_box.eps width=\textwidth
9487 * @section secTable Table (TABLE part)
9489 * Just like the @ref secBox, the Layout Table is very similar to the
9490 * Elementary @ref Table widget. It allows one to add objects to the Table
9491 * specifying the row and column where the object should be added, and any
9492 * column or row span if necessary.
9494 * Again, we could have this design by adding a @ref Table widget to the @c
9495 * SWALLOW part using elm_object_content_part_set(). The same difference happens
9496 * here when choosing to use the Layout Table (a @c TABLE part) instead of
9497 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9499 * The Layout Table can be used through the @c elm_layout_table_* set of
9502 * The following picture demonstrates a Layout widget with many child objects
9503 * added to its @c TABLE part:
9505 * @image html layout_table.png
9506 * @image latex layout_table.eps width=\textwidth
9508 * @section secPredef Predefined Layouts
9510 * Another interesting thing about the Layout widget is that it offers some
9511 * predefined themes that come with the default Elementary theme. These
9512 * themes can be set by the call elm_layout_theme_set(), and provide some
9513 * basic functionality depending on the theme used.
9515 * Most of them already send some signals, some already provide a toolbar or
9516 * back and next buttons.
9518 * These are available predefined theme layouts. All of them have class = @c
9519 * layout, group = @c application, and style = one of the following options:
9521 * @li @c toolbar-content - application with toolbar and main content area
9522 * @li @c toolbar-content-back - application with toolbar and main content
9523 * area with a back button and title area
9524 * @li @c toolbar-content-back-next - application with toolbar and main
9525 * content area with a back and next buttons and title area
9526 * @li @c content-back - application with a main content area with a back
9527 * button and title area
9528 * @li @c content-back-next - application with a main content area with a
9529 * back and next buttons and title area
9530 * @li @c toolbar-vbox - application with toolbar and main content area as a
9532 * @li @c toolbar-table - application with toolbar and main content area as a
9535 * @section secExamples Examples
9537 * Some examples of the Layout widget can be found here:
9538 * @li @ref layout_example_01
9539 * @li @ref layout_example_02
9540 * @li @ref layout_example_03
9541 * @li @ref layout_example_edc
9546 * Add a new layout to the parent
9548 * @param parent The parent object
9549 * @return The new object or NULL if it cannot be created
9551 * @see elm_layout_file_set()
9552 * @see elm_layout_theme_set()
9556 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9558 * Set the file that will be used as layout
9560 * @param obj The layout object
9561 * @param file The path to file (edj) that will be used as layout
9562 * @param group The group that the layout belongs in edje file
9564 * @return (1 = success, 0 = error)
9568 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9570 * Set the edje group from the elementary theme that will be used as layout
9572 * @param obj The layout object
9573 * @param clas the clas of the group
9574 * @param group the group
9575 * @param style the style to used
9577 * @return (1 = success, 0 = error)
9581 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9583 * Set the layout content.
9585 * @param obj The layout object
9586 * @param swallow The swallow part name in the edje file
9587 * @param content The child that will be added in this layout object
9589 * Once the content object is set, a previously set one will be deleted.
9590 * If you want to keep that old content object, use the
9591 * elm_object_content_part_unset() function.
9593 * @note In an Edje theme, the part used as a content container is called @c
9594 * SWALLOW. This is why the parameter name is called @p swallow, but it is
9595 * expected to be a part name just like the second parameter of
9596 * elm_layout_box_append().
9598 * @see elm_layout_box_append()
9599 * @see elm_object_content_part_get()
9600 * @see elm_object_content_part_unset()
9605 EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9607 * Get the child object in the given content part.
9609 * @param obj The layout object
9610 * @param swallow The SWALLOW part to get its content
9612 * @return The swallowed object or NULL if none or an error occurred
9614 * @see elm_object_content_part_set()
9618 EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9620 * Unset the layout content.
9622 * @param obj The layout object
9623 * @param swallow The swallow part name in the edje file
9624 * @return The content that was being used
9626 * Unparent and return the content object which was set for this part.
9628 * @see elm_object_content_part_set()
9632 EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9634 * Set the text of the given part
9636 * @param obj The layout object
9637 * @param part The TEXT part where to set the text
9638 * @param text The text to set
9641 * @deprecated use elm_object_text_* instead.
9643 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
9645 * Get the text set in the given part
9647 * @param obj The layout object
9648 * @param part The TEXT part to retrieve the text off
9650 * @return The text set in @p part
9653 * @deprecated use elm_object_text_* instead.
9655 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
9657 * Append child to layout box part.
9659 * @param obj the layout object
9660 * @param part the box part to which the object will be appended.
9661 * @param child the child object to append to box.
9663 * Once the object is appended, it will become child of the layout. Its
9664 * lifetime will be bound to the layout, whenever the layout dies the child
9665 * will be deleted automatically. One should use elm_layout_box_remove() to
9666 * make this layout forget about the object.
9668 * @see elm_layout_box_prepend()
9669 * @see elm_layout_box_insert_before()
9670 * @see elm_layout_box_insert_at()
9671 * @see elm_layout_box_remove()
9675 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9677 * Prepend child to layout box part.
9679 * @param obj the layout object
9680 * @param part the box part to prepend.
9681 * @param child the child object to prepend to box.
9683 * Once the object is prepended, it will become child of the layout. Its
9684 * lifetime will be bound to the layout, whenever the layout dies the child
9685 * will be deleted automatically. One should use elm_layout_box_remove() to
9686 * make this layout forget about the object.
9688 * @see elm_layout_box_append()
9689 * @see elm_layout_box_insert_before()
9690 * @see elm_layout_box_insert_at()
9691 * @see elm_layout_box_remove()
9695 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9697 * Insert child to layout box part before a reference object.
9699 * @param obj the layout object
9700 * @param part the box part to insert.
9701 * @param child the child object to insert into box.
9702 * @param reference another reference object to insert before in box.
9704 * Once the object is inserted, it will become child of the layout. Its
9705 * lifetime will be bound to the layout, whenever the layout dies the child
9706 * will be deleted automatically. One should use elm_layout_box_remove() to
9707 * make this layout forget about the object.
9709 * @see elm_layout_box_append()
9710 * @see elm_layout_box_prepend()
9711 * @see elm_layout_box_insert_before()
9712 * @see elm_layout_box_remove()
9716 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
9718 * Insert child to layout box part at a given position.
9720 * @param obj the layout object
9721 * @param part the box part to insert.
9722 * @param child the child object to insert into box.
9723 * @param pos the numeric position >=0 to insert the child.
9725 * Once the object is inserted, it will become child of the layout. Its
9726 * lifetime will be bound to the layout, whenever the layout dies the child
9727 * will be deleted automatically. One should use elm_layout_box_remove() to
9728 * make this layout forget about the object.
9730 * @see elm_layout_box_append()
9731 * @see elm_layout_box_prepend()
9732 * @see elm_layout_box_insert_before()
9733 * @see elm_layout_box_remove()
9737 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
9739 * Remove a child of the given part box.
9741 * @param obj The layout object
9742 * @param part The box part name to remove child.
9743 * @param child The object to remove from box.
9744 * @return The object that was being used, or NULL if not found.
9746 * The object will be removed from the box part and its lifetime will
9747 * not be handled by the layout anymore. This is equivalent to
9748 * elm_object_content_part_unset() for box.
9750 * @see elm_layout_box_append()
9751 * @see elm_layout_box_remove_all()
9755 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
9757 * Remove all child of the given part box.
9759 * @param obj The layout object
9760 * @param part The box part name to remove child.
9761 * @param clear If EINA_TRUE, then all objects will be deleted as
9762 * well, otherwise they will just be removed and will be
9763 * dangling on the canvas.
9765 * The objects will be removed from the box part and their lifetime will
9766 * not be handled by the layout anymore. This is equivalent to
9767 * elm_layout_box_remove() for all box children.
9769 * @see elm_layout_box_append()
9770 * @see elm_layout_box_remove()
9774 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9776 * Insert child to layout table part.
9778 * @param obj the layout object
9779 * @param part the box part to pack child.
9780 * @param child_obj the child object to pack into table.
9781 * @param col the column to which the child should be added. (>= 0)
9782 * @param row the row to which the child should be added. (>= 0)
9783 * @param colspan how many columns should be used to store this object. (>=
9785 * @param rowspan how many rows should be used to store this object. (>= 1)
9787 * Once the object is inserted, it will become child of the table. Its
9788 * lifetime will be bound to the layout, and whenever the layout dies the
9789 * child will be deleted automatically. One should use
9790 * elm_layout_table_remove() to make this layout forget about the object.
9792 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
9793 * more space than a single cell. For instance, the following code:
9795 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
9798 * Would result in an object being added like the following picture:
9800 * @image html layout_colspan.png
9801 * @image latex layout_colspan.eps width=\textwidth
9803 * @see elm_layout_table_unpack()
9804 * @see elm_layout_table_clear()
9808 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);
9810 * Unpack (remove) a child of the given part table.
9812 * @param obj The layout object
9813 * @param part The table part name to remove child.
9814 * @param child_obj The object to remove from table.
9815 * @return The object that was being used, or NULL if not found.
9817 * The object will be unpacked from the table part and its lifetime
9818 * will not be handled by the layout anymore. This is equivalent to
9819 * elm_object_content_part_unset() for table.
9821 * @see elm_layout_table_pack()
9822 * @see elm_layout_table_clear()
9826 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
9828 * Remove all child of the given part table.
9830 * @param obj The layout object
9831 * @param part The table part name to remove child.
9832 * @param clear If EINA_TRUE, then all objects will be deleted as
9833 * well, otherwise they will just be removed and will be
9834 * dangling on the canvas.
9836 * The objects will be removed from the table part and their lifetime will
9837 * not be handled by the layout anymore. This is equivalent to
9838 * elm_layout_table_unpack() for all table children.
9840 * @see elm_layout_table_pack()
9841 * @see elm_layout_table_unpack()
9845 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9847 * Get the edje layout
9849 * @param obj The layout object
9851 * @return A Evas_Object with the edje layout settings loaded
9852 * with function elm_layout_file_set
9854 * This returns the edje object. It is not expected to be used to then
9855 * swallow objects via edje_object_part_swallow() for example. Use
9856 * elm_object_content_part_set() instead so child object handling and sizing is
9859 * @note This function should only be used if you really need to call some
9860 * low level Edje function on this edje object. All the common stuff (setting
9861 * text, emitting signals, hooking callbacks to signals, etc.) can be done
9862 * with proper elementary functions.
9864 * @see elm_object_signal_callback_add()
9865 * @see elm_object_signal_emit()
9866 * @see elm_object_text_part_set()
9867 * @see elm_object_content_part_set()
9868 * @see elm_layout_box_append()
9869 * @see elm_layout_table_pack()
9870 * @see elm_layout_data_get()
9874 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9876 * Get the edje data from the given layout
9878 * @param obj The layout object
9879 * @param key The data key
9881 * @return The edje data string
9883 * This function fetches data specified inside the edje theme of this layout.
9884 * This function return NULL if data is not found.
9886 * In EDC this comes from a data block within the group block that @p
9887 * obj was loaded from. E.g.
9894 * item: "key1" "value1";
9895 * item: "key2" "value2";
9903 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
9907 * @param obj The layout object
9909 * Manually forces a sizing re-evaluation. This is useful when the minimum
9910 * size required by the edje theme of this layout has changed. The change on
9911 * the minimum size required by the edje theme is not immediately reported to
9912 * the elementary layout, so one needs to call this function in order to tell
9913 * the widget (layout) that it needs to reevaluate its own size.
9915 * The minimum size of the theme is calculated based on minimum size of
9916 * parts, the size of elements inside containers like box and table, etc. All
9917 * of this can change due to state changes, and that's when this function
9920 * Also note that a standard signal of "size,eval" "elm" emitted from the
9921 * edje object will cause this to happen too.
9925 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
9928 * Sets a specific cursor for an edje part.
9930 * @param obj The layout object.
9931 * @param part_name a part from loaded edje group.
9932 * @param cursor cursor name to use, see Elementary_Cursor.h
9934 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9935 * part not exists or it has "mouse_events: 0".
9939 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
9942 * Get the cursor to be shown when mouse is over an edje part
9944 * @param obj The layout object.
9945 * @param part_name a part from loaded edje group.
9946 * @return the cursor name.
9950 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9953 * Unsets a cursor previously set with elm_layout_part_cursor_set().
9955 * @param obj The layout object.
9956 * @param part_name a part from loaded edje group, that had a cursor set
9957 * with elm_layout_part_cursor_set().
9961 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9964 * Sets a specific cursor style for an edje part.
9966 * @param obj The layout object.
9967 * @param part_name a part from loaded edje group.
9968 * @param style the theme style to use (default, transparent, ...)
9970 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9971 * part not exists or it did not had a cursor set.
9975 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
9978 * Gets a specific cursor style for an edje part.
9980 * @param obj The layout object.
9981 * @param part_name a part from loaded edje group.
9983 * @return the theme style in use, defaults to "default". If the
9984 * object does not have a cursor set, then NULL is returned.
9988 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9991 * Sets if the cursor set should be searched on the theme or should use
9992 * the provided by the engine, only.
9994 * @note before you set if should look on theme you should define a
9995 * cursor with elm_layout_part_cursor_set(). By default it will only
9996 * look for cursors provided by the engine.
9998 * @param obj The layout object.
9999 * @param part_name a part from loaded edje group.
10000 * @param engine_only if cursors should be just provided by the engine
10001 * or should also search on widget's theme as well
10003 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10004 * part not exists or it did not had a cursor set.
10008 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);
10011 * Gets a specific cursor engine_only for an edje part.
10013 * @param obj The layout object.
10014 * @param part_name a part from loaded edje group.
10016 * @return whenever the cursor is just provided by engine or also from theme.
10020 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10023 * @def elm_layout_icon_set
10024 * Convienience macro to set the icon object in a layout that follows the
10025 * Elementary naming convention for its parts.
10029 #define elm_layout_icon_set(_ly, _obj) \
10032 elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
10033 if ((_obj)) sig = "elm,state,icon,visible"; \
10034 else sig = "elm,state,icon,hidden"; \
10035 elm_object_signal_emit((_ly), sig, "elm"); \
10039 * @def elm_layout_icon_get
10040 * Convienience macro to get the icon object from a layout that follows the
10041 * Elementary naming convention for its parts.
10045 #define elm_layout_icon_get(_ly) \
10046 elm_layout_content_get((_ly), "elm.swallow.icon")
10049 * @def elm_layout_end_set
10050 * Convienience macro to set the end object in a layout that follows the
10051 * Elementary naming convention for its parts.
10055 #define elm_layout_end_set(_ly, _obj) \
10058 elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
10059 if ((_obj)) sig = "elm,state,end,visible"; \
10060 else sig = "elm,state,end,hidden"; \
10061 elm_object_signal_emit((_ly), sig, "elm"); \
10065 * @def elm_layout_end_get
10066 * Convienience macro to get the end object in a layout that follows the
10067 * Elementary naming convention for its parts.
10071 #define elm_layout_end_get(_ly) \
10072 elm_layout_content_get((_ly), "elm.swallow.end")
10075 * @def elm_layout_label_set
10076 * Convienience macro to set the label in a layout that follows the
10077 * Elementary naming convention for its parts.
10080 * @deprecated use elm_object_text_* instead.
10082 #define elm_layout_label_set(_ly, _txt) \
10083 elm_layout_text_set((_ly), "elm.text", (_txt))
10086 * @def elm_layout_label_get
10087 * Convenience macro to get the label in a layout that follows the
10088 * Elementary naming convention for its parts.
10091 * @deprecated use elm_object_text_* instead.
10093 #define elm_layout_label_get(_ly) \
10094 elm_layout_text_get((_ly), "elm.text")
10096 /* smart callbacks called:
10097 * "theme,changed" - when elm theme is changed.
10101 * @defgroup Notify Notify
10103 * @image html img/widget/notify/preview-00.png
10104 * @image latex img/widget/notify/preview-00.eps
10106 * Display a container in a particular region of the parent(top, bottom,
10107 * etc). A timeout can be set to automatically hide the notify. This is so
10108 * that, after an evas_object_show() on a notify object, if a timeout was set
10109 * on it, it will @b automatically get hidden after that time.
10111 * Signals that you can add callbacks for are:
10112 * @li "timeout" - when timeout happens on notify and it's hidden
10113 * @li "block,clicked" - when a click outside of the notify happens
10115 * Default contents parts of the notify widget that you can use for are:
10116 * @li "elm.swallow.content" - A content of the notify
10118 * @ref tutorial_notify show usage of the API.
10123 * @brief Possible orient values for notify.
10125 * This values should be used in conjunction to elm_notify_orient_set() to
10126 * set the position in which the notify should appear(relative to its parent)
10127 * and in conjunction with elm_notify_orient_get() to know where the notify
10130 typedef enum _Elm_Notify_Orient
10132 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
10133 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
10134 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
10135 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
10136 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
10137 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
10138 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
10139 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
10140 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10141 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10142 } Elm_Notify_Orient;
10144 * @brief Add a new notify to the parent
10146 * @param parent The parent object
10147 * @return The new object or NULL if it cannot be created
10149 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10151 * @brief Set the content of the notify widget
10153 * @param obj The notify object
10154 * @param content The content will be filled in this notify object
10156 * Once the content object is set, a previously set one will be deleted. If
10157 * you want to keep that old content object, use the
10158 * elm_notify_content_unset() function.
10160 EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10162 * @brief Unset the content of the notify widget
10164 * @param obj The notify object
10165 * @return The content that was being used
10167 * Unparent and return the content object which was set for this widget
10169 * @see elm_notify_content_set()
10171 EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10173 * @brief Return the content of the notify widget
10175 * @param obj The notify object
10176 * @return The content that is being used
10178 * @see elm_notify_content_set()
10180 EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10182 * @brief Set the notify parent
10184 * @param obj The notify object
10185 * @param content The new parent
10187 * Once the parent object is set, a previously set one will be disconnected
10190 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10192 * @brief Get the notify parent
10194 * @param obj The notify object
10195 * @return The parent
10197 * @see elm_notify_parent_set()
10199 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10201 * @brief Set the orientation
10203 * @param obj The notify object
10204 * @param orient The new orientation
10206 * Sets the position in which the notify will appear in its parent.
10208 * @see @ref Elm_Notify_Orient for possible values.
10210 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10212 * @brief Return the orientation
10213 * @param obj The notify object
10214 * @return The orientation of the notification
10216 * @see elm_notify_orient_set()
10217 * @see Elm_Notify_Orient
10219 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10221 * @brief Set the time interval after which the notify window is going to be
10224 * @param obj The notify object
10225 * @param time The timeout in seconds
10227 * This function sets a timeout and starts the timer controlling when the
10228 * notify is hidden. Since calling evas_object_show() on a notify restarts
10229 * the timer controlling when the notify is hidden, setting this before the
10230 * notify is shown will in effect mean starting the timer when the notify is
10233 * @note Set a value <= 0.0 to disable a running timer.
10235 * @note If the value > 0.0 and the notify is previously visible, the
10236 * timer will be started with this value, canceling any running timer.
10238 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10240 * @brief Return the timeout value (in seconds)
10241 * @param obj the notify object
10243 * @see elm_notify_timeout_set()
10245 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10247 * @brief Sets whether events should be passed to by a click outside
10250 * @param obj The notify object
10251 * @param repeats EINA_TRUE Events are repeats, else no
10253 * When true if the user clicks outside the window the events will be caught
10254 * by the others widgets, else the events are blocked.
10256 * @note The default value is EINA_TRUE.
10258 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10260 * @brief Return true if events are repeat below the notify object
10261 * @param obj the notify object
10263 * @see elm_notify_repeat_events_set()
10265 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10271 * @defgroup Hover Hover
10273 * @image html img/widget/hover/preview-00.png
10274 * @image latex img/widget/hover/preview-00.eps
10276 * A Hover object will hover over its @p parent object at the @p target
10277 * location. Anything in the background will be given a darker coloring to
10278 * indicate that the hover object is on top (at the default theme). When the
10279 * hover is clicked it is dismissed(hidden), if the contents of the hover are
10280 * clicked that @b doesn't cause the hover to be dismissed.
10282 * A Hover object has two parents. One parent that owns it during creation
10283 * and the other parent being the one over which the hover object spans.
10286 * @note The hover object will take up the entire space of @p target
10289 * Elementary has the following styles for the hover widget:
10293 * @li hoversel_vertical
10295 * The following are the available position for content:
10307 * Signals that you can add callbacks for are:
10308 * @li "clicked" - the user clicked the empty space in the hover to dismiss
10309 * @li "smart,changed" - a content object placed under the "smart"
10310 * policy was replaced to a new slot direction.
10312 * See @ref tutorial_hover for more information.
10316 typedef enum _Elm_Hover_Axis
10318 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10319 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10320 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10321 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10324 * @brief Adds a hover object to @p parent
10326 * @param parent The parent object
10327 * @return The hover object or NULL if one could not be created
10329 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10331 * @brief Sets the target object for the hover.
10333 * @param obj The hover object
10334 * @param target The object to center the hover onto. The hover
10336 * This function will cause the hover to be centered on the target object.
10338 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10340 * @brief Gets the target object for the hover.
10342 * @param obj The hover object
10343 * @param parent The object to locate the hover over.
10345 * @see elm_hover_target_set()
10347 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10349 * @brief Sets the parent object for the hover.
10351 * @param obj The hover object
10352 * @param parent The object to locate the hover over.
10354 * This function will cause the hover to take up the entire space that the
10355 * parent object fills.
10357 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10359 * @brief Gets the parent object for the hover.
10361 * @param obj The hover object
10362 * @return The parent object to locate the hover over.
10364 * @see elm_hover_parent_set()
10366 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10368 * @brief Sets the content of the hover object and the direction in which it
10371 * @param obj The hover object
10372 * @param swallow The direction that the object will be displayed
10373 * at. Accepted values are "left", "top-left", "top", "top-right",
10374 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10376 * @param content The content to place at @p swallow
10378 * Once the content object is set for a given direction, a previously
10379 * set one (on the same direction) will be deleted. If you want to
10380 * keep that old content object, use the elm_hover_content_unset()
10383 * All directions may have contents at the same time, except for
10384 * "smart". This is a special placement hint and its use case
10385 * independs of the calculations coming from
10386 * elm_hover_best_content_location_get(). Its use is for cases when
10387 * one desires only one hover content, but with a dinamic special
10388 * placement within the hover area. The content's geometry, whenever
10389 * it changes, will be used to decide on a best location not
10390 * extrapolating the hover's parent object view to show it in (still
10391 * being the hover's target determinant of its medium part -- move and
10392 * resize it to simulate finger sizes, for example). If one of the
10393 * directions other than "smart" are used, a previously content set
10394 * using it will be deleted, and vice-versa.
10396 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10398 * @brief Get the content of the hover object, in a given direction.
10400 * Return the content object which was set for this widget in the
10401 * @p swallow direction.
10403 * @param obj The hover object
10404 * @param swallow The direction that the object was display at.
10405 * @return The content that was being used
10407 * @see elm_hover_content_set()
10409 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10411 * @brief Unset the content of the hover object, in a given direction.
10413 * Unparent and return the content object set at @p swallow direction.
10415 * @param obj The hover object
10416 * @param swallow The direction that the object was display at.
10417 * @return The content that was being used.
10419 * @see elm_hover_content_set()
10421 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10423 * @brief Returns the best swallow location for content in the hover.
10425 * @param obj The hover object
10426 * @param pref_axis The preferred orientation axis for the hover object to use
10427 * @return The edje location to place content into the hover or @c
10430 * Best is defined here as the location at which there is the most available
10433 * @p pref_axis may be one of
10434 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10435 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10436 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10437 * - @c ELM_HOVER_AXIS_BOTH -- both
10439 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10440 * nescessarily be along the horizontal axis("left" or "right"). If
10441 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10442 * be along the vertical axis("top" or "bottom"). Chossing
10443 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10444 * returned position may be in either axis.
10446 * @see elm_hover_content_set()
10448 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10455 * @defgroup Entry Entry
10457 * @image html img/widget/entry/preview-00.png
10458 * @image latex img/widget/entry/preview-00.eps width=\textwidth
10459 * @image html img/widget/entry/preview-01.png
10460 * @image latex img/widget/entry/preview-01.eps width=\textwidth
10461 * @image html img/widget/entry/preview-02.png
10462 * @image latex img/widget/entry/preview-02.eps width=\textwidth
10463 * @image html img/widget/entry/preview-03.png
10464 * @image latex img/widget/entry/preview-03.eps width=\textwidth
10466 * An entry is a convenience widget which shows a box that the user can
10467 * enter text into. Entries by default don't scroll, so they grow to
10468 * accomodate the entire text, resizing the parent window as needed. This
10469 * can be changed with the elm_entry_scrollable_set() function.
10471 * They can also be single line or multi line (the default) and when set
10472 * to multi line mode they support text wrapping in any of the modes
10473 * indicated by #Elm_Wrap_Type.
10475 * Other features include password mode, filtering of inserted text with
10476 * elm_entry_text_filter_append() and related functions, inline "items" and
10477 * formatted markup text.
10479 * @section entry-markup Formatted text
10481 * The markup tags supported by the Entry are defined by the theme, but
10482 * even when writing new themes or extensions it's a good idea to stick to
10483 * a sane default, to maintain coherency and avoid application breakages.
10484 * Currently defined by the default theme are the following tags:
10485 * @li \<br\>: Inserts a line break.
10486 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10488 * @li \<tab\>: Inserts a tab.
10489 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10491 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10492 * @li \<link\>...\</link\>: Underlines the enclosed text.
10493 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10495 * @section entry-special Special markups
10497 * Besides those used to format text, entries support two special markup
10498 * tags used to insert clickable portions of text or items inlined within
10501 * @subsection entry-anchors Anchors
10503 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10504 * \</a\> tags and an event will be generated when this text is clicked,
10508 * This text is outside <a href=anc-01>but this one is an anchor</a>
10511 * The @c href attribute in the opening tag gives the name that will be
10512 * used to identify the anchor and it can be any valid utf8 string.
10514 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10515 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10516 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10517 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10520 * @subsection entry-items Items
10522 * Inlined in the text, any other @c Evas_Object can be inserted by using
10523 * \<item\> tags this way:
10526 * <item size=16x16 vsize=full href=emoticon/haha></item>
10529 * Just like with anchors, the @c href identifies each item, but these need,
10530 * in addition, to indicate their size, which is done using any one of
10531 * @c size, @c absize or @c relsize attributes. These attributes take their
10532 * value in the WxH format, where W is the width and H the height of the
10535 * @li absize: Absolute pixel size for the item. Whatever value is set will
10536 * be the item's size regardless of any scale value the object may have
10537 * been set to. The final line height will be adjusted to fit larger items.
10538 * @li size: Similar to @c absize, but it's adjusted to the scale value set
10540 * @li relsize: Size is adjusted for the item to fit within the current
10543 * Besides their size, items are specificed a @c vsize value that affects
10544 * how their final size and position are calculated. The possible values
10546 * @li ascent: Item will be placed within the line's baseline and its
10547 * ascent. That is, the height between the line where all characters are
10548 * positioned and the highest point in the line. For @c size and @c absize
10549 * items, the descent value will be added to the total line height to make
10550 * them fit. @c relsize items will be adjusted to fit within this space.
10551 * @li full: Items will be placed between the descent and ascent, or the
10552 * lowest point in the line and its highest.
10554 * The next image shows different configurations of items and how they
10555 * are the previously mentioned options affect their sizes. In all cases,
10556 * the green line indicates the ascent, blue for the baseline and red for
10559 * @image html entry_item.png
10560 * @image latex entry_item.eps width=\textwidth
10562 * And another one to show how size differs from absize. In the first one,
10563 * the scale value is set to 1.0, while the second one is using one of 2.0.
10565 * @image html entry_item_scale.png
10566 * @image latex entry_item_scale.eps width=\textwidth
10568 * After the size for an item is calculated, the entry will request an
10569 * object to place in its space. For this, the functions set with
10570 * elm_entry_item_provider_append() and related functions will be called
10571 * in order until one of them returns a @c non-NULL value. If no providers
10572 * are available, or all of them return @c NULL, then the entry falls back
10573 * to one of the internal defaults, provided the name matches with one of
10576 * All of the following are currently supported:
10579 * - emoticon/angry-shout
10580 * - emoticon/crazy-laugh
10581 * - emoticon/evil-laugh
10583 * - emoticon/goggle-smile
10584 * - emoticon/grumpy
10585 * - emoticon/grumpy-smile
10586 * - emoticon/guilty
10587 * - emoticon/guilty-smile
10589 * - emoticon/half-smile
10590 * - emoticon/happy-panting
10592 * - emoticon/indifferent
10594 * - emoticon/knowing-grin
10596 * - emoticon/little-bit-sorry
10597 * - emoticon/love-lots
10599 * - emoticon/minimal-smile
10600 * - emoticon/not-happy
10601 * - emoticon/not-impressed
10603 * - emoticon/opensmile
10606 * - emoticon/squint-laugh
10607 * - emoticon/surprised
10608 * - emoticon/suspicious
10609 * - emoticon/tongue-dangling
10610 * - emoticon/tongue-poke
10612 * - emoticon/unhappy
10613 * - emoticon/very-sorry
10616 * - emoticon/worried
10619 * Alternatively, an item may reference an image by its path, using
10620 * the URI form @c file:///path/to/an/image.png and the entry will then
10621 * use that image for the item.
10623 * @section entry-files Loading and saving files
10625 * Entries have convinience functions to load text from a file and save
10626 * changes back to it after a short delay. The automatic saving is enabled
10627 * by default, but can be disabled with elm_entry_autosave_set() and files
10628 * can be loaded directly as plain text or have any markup in them
10629 * recognized. See elm_entry_file_set() for more details.
10631 * @section entry-signals Emitted signals
10633 * This widget emits the following signals:
10635 * @li "changed": The text within the entry was changed.
10636 * @li "changed,user": The text within the entry was changed because of user interaction.
10637 * @li "activated": The enter key was pressed on a single line entry.
10638 * @li "press": A mouse button has been pressed on the entry.
10639 * @li "longpressed": A mouse button has been pressed and held for a couple
10641 * @li "clicked": The entry has been clicked (mouse press and release).
10642 * @li "clicked,double": The entry has been double clicked.
10643 * @li "clicked,triple": The entry has been triple clicked.
10644 * @li "focused": The entry has received focus.
10645 * @li "unfocused": The entry has lost focus.
10646 * @li "selection,paste": A paste of the clipboard contents was requested.
10647 * @li "selection,copy": A copy of the selected text into the clipboard was
10649 * @li "selection,cut": A cut of the selected text into the clipboard was
10651 * @li "selection,start": A selection has begun and no previous selection
10653 * @li "selection,changed": The current selection has changed.
10654 * @li "selection,cleared": The current selection has been cleared.
10655 * @li "cursor,changed": The cursor has changed position.
10656 * @li "anchor,clicked": An anchor has been clicked. The event_info
10657 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10658 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
10659 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10660 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
10661 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10662 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
10663 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10664 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
10665 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10666 * @li "preedit,changed": The preedit string has changed.
10667 * @li "language,changed": Program language changed.
10669 * @section entry-examples
10671 * An overview of the Entry API can be seen in @ref entry_example_01
10676 * @typedef Elm_Entry_Anchor_Info
10678 * The info sent in the callback for the "anchor,clicked" signals emitted
10681 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
10683 * @struct _Elm_Entry_Anchor_Info
10685 * The info sent in the callback for the "anchor,clicked" signals emitted
10688 struct _Elm_Entry_Anchor_Info
10690 const char *name; /**< The name of the anchor, as stated in its href */
10691 int button; /**< The mouse button used to click on it */
10692 Evas_Coord x, /**< Anchor geometry, relative to canvas */
10693 y, /**< Anchor geometry, relative to canvas */
10694 w, /**< Anchor geometry, relative to canvas */
10695 h; /**< Anchor geometry, relative to canvas */
10698 * @typedef Elm_Entry_Filter_Cb
10699 * This callback type is used by entry filters to modify text.
10700 * @param data The data specified as the last param when adding the filter
10701 * @param entry The entry object
10702 * @param text A pointer to the location of the text being filtered. This data can be modified,
10703 * but any additional allocations must be managed by the user.
10704 * @see elm_entry_text_filter_append
10705 * @see elm_entry_text_filter_prepend
10707 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
10710 * This adds an entry to @p parent object.
10712 * By default, entries are:
10716 * @li autosave is enabled
10718 * @param parent The parent object
10719 * @return The new object or NULL if it cannot be created
10721 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10723 * Sets the entry to single line mode.
10725 * In single line mode, entries don't ever wrap when the text reaches the
10726 * edge, and instead they keep growing horizontally. Pressing the @c Enter
10727 * key will generate an @c "activate" event instead of adding a new line.
10729 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
10730 * and pressing enter will break the text into a different line
10731 * without generating any events.
10733 * @param obj The entry object
10734 * @param single_line If true, the text in the entry
10735 * will be on a single line.
10737 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
10739 * Gets whether the entry is set to be single line.
10741 * @param obj The entry object
10742 * @return single_line If true, the text in the entry is set to display
10743 * on a single line.
10745 * @see elm_entry_single_line_set()
10747 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10749 * Sets the entry to password mode.
10751 * In password mode, entries are implicitly single line and the display of
10752 * any text in them is replaced with asterisks (*).
10754 * @param obj The entry object
10755 * @param password If true, password mode is enabled.
10757 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
10759 * Gets whether the entry is set to password mode.
10761 * @param obj The entry object
10762 * @return If true, the entry is set to display all characters
10763 * as asterisks (*).
10765 * @see elm_entry_password_set()
10767 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10769 * This sets the text displayed within the entry to @p entry.
10771 * @param obj The entry object
10772 * @param entry The text to be displayed
10774 * @deprecated Use elm_object_text_set() instead.
10775 * @note Using this function bypasses text filters
10777 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10779 * This returns the text currently shown in object @p entry.
10780 * See also elm_entry_entry_set().
10782 * @param obj The entry object
10783 * @return The currently displayed text or NULL on failure
10785 * @deprecated Use elm_object_text_get() instead.
10787 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10789 * Appends @p entry to the text of the entry.
10791 * Adds the text in @p entry to the end of any text already present in the
10794 * The appended text is subject to any filters set for the widget.
10796 * @param obj The entry object
10797 * @param entry The text to be displayed
10799 * @see elm_entry_text_filter_append()
10801 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10803 * Gets whether the entry is empty.
10805 * Empty means no text at all. If there are any markup tags, like an item
10806 * tag for which no provider finds anything, and no text is displayed, this
10807 * function still returns EINA_FALSE.
10809 * @param obj The entry object
10810 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
10812 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10814 * Gets any selected text within the entry.
10816 * If there's any selected text in the entry, this function returns it as
10817 * a string in markup format. NULL is returned if no selection exists or
10818 * if an error occurred.
10820 * The returned value points to an internal string and should not be freed
10821 * or modified in any way. If the @p entry object is deleted or its
10822 * contents are changed, the returned pointer should be considered invalid.
10824 * @param obj The entry object
10825 * @return The selected text within the entry or NULL on failure
10827 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10829 * Inserts the given text into the entry at the current cursor position.
10831 * This inserts text at the cursor position as if it was typed
10832 * by the user (note that this also allows markup which a user
10833 * can't just "type" as it would be converted to escaped text, so this
10834 * call can be used to insert things like emoticon items or bold push/pop
10835 * tags, other font and color change tags etc.)
10837 * If any selection exists, it will be replaced by the inserted text.
10839 * The inserted text is subject to any filters set for the widget.
10841 * @param obj The entry object
10842 * @param entry The text to insert
10844 * @see elm_entry_text_filter_append()
10846 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10848 * Set the line wrap type to use on multi-line entries.
10850 * Sets the wrap type used by the entry to any of the specified in
10851 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
10852 * line (without inserting a line break or paragraph separator) when it
10853 * reaches the far edge of the widget.
10855 * Note that this only makes sense for multi-line entries. A widget set
10856 * to be single line will never wrap.
10858 * @param obj The entry object
10859 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
10861 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
10862 EINA_DEPRECATED EAPI void elm_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
10864 * Gets the wrap mode the entry was set to use.
10866 * @param obj The entry object
10867 * @return Wrap type
10869 * @see also elm_entry_line_wrap_set()
10871 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10873 * Sets if the entry is to be editable or not.
10875 * By default, entries are editable and when focused, any text input by the
10876 * user will be inserted at the current cursor position. But calling this
10877 * function with @p editable as EINA_FALSE will prevent the user from
10878 * inputting text into the entry.
10880 * The only way to change the text of a non-editable entry is to use
10881 * elm_object_text_set(), elm_entry_entry_insert() and other related
10884 * @param obj The entry object
10885 * @param editable If EINA_TRUE, user input will be inserted in the entry,
10886 * if not, the entry is read-only and no user input is allowed.
10888 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
10890 * Gets whether the entry is editable or not.
10892 * @param obj The entry object
10893 * @return If true, the entry is editable by the user.
10894 * If false, it is not editable by the user
10896 * @see elm_entry_editable_set()
10898 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10900 * This drops any existing text selection within the entry.
10902 * @param obj The entry object
10904 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
10906 * This selects all text within the entry.
10908 * @param obj The entry object
10910 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
10912 * This moves the cursor one place to the right within the entry.
10914 * @param obj The entry object
10915 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10917 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
10919 * This moves the cursor one place to the left within the entry.
10921 * @param obj The entry object
10922 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10924 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
10926 * This moves the cursor one line up within the entry.
10928 * @param obj The entry object
10929 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10931 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
10933 * This moves the cursor one line down within the entry.
10935 * @param obj The entry object
10936 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10938 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
10940 * This moves the cursor to the beginning of the entry.
10942 * @param obj The entry object
10944 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10946 * This moves the cursor to the end of the entry.
10948 * @param obj The entry object
10950 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10952 * This moves the cursor to the beginning of the current line.
10954 * @param obj The entry object
10956 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10958 * This moves the cursor to the end of the current line.
10960 * @param obj The entry object
10962 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10964 * This begins a selection within the entry as though
10965 * the user were holding down the mouse button to make a selection.
10967 * @param obj The entry object
10969 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
10971 * This ends a selection within the entry as though
10972 * the user had just released the mouse button while making a selection.
10974 * @param obj The entry object
10976 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
10978 * Gets whether a format node exists at the current cursor position.
10980 * A format node is anything that defines how the text is rendered. It can
10981 * be a visible format node, such as a line break or a paragraph separator,
10982 * or an invisible one, such as bold begin or end tag.
10983 * This function returns whether any format node exists at the current
10986 * @param obj The entry object
10987 * @return EINA_TRUE if the current cursor position contains a format node,
10988 * EINA_FALSE otherwise.
10990 * @see elm_entry_cursor_is_visible_format_get()
10992 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10994 * Gets if the current cursor position holds a visible format node.
10996 * @param obj The entry object
10997 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
10998 * if it's an invisible one or no format exists.
11000 * @see elm_entry_cursor_is_format_get()
11002 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11004 * Gets the character pointed by the cursor at its current position.
11006 * This function returns a string with the utf8 character stored at the
11007 * current cursor position.
11008 * Only the text is returned, any format that may exist will not be part
11009 * of the return value.
11011 * @param obj The entry object
11012 * @return The text pointed by the cursors.
11014 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11016 * This function returns the geometry of the cursor.
11018 * It's useful if you want to draw something on the cursor (or where it is),
11019 * or for example in the case of scrolled entry where you want to show the
11022 * @param obj The entry object
11023 * @param x returned geometry
11024 * @param y returned geometry
11025 * @param w returned geometry
11026 * @param h returned geometry
11027 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11029 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);
11031 * Sets the cursor position in the entry to the given value
11033 * The value in @p pos is the index of the character position within the
11034 * contents of the string as returned by elm_entry_cursor_pos_get().
11036 * @param obj The entry object
11037 * @param pos The position of the cursor
11039 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
11041 * Retrieves the current position of the cursor in the entry
11043 * @param obj The entry object
11044 * @return The cursor position
11046 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11048 * This executes a "cut" action on the selected text in the entry.
11050 * @param obj The entry object
11052 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
11054 * This executes a "copy" action on the selected text in the entry.
11056 * @param obj The entry object
11058 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
11060 * This executes a "paste" action in the entry.
11062 * @param obj The entry object
11064 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
11066 * This clears and frees the items in a entry's contextual (longpress)
11069 * @param obj The entry object
11071 * @see elm_entry_context_menu_item_add()
11073 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11075 * This adds an item to the entry's contextual menu.
11077 * A longpress on an entry will make the contextual menu show up, if this
11078 * hasn't been disabled with elm_entry_context_menu_disabled_set().
11079 * By default, this menu provides a few options like enabling selection mode,
11080 * which is useful on embedded devices that need to be explicit about it,
11081 * and when a selection exists it also shows the copy and cut actions.
11083 * With this function, developers can add other options to this menu to
11084 * perform any action they deem necessary.
11086 * @param obj The entry object
11087 * @param label The item's text label
11088 * @param icon_file The item's icon file
11089 * @param icon_type The item's icon type
11090 * @param func The callback to execute when the item is clicked
11091 * @param data The data to associate with the item for related functions
11093 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);
11095 * This disables the entry's contextual (longpress) menu.
11097 * @param obj The entry object
11098 * @param disabled If true, the menu is disabled
11100 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11102 * This returns whether the entry's contextual (longpress) menu is
11105 * @param obj The entry object
11106 * @return If true, the menu is disabled
11108 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11110 * This appends a custom item provider to the list for that entry
11112 * This appends the given callback. The list is walked from beginning to end
11113 * with each function called given the item href string in the text. If the
11114 * function returns an object handle other than NULL (it should create an
11115 * object to do this), then this object is used to replace that item. If
11116 * not the next provider is called until one provides an item object, or the
11117 * default provider in entry does.
11119 * @param obj The entry object
11120 * @param func The function called to provide the item object
11121 * @param data The data passed to @p func
11123 * @see @ref entry-items
11125 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);
11127 * This prepends a custom item provider to the list for that entry
11129 * This prepends the given callback. See elm_entry_item_provider_append() for
11132 * @param obj The entry object
11133 * @param func The function called to provide the item object
11134 * @param data The data passed to @p func
11136 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);
11138 * This removes a custom item provider to the list for that entry
11140 * This removes the given callback. See elm_entry_item_provider_append() for
11143 * @param obj The entry object
11144 * @param func The function called to provide the item object
11145 * @param data The data passed to @p func
11147 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);
11149 * Append a filter function for text inserted in the entry
11151 * Append the given callback to the list. This functions will be called
11152 * whenever any text is inserted into the entry, with the text to be inserted
11153 * as a parameter. The callback function is free to alter the text in any way
11154 * it wants, but it must remember to free the given pointer and update it.
11155 * If the new text is to be discarded, the function can free it and set its
11156 * text parameter to NULL. This will also prevent any following filters from
11159 * @param obj The entry object
11160 * @param func The function to use as text filter
11161 * @param data User data to pass to @p func
11163 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11165 * Prepend a filter function for text insdrted in the entry
11167 * Prepend the given callback to the list. See elm_entry_text_filter_append()
11168 * for more information
11170 * @param obj The entry object
11171 * @param func The function to use as text filter
11172 * @param data User data to pass to @p func
11174 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11176 * Remove a filter from the list
11178 * Removes the given callback from the filter list. See
11179 * elm_entry_text_filter_append() for more information.
11181 * @param obj The entry object
11182 * @param func The filter function to remove
11183 * @param data The user data passed when adding the function
11185 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11187 * This converts a markup (HTML-like) string into UTF-8.
11189 * The returned string is a malloc'ed buffer and it should be freed when
11190 * not needed anymore.
11192 * @param s The string (in markup) to be converted
11193 * @return The converted string (in UTF-8). It should be freed.
11195 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11197 * This converts a UTF-8 string into markup (HTML-like).
11199 * The returned string is a malloc'ed buffer and it should be freed when
11200 * not needed anymore.
11202 * @param s The string (in UTF-8) to be converted
11203 * @return The converted string (in markup). It should be freed.
11205 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11207 * This sets the file (and implicitly loads it) for the text to display and
11208 * then edit. All changes are written back to the file after a short delay if
11209 * the entry object is set to autosave (which is the default).
11211 * If the entry had any other file set previously, any changes made to it
11212 * will be saved if the autosave feature is enabled, otherwise, the file
11213 * will be silently discarded and any non-saved changes will be lost.
11215 * @param obj The entry object
11216 * @param file The path to the file to load and save
11217 * @param format The file format
11219 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11221 * Gets the file being edited by the entry.
11223 * This function can be used to retrieve any file set on the entry for
11224 * edition, along with the format used to load and save it.
11226 * @param obj The entry object
11227 * @param file The path to the file to load and save
11228 * @param format The file format
11230 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11232 * This function writes any changes made to the file set with
11233 * elm_entry_file_set()
11235 * @param obj The entry object
11237 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11239 * This sets the entry object to 'autosave' the loaded text file or not.
11241 * @param obj The entry object
11242 * @param autosave Autosave the loaded file or not
11244 * @see elm_entry_file_set()
11246 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11248 * This gets the entry object's 'autosave' status.
11250 * @param obj The entry object
11251 * @return Autosave the loaded file or not
11253 * @see elm_entry_file_set()
11255 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11257 * Control pasting of text and images for the widget.
11259 * Normally the entry allows both text and images to be pasted. By setting
11260 * textonly to be true, this prevents images from being pasted.
11262 * Note this only changes the behaviour of text.
11264 * @param obj The entry object
11265 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11266 * text+image+other.
11268 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11270 * Getting elm_entry text paste/drop mode.
11272 * In textonly mode, only text may be pasted or dropped into the widget.
11274 * @param obj The entry object
11275 * @return If the widget only accepts text from pastes.
11277 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11279 * Enable or disable scrolling in entry
11281 * Normally the entry is not scrollable unless you enable it with this call.
11283 * @param obj The entry object
11284 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11286 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11288 * Get the scrollable state of the entry
11290 * Normally the entry is not scrollable. This gets the scrollable state
11291 * of the entry. See elm_entry_scrollable_set() for more information.
11293 * @param obj The entry object
11294 * @return The scrollable state
11296 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
11298 * This sets a widget to be displayed to the left of a scrolled entry.
11300 * @param obj The scrolled entry object
11301 * @param icon The widget to display on the left side of the scrolled
11304 * @note A previously set widget will be destroyed.
11305 * @note If the object being set does not have minimum size hints set,
11306 * it won't get properly displayed.
11308 * @see elm_entry_end_set()
11310 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11312 * Gets the leftmost widget of the scrolled entry. This object is
11313 * owned by the scrolled entry and should not be modified.
11315 * @param obj The scrolled entry object
11316 * @return the left widget inside the scroller
11318 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11320 * Unset the leftmost widget of the scrolled entry, unparenting and
11323 * @param obj The scrolled entry object
11324 * @return the previously set icon sub-object of this entry, on
11327 * @see elm_entry_icon_set()
11329 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11331 * Sets the visibility of the left-side widget of the scrolled entry,
11332 * set by elm_entry_icon_set().
11334 * @param obj The scrolled entry object
11335 * @param setting EINA_TRUE if the object should be displayed,
11336 * EINA_FALSE if not.
11338 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11340 * This sets a widget to be displayed to the end of a scrolled entry.
11342 * @param obj The scrolled entry object
11343 * @param end The widget to display on the right side of the scrolled
11346 * @note A previously set widget will be destroyed.
11347 * @note If the object being set does not have minimum size hints set,
11348 * it won't get properly displayed.
11350 * @see elm_entry_icon_set
11352 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11354 * Gets the endmost widget of the scrolled entry. This object is owned
11355 * by the scrolled entry and should not be modified.
11357 * @param obj The scrolled entry object
11358 * @return the right widget inside the scroller
11360 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11362 * Unset the endmost widget of the scrolled entry, unparenting and
11365 * @param obj The scrolled entry object
11366 * @return the previously set icon sub-object of this entry, on
11369 * @see elm_entry_icon_set()
11371 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11373 * Sets the visibility of the end widget of the scrolled entry, set by
11374 * elm_entry_end_set().
11376 * @param obj The scrolled entry object
11377 * @param setting EINA_TRUE if the object should be displayed,
11378 * EINA_FALSE if not.
11380 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11382 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11385 * Setting an entry to single-line mode with elm_entry_single_line_set()
11386 * will automatically disable the display of scrollbars when the entry
11387 * moves inside its scroller.
11389 * @param obj The scrolled entry object
11390 * @param h The horizontal scrollbar policy to apply
11391 * @param v The vertical scrollbar policy to apply
11393 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11395 * This enables/disables bouncing within the entry.
11397 * This function sets whether the entry will bounce when scrolling reaches
11398 * the end of the contained entry.
11400 * @param obj The scrolled entry object
11401 * @param h The horizontal bounce state
11402 * @param v The vertical bounce state
11404 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11406 * Get the bounce mode
11408 * @param obj The Entry object
11409 * @param h_bounce Allow bounce horizontally
11410 * @param v_bounce Allow bounce vertically
11412 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11414 /* pre-made filters for entries */
11416 * @typedef Elm_Entry_Filter_Limit_Size
11418 * Data for the elm_entry_filter_limit_size() entry filter.
11420 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11422 * @struct _Elm_Entry_Filter_Limit_Size
11424 * Data for the elm_entry_filter_limit_size() entry filter.
11426 struct _Elm_Entry_Filter_Limit_Size
11428 int max_char_count; /**< The maximum number of characters allowed. */
11429 int max_byte_count; /**< The maximum number of bytes allowed*/
11432 * Filter inserted text based on user defined character and byte limits
11434 * Add this filter to an entry to limit the characters that it will accept
11435 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11436 * The funtion works on the UTF-8 representation of the string, converting
11437 * it from the set markup, thus not accounting for any format in it.
11439 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11440 * it as data when setting the filter. In it, it's possible to set limits
11441 * by character count or bytes (any of them is disabled if 0), and both can
11442 * be set at the same time. In that case, it first checks for characters,
11445 * The function will cut the inserted text in order to allow only the first
11446 * number of characters that are still allowed. The cut is made in
11447 * characters, even when limiting by bytes, in order to always contain
11448 * valid ones and avoid half unicode characters making it in.
11450 * This filter, like any others, does not apply when setting the entry text
11451 * directly with elm_object_text_set() (or the deprecated
11452 * elm_entry_entry_set()).
11454 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11456 * @typedef Elm_Entry_Filter_Accept_Set
11458 * Data for the elm_entry_filter_accept_set() entry filter.
11460 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11462 * @struct _Elm_Entry_Filter_Accept_Set
11464 * Data for the elm_entry_filter_accept_set() entry filter.
11466 struct _Elm_Entry_Filter_Accept_Set
11468 const char *accepted; /**< Set of characters accepted in the entry. */
11469 const char *rejected; /**< Set of characters rejected from the entry. */
11472 * Filter inserted text based on accepted or rejected sets of characters
11474 * Add this filter to an entry to restrict the set of accepted characters
11475 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11476 * This structure contains both accepted and rejected sets, but they are
11477 * mutually exclusive.
11479 * The @c accepted set takes preference, so if it is set, the filter will
11480 * only work based on the accepted characters, ignoring anything in the
11481 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11483 * In both cases, the function filters by matching utf8 characters to the
11484 * raw markup text, so it can be used to remove formatting tags.
11486 * This filter, like any others, does not apply when setting the entry text
11487 * directly with elm_object_text_set() (or the deprecated
11488 * elm_entry_entry_set()).
11490 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11492 * Set the input panel layout of the entry
11494 * @param obj The entry object
11495 * @param layout layout type
11497 EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
11499 * Get the input panel layout of the entry
11501 * @param obj The entry object
11502 * @return layout type
11504 * @see elm_entry_input_panel_layout_set
11506 EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11508 * Set the autocapitalization type on the immodule.
11510 * @param obj The entry object
11511 * @param autocapital_type The type of autocapitalization
11513 EAPI void elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type) EINA_ARG_NONNULL(1);
11515 * Retrieve the autocapitalization type on the immodule.
11517 * @param obj The entry object
11518 * @return autocapitalization type
11520 EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11522 * Sets the attribute to show the input panel automatically.
11524 * @param obj The entry object
11525 * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
11527 EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
11529 * Retrieve the attribute to show the input panel automatically.
11531 * @param obj The entry object
11532 * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
11534 EAPI Eina_Bool elm_entry_input_panel_enabled_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11536 EAPI void elm_entry_background_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
11537 EAPI void elm_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
11538 EAPI void elm_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
11539 EAPI void elm_entry_autoenable_returnkey_set(Evas_Object *obj, Eina_Bool on);
11540 EAPI Ecore_IMF_Context *elm_entry_imf_context_get(Evas_Object *obj);
11541 EAPI void elm_entry_matchlist_set(Evas_Object *obj, Eina_List *match_list, Eina_Bool case_sensitive);
11542 EAPI void elm_entry_magnifier_type_set(Evas_Object *obj, int type) EINA_ARG_NONNULL(1);
11544 EINA_DEPRECATED EAPI void elm_entry_wrap_width_set(Evas_Object *obj, Evas_Coord w);
11545 EINA_DEPRECATED EAPI Evas_Coord elm_entry_wrap_width_get(const Evas_Object *obj);
11546 EINA_DEPRECATED EAPI void elm_entry_fontsize_set(Evas_Object *obj, int fontsize);
11547 EINA_DEPRECATED EAPI void elm_entry_text_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
11548 EINA_DEPRECATED EAPI void elm_entry_text_align_set(Evas_Object *obj, const char *alignmode);
11556 * @defgroup Anchorview Anchorview
11558 * Anchorview is for displaying text that contains markup with anchors
11559 * like <c>\<a href=1234\>something\</\></c> in it.
11561 * Besides being styled differently, the anchorview widget provides the
11562 * necessary functionality so that clicking on these anchors brings up a
11563 * popup with user defined content such as "call", "add to contacts" or
11564 * "open web page". This popup is provided using the @ref Hover widget.
11566 * This widget is very similar to @ref Anchorblock, so refer to that
11567 * widget for an example. The only difference Anchorview has is that the
11568 * widget is already provided with scrolling functionality, so if the
11569 * text set to it is too large to fit in the given space, it will scroll,
11570 * whereas the @ref Anchorblock widget will keep growing to ensure all the
11571 * text can be displayed.
11573 * This widget emits the following signals:
11574 * @li "anchor,clicked": will be called when an anchor is clicked. The
11575 * @p event_info parameter on the callback will be a pointer of type
11576 * ::Elm_Entry_Anchorview_Info.
11578 * See @ref Anchorblock for an example on how to use both of them.
11587 * @typedef Elm_Entry_Anchorview_Info
11589 * The info sent in the callback for "anchor,clicked" signals emitted by
11590 * the Anchorview widget.
11592 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
11594 * @struct _Elm_Entry_Anchorview_Info
11596 * The info sent in the callback for "anchor,clicked" signals emitted by
11597 * the Anchorview widget.
11599 struct _Elm_Entry_Anchorview_Info
11601 const char *name; /**< Name of the anchor, as indicated in its href
11603 int button; /**< The mouse button used to click on it */
11604 Evas_Object *hover; /**< The hover object to use for the popup */
11606 Evas_Coord x, y, w, h;
11607 } anchor, /**< Geometry selection of text used as anchor */
11608 hover_parent; /**< Geometry of the object used as parent by the
11610 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
11611 for content on the left side of
11612 the hover. Before calling the
11613 callback, the widget will make the
11614 necessary calculations to check
11615 which sides are fit to be set with
11616 content, based on the position the
11617 hover is activated and its distance
11618 to the edges of its parent object
11620 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
11621 the right side of the hover.
11622 See @ref hover_left */
11623 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
11624 of the hover. See @ref hover_left */
11625 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
11626 below the hover. See @ref
11630 * Add a new Anchorview object
11632 * @param parent The parent object
11633 * @return The new object or NULL if it cannot be created
11635 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11637 * Set the text to show in the anchorview
11639 * Sets the text of the anchorview to @p text. This text can include markup
11640 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
11641 * text that will be specially styled and react to click events, ended with
11642 * either of \</a\> or \</\>. When clicked, the anchor will emit an
11643 * "anchor,clicked" signal that you can attach a callback to with
11644 * evas_object_smart_callback_add(). The name of the anchor given in the
11645 * event info struct will be the one set in the href attribute, in this
11646 * case, anchorname.
11648 * Other markup can be used to style the text in different ways, but it's
11649 * up to the style defined in the theme which tags do what.
11650 * @deprecated use elm_object_text_set() instead.
11652 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11654 * Get the markup text set for the anchorview
11656 * Retrieves the text set on the anchorview, with markup tags included.
11658 * @param obj The anchorview object
11659 * @return The markup text set or @c NULL if nothing was set or an error
11661 * @deprecated use elm_object_text_set() instead.
11663 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11665 * Set the parent of the hover popup
11667 * Sets the parent object to use by the hover created by the anchorview
11668 * when an anchor is clicked. See @ref Hover for more details on this.
11669 * If no parent is set, the same anchorview object will be used.
11671 * @param obj The anchorview object
11672 * @param parent The object to use as parent for the hover
11674 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11676 * Get the parent of the hover popup
11678 * Get the object used as parent for the hover created by the anchorview
11679 * widget. See @ref Hover for more details on this.
11681 * @param obj The anchorview object
11682 * @return The object used as parent for the hover, NULL if none is set.
11684 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11686 * Set the style that the hover should use
11688 * When creating the popup hover, anchorview will request that it's
11689 * themed according to @p style.
11691 * @param obj The anchorview object
11692 * @param style The style to use for the underlying hover
11694 * @see elm_object_style_set()
11696 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11698 * Get the style that the hover should use
11700 * Get the style the hover created by anchorview will use.
11702 * @param obj The anchorview object
11703 * @return The style to use by the hover. NULL means the default is used.
11705 * @see elm_object_style_set()
11707 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11709 * Ends the hover popup in the anchorview
11711 * When an anchor is clicked, the anchorview widget will create a hover
11712 * object to use as a popup with user provided content. This function
11713 * terminates this popup, returning the anchorview to its normal state.
11715 * @param obj The anchorview object
11717 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11719 * Set bouncing behaviour when the scrolled content reaches an edge
11721 * Tell the internal scroller object whether it should bounce or not
11722 * when it reaches the respective edges for each axis.
11724 * @param obj The anchorview object
11725 * @param h_bounce Whether to bounce or not in the horizontal axis
11726 * @param v_bounce Whether to bounce or not in the vertical axis
11728 * @see elm_scroller_bounce_set()
11730 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
11732 * Get the set bouncing behaviour of the internal scroller
11734 * Get whether the internal scroller should bounce when the edge of each
11735 * axis is reached scrolling.
11737 * @param obj The anchorview object
11738 * @param h_bounce Pointer where to store the bounce state of the horizontal
11740 * @param v_bounce Pointer where to store the bounce state of the vertical
11743 * @see elm_scroller_bounce_get()
11745 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
11747 * Appends a custom item provider to the given anchorview
11749 * Appends the given function to the list of items providers. This list is
11750 * called, one function at a time, with the given @p data pointer, the
11751 * anchorview object and, in the @p item parameter, the item name as
11752 * referenced in its href string. Following functions in the list will be
11753 * called in order until one of them returns something different to NULL,
11754 * which should be an Evas_Object which will be used in place of the item
11757 * Items in the markup text take the form \<item relsize=16x16 vsize=full
11758 * href=item/name\>\</item\>
11760 * @param obj The anchorview object
11761 * @param func The function to add to the list of providers
11762 * @param data User data that will be passed to the callback function
11764 * @see elm_entry_item_provider_append()
11766 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);
11768 * Prepend a custom item provider to the given anchorview
11770 * Like elm_anchorview_item_provider_append(), but it adds the function
11771 * @p func to the beginning of the list, instead of the end.
11773 * @param obj The anchorview object
11774 * @param func The function to add to the list of providers
11775 * @param data User data that will be passed to the callback function
11777 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);
11779 * Remove a custom item provider from the list of the given anchorview
11781 * Removes the function and data pairing that matches @p func and @p data.
11782 * That is, unless the same function and same user data are given, the
11783 * function will not be removed from the list. This allows us to add the
11784 * same callback several times, with different @p data pointers and be
11785 * able to remove them later without conflicts.
11787 * @param obj The anchorview object
11788 * @param func The function to remove from the list
11789 * @param data The data matching the function to remove from the list
11791 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);
11798 * @defgroup Anchorblock Anchorblock
11800 * @image html img/widget/anchorblock/preview-00.png
11801 * @image latex img/widget/anchorblock/preview-00.eps
11803 * Anchorblock is for displaying text that contains markup with anchors
11804 * like <c>\<a href=1234\>something\</\></c> in it.
11806 * Besides being styled differently, the anchorblock widget provides the
11807 * necessary functionality so that clicking on these anchors brings up a
11808 * popup with user defined content such as "call", "add to contacts" or
11809 * "open web page". This popup is provided using the @ref Hover widget.
11811 * This widget emits the following signals:
11812 * @li "anchor,clicked": will be called when an anchor is clicked. The
11813 * @p event_info parameter on the callback will be a pointer of type
11814 * ::Elm_Entry_Anchorblock_Info.
11820 * Since examples are usually better than plain words, we might as well
11821 * try @ref tutorial_anchorblock_example "one".
11824 * @addtogroup Anchorblock
11828 * @typedef Elm_Entry_Anchorblock_Info
11830 * The info sent in the callback for "anchor,clicked" signals emitted by
11831 * the Anchorblock widget.
11833 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
11835 * @struct _Elm_Entry_Anchorblock_Info
11837 * The info sent in the callback for "anchor,clicked" signals emitted by
11838 * the Anchorblock widget.
11840 struct _Elm_Entry_Anchorblock_Info
11842 const char *name; /**< Name of the anchor, as indicated in its href
11844 int button; /**< The mouse button used to click on it */
11845 Evas_Object *hover; /**< The hover object to use for the popup */
11847 Evas_Coord x, y, w, h;
11848 } anchor, /**< Geometry selection of text used as anchor */
11849 hover_parent; /**< Geometry of the object used as parent by the
11851 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
11852 for content on the left side of
11853 the hover. Before calling the
11854 callback, the widget will make the
11855 necessary calculations to check
11856 which sides are fit to be set with
11857 content, based on the position the
11858 hover is activated and its distance
11859 to the edges of its parent object
11861 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
11862 the right side of the hover.
11863 See @ref hover_left */
11864 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
11865 of the hover. See @ref hover_left */
11866 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
11867 below the hover. See @ref
11871 * Add a new Anchorblock object
11873 * @param parent The parent object
11874 * @return The new object or NULL if it cannot be created
11876 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11878 * Set the text to show in the anchorblock
11880 * Sets the text of the anchorblock to @p text. This text can include markup
11881 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
11882 * of text that will be specially styled and react to click events, ended
11883 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
11884 * "anchor,clicked" signal that you can attach a callback to with
11885 * evas_object_smart_callback_add(). The name of the anchor given in the
11886 * event info struct will be the one set in the href attribute, in this
11887 * case, anchorname.
11889 * Other markup can be used to style the text in different ways, but it's
11890 * up to the style defined in the theme which tags do what.
11891 * @deprecated use elm_object_text_set() instead.
11893 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11895 * Get the markup text set for the anchorblock
11897 * Retrieves the text set on the anchorblock, with markup tags included.
11899 * @param obj The anchorblock object
11900 * @return The markup text set or @c NULL if nothing was set or an error
11902 * @deprecated use elm_object_text_set() instead.
11904 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11906 * Set the parent of the hover popup
11908 * Sets the parent object to use by the hover created by the anchorblock
11909 * when an anchor is clicked. See @ref Hover for more details on this.
11911 * @param obj The anchorblock object
11912 * @param parent The object to use as parent for the hover
11914 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11916 * Get the parent of the hover popup
11918 * Get the object used as parent for the hover created by the anchorblock
11919 * widget. See @ref Hover for more details on this.
11920 * If no parent is set, the same anchorblock object will be used.
11922 * @param obj The anchorblock object
11923 * @return The object used as parent for the hover, NULL if none is set.
11925 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11927 * Set the style that the hover should use
11929 * When creating the popup hover, anchorblock will request that it's
11930 * themed according to @p style.
11932 * @param obj The anchorblock object
11933 * @param style The style to use for the underlying hover
11935 * @see elm_object_style_set()
11937 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11939 * Get the style that the hover should use
11941 * Get the style, the hover created by anchorblock will use.
11943 * @param obj The anchorblock object
11944 * @return The style to use by the hover. NULL means the default is used.
11946 * @see elm_object_style_set()
11948 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11950 * Ends the hover popup in the anchorblock
11952 * When an anchor is clicked, the anchorblock widget will create a hover
11953 * object to use as a popup with user provided content. This function
11954 * terminates this popup, returning the anchorblock to its normal state.
11956 * @param obj The anchorblock object
11958 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11960 * Appends a custom item provider to the given anchorblock
11962 * Appends the given function to the list of items providers. This list is
11963 * called, one function at a time, with the given @p data pointer, the
11964 * anchorblock object and, in the @p item parameter, the item name as
11965 * referenced in its href string. Following functions in the list will be
11966 * called in order until one of them returns something different to NULL,
11967 * which should be an Evas_Object which will be used in place of the item
11970 * Items in the markup text take the form \<item relsize=16x16 vsize=full
11971 * href=item/name\>\</item\>
11973 * @param obj The anchorblock object
11974 * @param func The function to add to the list of providers
11975 * @param data User data that will be passed to the callback function
11977 * @see elm_entry_item_provider_append()
11979 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);
11981 * Prepend a custom item provider to the given anchorblock
11983 * Like elm_anchorblock_item_provider_append(), but it adds the function
11984 * @p func to the beginning of the list, instead of the end.
11986 * @param obj The anchorblock object
11987 * @param func The function to add to the list of providers
11988 * @param data User data that will be passed to the callback function
11990 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);
11992 * Remove a custom item provider from the list of the given anchorblock
11994 * Removes the function and data pairing that matches @p func and @p data.
11995 * That is, unless the same function and same user data are given, the
11996 * function will not be removed from the list. This allows us to add the
11997 * same callback several times, with different @p data pointers and be
11998 * able to remove them later without conflicts.
12000 * @param obj The anchorblock object
12001 * @param func The function to remove from the list
12002 * @param data The data matching the function to remove from the list
12004 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);
12010 * @defgroup Bubble Bubble
12012 * @image html img/widget/bubble/preview-00.png
12013 * @image latex img/widget/bubble/preview-00.eps
12014 * @image html img/widget/bubble/preview-01.png
12015 * @image latex img/widget/bubble/preview-01.eps
12016 * @image html img/widget/bubble/preview-02.png
12017 * @image latex img/widget/bubble/preview-02.eps
12019 * @brief The Bubble is a widget to show text similar to how speech is
12020 * represented in comics.
12022 * The bubble widget contains 5 important visual elements:
12023 * @li The frame is a rectangle with rounded edjes and an "arrow".
12024 * @li The @p icon is an image to which the frame's arrow points to.
12025 * @li The @p label is a text which appears to the right of the icon if the
12026 * corner is "top_left" or "bottom_left" and is right aligned to the frame
12028 * @li The @p info is a text which appears to the right of the label. Info's
12029 * font is of a ligther color than label.
12030 * @li The @p content is an evas object that is shown inside the frame.
12032 * The position of the arrow, icon, label and info depends on which corner is
12033 * selected. The four available corners are:
12034 * @li "top_left" - Default
12036 * @li "bottom_left"
12037 * @li "bottom_right"
12039 * Signals that you can add callbacks for are:
12040 * @li "clicked" - This is called when a user has clicked the bubble.
12042 * For an example of using a buble see @ref bubble_01_example_page "this".
12047 * Add a new bubble to the parent
12049 * @param parent The parent object
12050 * @return The new object or NULL if it cannot be created
12052 * This function adds a text bubble to the given parent evas object.
12054 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12056 * Set the label of the bubble
12058 * @param obj The bubble object
12059 * @param label The string to set in the label
12061 * This function sets the title of the bubble. Where this appears depends on
12062 * the selected corner.
12063 * @deprecated use elm_object_text_set() instead.
12065 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12067 * Get the label of the bubble
12069 * @param obj The bubble object
12070 * @return The string of set in the label
12072 * This function gets the title of the bubble.
12073 * @deprecated use elm_object_text_get() instead.
12075 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12077 * Set the info of the bubble
12079 * @param obj The bubble object
12080 * @param info The given info about the bubble
12082 * This function sets the info of the bubble. Where this appears depends on
12083 * the selected corner.
12084 * @deprecated use elm_object_text_part_set() instead. (with "info" as the parameter).
12086 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
12088 * Get the info of the bubble
12090 * @param obj The bubble object
12092 * @return The "info" string of the bubble
12094 * This function gets the info text.
12095 * @deprecated use elm_object_text_part_get() instead. (with "info" as the parameter).
12097 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12099 * Set the content to be shown in the bubble
12101 * Once the content object is set, a previously set one will be deleted.
12102 * If you want to keep the old content object, use the
12103 * elm_bubble_content_unset() function.
12105 * @param obj The bubble object
12106 * @param content The given content of the bubble
12108 * This function sets the content shown on the middle of the bubble.
12110 EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12112 * Get the content shown in the bubble
12114 * Return the content object which is set for this widget.
12116 * @param obj The bubble object
12117 * @return The content that is being used
12119 EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12121 * Unset the content shown in the bubble
12123 * Unparent and return the content object which was set for this widget.
12125 * @param obj The bubble object
12126 * @return The content that was being used
12128 EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12130 * Set the icon of the bubble
12132 * Once the icon object is set, a previously set one will be deleted.
12133 * If you want to keep the old content object, use the
12134 * elm_icon_content_unset() function.
12136 * @param obj The bubble object
12137 * @param icon The given icon for the bubble
12139 EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12141 * Get the icon of the bubble
12143 * @param obj The bubble object
12144 * @return The icon for the bubble
12146 * This function gets the icon shown on the top left of bubble.
12148 EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12150 * Unset the icon of the bubble
12152 * Unparent and return the icon object which was set for this widget.
12154 * @param obj The bubble object
12155 * @return The icon that was being used
12157 EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12159 * Set the corner of the bubble
12161 * @param obj The bubble object.
12162 * @param corner The given corner for the bubble.
12164 * This function sets the corner of the bubble. The corner will be used to
12165 * determine where the arrow in the frame points to and where label, icon and
12168 * Possible values for corner are:
12169 * @li "top_left" - Default
12171 * @li "bottom_left"
12172 * @li "bottom_right"
12174 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
12176 * Get the corner of the bubble
12178 * @param obj The bubble object.
12179 * @return The given corner for the bubble.
12181 * This function gets the selected corner of the bubble.
12183 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12185 EINA_DEPRECATED EAPI void elm_bubble_sweep_layout_set(Evas_Object *obj, Evas_Object *sweep) EINA_ARG_NONNULL(1);
12186 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_sweep_layout_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12193 * @defgroup Photo Photo
12195 * For displaying the photo of a person (contact). Simple, yet
12196 * with a very specific purpose.
12198 * Signals that you can add callbacks for are:
12200 * "clicked" - This is called when a user has clicked the photo
12201 * "drag,start" - Someone started dragging the image out of the object
12202 * "drag,end" - Dragged item was dropped (somewhere)
12208 * Add a new photo to the parent
12210 * @param parent The parent object
12211 * @return The new object or NULL if it cannot be created
12215 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12218 * Set the file that will be used as photo
12220 * @param obj The photo object
12221 * @param file The path to file that will be used as photo
12223 * @return (1 = success, 0 = error)
12227 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12230 * Set the size that will be used on the photo
12232 * @param obj The photo object
12233 * @param size The size that the photo will be
12237 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12240 * Set if the photo should be completely visible or not.
12242 * @param obj The photo object
12243 * @param fill if true the photo will be completely visible
12247 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12250 * Set editability of the photo.
12252 * An editable photo can be dragged to or from, and can be cut or
12253 * pasted too. Note that pasting an image or dropping an item on
12254 * the image will delete the existing content.
12256 * @param obj The photo object.
12257 * @param set To set of clear editablity.
12259 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12265 /* gesture layer */
12267 * @defgroup Elm_Gesture_Layer Gesture Layer
12268 * Gesture Layer Usage:
12270 * Use Gesture Layer to detect gestures.
12271 * The advantage is that you don't have to implement
12272 * gesture detection, just set callbacks of gesture state.
12273 * By using gesture layer we make standard interface.
12275 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12276 * with a parent object parameter.
12277 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12278 * call. Usually with same object as target (2nd parameter).
12280 * Now you need to tell gesture layer what gestures you follow.
12281 * This is done with @ref elm_gesture_layer_cb_set call.
12282 * By setting the callback you actually saying to gesture layer:
12283 * I would like to know when the gesture @ref Elm_Gesture_Types
12284 * switches to state @ref Elm_Gesture_State.
12286 * Next, you need to implement the actual action that follows the input
12287 * in your callback.
12289 * Note that if you like to stop being reported about a gesture, just set
12290 * all callbacks referring this gesture to NULL.
12291 * (again with @ref elm_gesture_layer_cb_set)
12293 * The information reported by gesture layer to your callback is depending
12294 * on @ref Elm_Gesture_Types:
12295 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12296 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12297 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12299 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12300 * @ref ELM_GESTURE_MOMENTUM.
12302 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12303 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12304 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12305 * Note that we consider a flick as a line-gesture that should be completed
12306 * in flick-time-limit as defined in @ref Config.
12308 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12310 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12313 * Gesture Layer Tweaks:
12315 * Note that line, flick, gestures can start without the need to remove fingers from surface.
12316 * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
12318 * Setting glayer_continues_enable to false in @ref Config will change this behavior
12319 * so gesture starts when user touches (a *DOWN event) touch-surface
12320 * and ends when no fingers touches surface (a *UP event).
12324 * @enum _Elm_Gesture_Types
12325 * Enum of supported gesture types.
12326 * @ingroup Elm_Gesture_Layer
12328 enum _Elm_Gesture_Types
12330 ELM_GESTURE_FIRST = 0,
12332 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12333 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12334 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12335 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12337 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12339 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12340 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12342 ELM_GESTURE_ZOOM, /**< Zoom */
12343 ELM_GESTURE_ROTATE, /**< Rotate */
12349 * @typedef Elm_Gesture_Types
12350 * gesture types enum
12351 * @ingroup Elm_Gesture_Layer
12353 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12356 * @enum _Elm_Gesture_State
12357 * Enum of gesture states.
12358 * @ingroup Elm_Gesture_Layer
12360 enum _Elm_Gesture_State
12362 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12363 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
12364 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
12365 ELM_GESTURE_STATE_END, /**< Gesture completed */
12366 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
12370 * @typedef Elm_Gesture_State
12371 * gesture states enum
12372 * @ingroup Elm_Gesture_Layer
12374 typedef enum _Elm_Gesture_State Elm_Gesture_State;
12377 * @struct _Elm_Gesture_Taps_Info
12378 * Struct holds taps info for user
12379 * @ingroup Elm_Gesture_Layer
12381 struct _Elm_Gesture_Taps_Info
12383 Evas_Coord x, y; /**< Holds center point between fingers */
12384 unsigned int n; /**< Number of fingers tapped */
12385 unsigned int timestamp; /**< event timestamp */
12389 * @typedef Elm_Gesture_Taps_Info
12390 * holds taps info for user
12391 * @ingroup Elm_Gesture_Layer
12393 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12396 * @struct _Elm_Gesture_Momentum_Info
12397 * Struct holds momentum info for user
12398 * x1 and y1 are not necessarily in sync
12399 * x1 holds x value of x direction starting point
12400 * and same holds for y1.
12401 * This is noticeable when doing V-shape movement
12402 * @ingroup Elm_Gesture_Layer
12404 struct _Elm_Gesture_Momentum_Info
12405 { /* Report line ends, timestamps, and momentum computed */
12406 Evas_Coord x1; /**< Final-swipe direction starting point on X */
12407 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12408 Evas_Coord x2; /**< Final-swipe direction ending point on X */
12409 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
12411 unsigned int tx; /**< Timestamp of start of final x-swipe */
12412 unsigned int ty; /**< Timestamp of start of final y-swipe */
12414 Evas_Coord mx; /**< Momentum on X */
12415 Evas_Coord my; /**< Momentum on Y */
12417 unsigned int n; /**< Number of fingers */
12421 * @typedef Elm_Gesture_Momentum_Info
12422 * holds momentum info for user
12423 * @ingroup Elm_Gesture_Layer
12425 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12428 * @struct _Elm_Gesture_Line_Info
12429 * Struct holds line info for user
12430 * @ingroup Elm_Gesture_Layer
12432 struct _Elm_Gesture_Line_Info
12433 { /* Report line ends, timestamps, and momentum computed */
12434 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12435 /* FIXME should be radians, bot degrees */
12436 double angle; /**< Angle (direction) of lines */
12440 * @typedef Elm_Gesture_Line_Info
12441 * Holds line info for user
12442 * @ingroup Elm_Gesture_Layer
12444 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12447 * @struct _Elm_Gesture_Zoom_Info
12448 * Struct holds zoom info for user
12449 * @ingroup Elm_Gesture_Layer
12451 struct _Elm_Gesture_Zoom_Info
12453 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12454 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12455 double zoom; /**< Zoom value: 1.0 means no zoom */
12456 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12460 * @typedef Elm_Gesture_Zoom_Info
12461 * Holds zoom info for user
12462 * @ingroup Elm_Gesture_Layer
12464 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12467 * @struct _Elm_Gesture_Rotate_Info
12468 * Struct holds rotation info for user
12469 * @ingroup Elm_Gesture_Layer
12471 struct _Elm_Gesture_Rotate_Info
12473 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12474 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12475 double base_angle; /**< Holds start-angle */
12476 double angle; /**< Rotation value: 0.0 means no rotation */
12477 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12481 * @typedef Elm_Gesture_Rotate_Info
12482 * Holds rotation info for user
12483 * @ingroup Elm_Gesture_Layer
12485 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12488 * @typedef Elm_Gesture_Event_Cb
12489 * User callback used to stream gesture info from gesture layer
12490 * @param data user data
12491 * @param event_info gesture report info
12492 * Returns a flag field to be applied on the causing event.
12493 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12494 * upon the event, in an irreversible way.
12496 * @ingroup Elm_Gesture_Layer
12498 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12501 * Use function to set callbacks to be notified about
12502 * change of state of gesture.
12503 * When a user registers a callback with this function
12504 * this means this gesture has to be tested.
12506 * When ALL callbacks for a gesture are set to NULL
12507 * it means user isn't interested in gesture-state
12508 * and it will not be tested.
12510 * @param obj Pointer to gesture-layer.
12511 * @param idx The gesture you would like to track its state.
12512 * @param cb callback function pointer.
12513 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
12514 * @param data user info to be sent to callback (usually, Smart Data)
12516 * @ingroup Elm_Gesture_Layer
12518 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);
12521 * Call this function to get repeat-events settings.
12523 * @param obj Pointer to gesture-layer.
12525 * @return repeat events settings.
12526 * @see elm_gesture_layer_hold_events_set()
12527 * @ingroup Elm_Gesture_Layer
12529 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12532 * This function called in order to make gesture-layer repeat events.
12533 * Set this of you like to get the raw events only if gestures were not detected.
12534 * Clear this if you like gesture layer to fwd events as testing gestures.
12536 * @param obj Pointer to gesture-layer.
12537 * @param r Repeat: TRUE/FALSE
12539 * @ingroup Elm_Gesture_Layer
12541 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
12544 * This function sets step-value for zoom action.
12545 * Set step to any positive value.
12546 * Cancel step setting by setting to 0.0
12548 * @param obj Pointer to gesture-layer.
12549 * @param s new zoom step value.
12551 * @ingroup Elm_Gesture_Layer
12553 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12556 * This function sets step-value for rotate action.
12557 * Set step to any positive value.
12558 * Cancel step setting by setting to 0.0
12560 * @param obj Pointer to gesture-layer.
12561 * @param s new roatate step value.
12563 * @ingroup Elm_Gesture_Layer
12565 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12568 * This function called to attach gesture-layer to an Evas_Object.
12569 * @param obj Pointer to gesture-layer.
12570 * @param t Pointer to underlying object (AKA Target)
12572 * @return TRUE, FALSE on success, failure.
12574 * @ingroup Elm_Gesture_Layer
12576 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
12579 * Call this function to construct a new gesture-layer object.
12580 * This does not activate the gesture layer. You have to
12581 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
12583 * @param parent the parent object.
12585 * @return Pointer to new gesture-layer object.
12587 * @ingroup Elm_Gesture_Layer
12589 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12592 * @defgroup Thumb Thumb
12594 * @image html img/widget/thumb/preview-00.png
12595 * @image latex img/widget/thumb/preview-00.eps
12597 * A thumb object is used for displaying the thumbnail of an image or video.
12598 * You must have compiled Elementary with Ethumb_Client support and the DBus
12599 * service must be present and auto-activated in order to have thumbnails to
12602 * Once the thumbnail object becomes visible, it will check if there is a
12603 * previously generated thumbnail image for the file set on it. If not, it
12604 * will start generating this thumbnail.
12606 * Different config settings will cause different thumbnails to be generated
12607 * even on the same file.
12609 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
12610 * Ethumb documentation to change this path, and to see other configuration
12613 * Signals that you can add callbacks for are:
12615 * - "clicked" - This is called when a user has clicked the thumb without dragging
12617 * - "clicked,double" - This is called when a user has double-clicked the thumb.
12618 * - "press" - This is called when a user has pressed down the thumb.
12619 * - "generate,start" - The thumbnail generation started.
12620 * - "generate,stop" - The generation process stopped.
12621 * - "generate,error" - The generation failed.
12622 * - "load,error" - The thumbnail image loading failed.
12624 * available styles:
12628 * An example of use of thumbnail:
12630 * - @ref thumb_example_01
12634 * @addtogroup Thumb
12639 * @enum _Elm_Thumb_Animation_Setting
12640 * @typedef Elm_Thumb_Animation_Setting
12642 * Used to set if a video thumbnail is animating or not.
12646 typedef enum _Elm_Thumb_Animation_Setting
12648 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
12649 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
12650 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
12651 ELM_THUMB_ANIMATION_LAST
12652 } Elm_Thumb_Animation_Setting;
12655 * Add a new thumb object to the parent.
12657 * @param parent The parent object.
12658 * @return The new object or NULL if it cannot be created.
12660 * @see elm_thumb_file_set()
12661 * @see elm_thumb_ethumb_client_get()
12665 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12667 * Reload thumbnail if it was generated before.
12669 * @param obj The thumb object to reload
12671 * This is useful if the ethumb client configuration changed, like its
12672 * size, aspect or any other property one set in the handle returned
12673 * by elm_thumb_ethumb_client_get().
12675 * If the options didn't change, the thumbnail won't be generated again, but
12676 * the old one will still be used.
12678 * @see elm_thumb_file_set()
12682 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
12684 * Set the file that will be used as thumbnail.
12686 * @param obj The thumb object.
12687 * @param file The path to file that will be used as thumb.
12688 * @param key The key used in case of an EET file.
12690 * The file can be an image or a video (in that case, acceptable extensions are:
12691 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
12692 * function elm_thumb_animate().
12694 * @see elm_thumb_file_get()
12695 * @see elm_thumb_reload()
12696 * @see elm_thumb_animate()
12700 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
12702 * Get the image or video path and key used to generate the thumbnail.
12704 * @param obj The thumb object.
12705 * @param file Pointer to filename.
12706 * @param key Pointer to key.
12708 * @see elm_thumb_file_set()
12709 * @see elm_thumb_path_get()
12713 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12715 * Get the path and key to the image or video generated by ethumb.
12717 * One just need to make sure that the thumbnail was generated before getting
12718 * its path; otherwise, the path will be NULL. One way to do that is by asking
12719 * for the path when/after the "generate,stop" smart callback is called.
12721 * @param obj The thumb object.
12722 * @param file Pointer to thumb path.
12723 * @param key Pointer to thumb key.
12725 * @see elm_thumb_file_get()
12729 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12731 * Set the animation state for the thumb object. If its content is an animated
12732 * video, you may start/stop the animation or tell it to play continuously and
12735 * @param obj The thumb object.
12736 * @param setting The animation setting.
12738 * @see elm_thumb_file_set()
12742 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
12744 * Get the animation state for the thumb object.
12746 * @param obj The thumb object.
12747 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
12750 * @see elm_thumb_animate_set()
12754 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12756 * Get the ethumb_client handle so custom configuration can be made.
12758 * @return Ethumb_Client instance or NULL.
12760 * This must be called before the objects are created to be sure no object is
12761 * visible and no generation started.
12763 * Example of usage:
12766 * #include <Elementary.h>
12767 * #ifndef ELM_LIB_QUICKLAUNCH
12769 * elm_main(int argc, char **argv)
12771 * Ethumb_Client *client;
12773 * elm_need_ethumb();
12777 * client = elm_thumb_ethumb_client_get();
12780 * ERR("could not get ethumb_client");
12783 * ethumb_client_size_set(client, 100, 100);
12784 * ethumb_client_crop_align_set(client, 0.5, 0.5);
12787 * // Create elm_thumb objects here
12797 * @note There's only one client handle for Ethumb, so once a configuration
12798 * change is done to it, any other request for thumbnails (for any thumbnail
12799 * object) will use that configuration. Thus, this configuration is global.
12803 EAPI void *elm_thumb_ethumb_client_get(void);
12805 * Get the ethumb_client connection state.
12807 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
12810 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
12812 * Make the thumbnail 'editable'.
12814 * @param obj Thumb object.
12815 * @param set Turn on or off editability. Default is @c EINA_FALSE.
12817 * This means the thumbnail is a valid drag target for drag and drop, and can be
12818 * cut or pasted too.
12820 * @see elm_thumb_editable_get()
12824 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
12825 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12827 * Make the thumbnail 'editable'.
12829 * @param obj Thumb object.
12830 * @return Editability.
12832 * This means the thumbnail is a valid drag target for drag and drop, and can be
12833 * cut or pasted too.
12835 * @see elm_thumb_editable_set()
12839 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12847 * @defgroup Web Web
12849 * @image html img/widget/web/preview-00.png
12850 * @image latex img/widget/web/preview-00.eps
12852 * A web object is used for displaying web pages (HTML/CSS/JS)
12853 * using WebKit-EFL. You must have compiled Elementary with
12856 * Signals that you can add callbacks for are:
12857 * @li "download,request": A file download has been requested. Event info is
12858 * a pointer to a Elm_Web_Download
12859 * @li "editorclient,contents,changed": Editor client's contents changed
12860 * @li "editorclient,selection,changed": Editor client's selection changed
12861 * @li "frame,created": A new frame was created. Event info is an
12862 * Evas_Object which can be handled with WebKit's ewk_frame API
12863 * @li "icon,received": An icon was received by the main frame
12864 * @li "inputmethod,changed": Input method changed. Event info is an
12865 * Eina_Bool indicating whether it's enabled or not
12866 * @li "js,windowobject,clear": JS window object has been cleared
12867 * @li "link,hover,in": Mouse cursor is hovering over a link. Event info
12868 * is a char *link[2], where the first string contains the URL the link
12869 * points to, and the second one the title of the link
12870 * @li "link,hover,out": Mouse cursor left the link
12871 * @li "load,document,finished": Loading of a document finished. Event info
12872 * is the frame that finished loading
12873 * @li "load,error": Load failed. Event info is a pointer to
12874 * Elm_Web_Frame_Load_Error
12875 * @li "load,finished": Load finished. Event info is NULL on success, on
12876 * error it's a pointer to Elm_Web_Frame_Load_Error
12877 * @li "load,newwindow,show": A new window was created and is ready to be
12879 * @li "load,progress": Overall load progress. Event info is a pointer to
12880 * a double containing a value between 0.0 and 1.0
12881 * @li "load,provisional": Started provisional load
12882 * @li "load,started": Loading of a document started
12883 * @li "menubar,visible,get": Queries if the menubar is visible. Event info
12884 * is a pointer to Eina_Bool where the callback should set EINA_TRUE if
12885 * the menubar is visible, or EINA_FALSE in case it's not
12886 * @li "menubar,visible,set": Informs menubar visibility. Event info is
12887 * an Eina_Bool indicating the visibility
12888 * @li "popup,created": A dropdown widget was activated, requesting its
12889 * popup menu to be created. Event info is a pointer to Elm_Web_Menu
12890 * @li "popup,willdelete": The web object is ready to destroy the popup
12891 * object created. Event info is a pointer to Elm_Web_Menu
12892 * @li "ready": Page is fully loaded
12893 * @li "scrollbars,visible,get": Queries visibility of scrollbars. Event
12894 * info is a pointer to Eina_Bool where the visibility state should be set
12895 * @li "scrollbars,visible,set": Informs scrollbars visibility. Event info
12896 * is an Eina_Bool with the visibility state set
12897 * @li "statusbar,text,set": Text of the statusbar changed. Even info is
12898 * a string with the new text
12899 * @li "statusbar,visible,get": Queries visibility of the status bar.
12900 * Event info is a pointer to Eina_Bool where the visibility state should be
12902 * @li "statusbar,visible,set": Informs statusbar visibility. Event info is
12903 * an Eina_Bool with the visibility value
12904 * @li "title,changed": Title of the main frame changed. Event info is a
12905 * string with the new title
12906 * @li "toolbars,visible,get": Queries visibility of toolbars. Event info
12907 * is a pointer to Eina_Bool where the visibility state should be set
12908 * @li "toolbars,visible,set": Informs the visibility of toolbars. Event
12909 * info is an Eina_Bool with the visibility state
12910 * @li "tooltip,text,set": Show and set text of a tooltip. Event info is
12911 * a string with the text to show
12912 * @li "uri,changed": URI of the main frame changed. Event info is a string
12914 * @li "view,resized": The web object internal's view changed sized
12915 * @li "windows,close,request": A JavaScript request to close the current
12916 * window was requested
12917 * @li "zoom,animated,end": Animated zoom finished
12919 * available styles:
12922 * An example of use of web:
12924 * - @ref web_example_01 TBD
12933 * Structure used to report load errors.
12935 * Load errors are reported as signal by elm_web. All the strings are
12936 * temporary references and should @b not be used after the signal
12937 * callback returns. If it's required, make copies with strdup() or
12938 * eina_stringshare_add() (they are not even guaranteed to be
12939 * stringshared, so must use eina_stringshare_add() and not
12940 * eina_stringshare_ref()).
12942 typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
12944 * Structure used to report load errors.
12946 * Load errors are reported as signal by elm_web. All the strings are
12947 * temporary references and should @b not be used after the signal
12948 * callback returns. If it's required, make copies with strdup() or
12949 * eina_stringshare_add() (they are not even guaranteed to be
12950 * stringshared, so must use eina_stringshare_add() and not
12951 * eina_stringshare_ref()).
12953 struct _Elm_Web_Frame_Load_Error
12955 int code; /**< Numeric error code */
12956 Eina_Bool is_cancellation; /**< Error produced by cancelling a request */
12957 const char *domain; /**< Error domain name */
12958 const char *description; /**< Error description (already localized) */
12959 const char *failing_url; /**< The URL that failed to load */
12960 Evas_Object *frame; /**< Frame object that produced the error */
12964 * The possibles types that the items in a menu can be
12966 typedef enum _Elm_Web_Menu_Item_Type
12968 ELM_WEB_MENU_SEPARATOR,
12969 ELM_WEB_MENU_GROUP,
12970 ELM_WEB_MENU_OPTION
12971 } Elm_Web_Menu_Item_Type;
12974 * Structure describing the items in a menu
12976 typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item;
12978 * Structure describing the items in a menu
12980 struct _Elm_Web_Menu_Item
12982 const char *text; /**< The text for the item */
12983 Elm_Web_Menu_Item_Type type; /**< The type of the item */
12987 * Structure describing the menu of a popup
12989 * This structure will be passed as the @c event_info for the "popup,create"
12990 * signal, which is emitted when a dropdown menu is opened. Users wanting
12991 * to handle these popups by themselves should listen to this signal and
12992 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
12993 * property as @c EINA_FALSE means that the user will not handle the popup
12994 * and the default implementation will be used.
12996 * When the popup is ready to be dismissed, a "popup,willdelete" signal
12997 * will be emitted to notify the user that it can destroy any objects and
12998 * free all data related to it.
13000 * @see elm_web_popup_selected_set()
13001 * @see elm_web_popup_destroy()
13003 typedef struct _Elm_Web_Menu Elm_Web_Menu;
13005 * Structure describing the menu of a popup
13007 * This structure will be passed as the @c event_info for the "popup,create"
13008 * signal, which is emitted when a dropdown menu is opened. Users wanting
13009 * to handle these popups by themselves should listen to this signal and
13010 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13011 * property as @c EINA_FALSE means that the user will not handle the popup
13012 * and the default implementation will be used.
13014 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13015 * will be emitted to notify the user that it can destroy any objects and
13016 * free all data related to it.
13018 * @see elm_web_popup_selected_set()
13019 * @see elm_web_popup_destroy()
13021 struct _Elm_Web_Menu
13023 Eina_List *items; /**< List of #Elm_Web_Menu_Item */
13024 int x; /**< The X position of the popup, relative to the elm_web object */
13025 int y; /**< The Y position of the popup, relative to the elm_web object */
13026 int width; /**< Width of the popup menu */
13027 int height; /**< Height of the popup menu */
13029 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. */
13032 typedef struct _Elm_Web_Download Elm_Web_Download;
13033 struct _Elm_Web_Download
13039 * Types of zoom available.
13041 typedef enum _Elm_Web_Zoom_Mode
13043 ELM_WEB_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_web_zoom_set */
13044 ELM_WEB_ZOOM_MODE_AUTO_FIT, /**< Zoom until content fits in web object */
13045 ELM_WEB_ZOOM_MODE_AUTO_FILL, /**< Zoom until content fills web object */
13046 ELM_WEB_ZOOM_MODE_LAST
13047 } Elm_Web_Zoom_Mode;
13049 * Opaque handler containing the features (such as statusbar, menubar, etc)
13050 * that are to be set on a newly requested window.
13052 typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
13054 * Callback type for the create_window hook.
13056 * The function parameters are:
13057 * @li @p data User data pointer set when setting the hook function
13058 * @li @p obj The elm_web object requesting the new window
13059 * @li @p js Set to @c EINA_TRUE if the request was originated from
13060 * JavaScript. @c EINA_FALSE otherwise.
13061 * @li @p window_features A pointer of #Elm_Web_Window_Features indicating
13062 * the features requested for the new window.
13064 * The returned value of the function should be the @c elm_web widget where
13065 * the request will be loaded. That is, if a new window or tab is created,
13066 * the elm_web widget in it should be returned, and @b NOT the window
13068 * Returning @c NULL should cancel the request.
13070 * @see elm_web_window_create_hook_set()
13072 typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
13074 * Callback type for the JS alert hook.
13076 * The function parameters are:
13077 * @li @p data User data pointer set when setting the hook function
13078 * @li @p obj The elm_web object requesting the new window
13079 * @li @p message The message to show in the alert dialog
13081 * The function should return the object representing the alert dialog.
13082 * Elm_Web will run a second main loop to handle the dialog and normal
13083 * flow of the application will be restored when the object is deleted, so
13084 * the user should handle the popup properly in order to delete the object
13085 * when the action is finished.
13086 * If the function returns @c NULL the popup will be ignored.
13088 * @see elm_web_dialog_alert_hook_set()
13090 typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
13092 * Callback type for the JS confirm hook.
13094 * The function parameters are:
13095 * @li @p data User data pointer set when setting the hook function
13096 * @li @p obj The elm_web object requesting the new window
13097 * @li @p message The message to show in the confirm dialog
13098 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13099 * the user selected @c Ok, @c EINA_FALSE otherwise.
13101 * The function should return the object representing the confirm dialog.
13102 * Elm_Web will run a second main loop to handle the dialog and normal
13103 * flow of the application will be restored when the object is deleted, so
13104 * the user should handle the popup properly in order to delete the object
13105 * when the action is finished.
13106 * If the function returns @c NULL the popup will be ignored.
13108 * @see elm_web_dialog_confirm_hook_set()
13110 typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
13112 * Callback type for the JS prompt hook.
13114 * The function parameters are:
13115 * @li @p data User data pointer set when setting the hook function
13116 * @li @p obj The elm_web object requesting the new window
13117 * @li @p message The message to show in the prompt dialog
13118 * @li @p def_value The default value to present the user in the entry
13119 * @li @p value Pointer where to store the value given by the user. Must
13120 * be a malloc'ed string or @c NULL if the user cancelled the popup.
13121 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13122 * the user selected @c Ok, @c EINA_FALSE otherwise.
13124 * The function should return the object representing the prompt dialog.
13125 * Elm_Web will run a second main loop to handle the dialog and normal
13126 * flow of the application will be restored when the object is deleted, so
13127 * the user should handle the popup properly in order to delete the object
13128 * when the action is finished.
13129 * If the function returns @c NULL the popup will be ignored.
13131 * @see elm_web_dialog_prompt_hook_set()
13133 typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret);
13135 * Callback type for the JS file selector hook.
13137 * The function parameters are:
13138 * @li @p data User data pointer set when setting the hook function
13139 * @li @p obj The elm_web object requesting the new window
13140 * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
13141 * @li @p accept_types Mime types accepted
13142 * @li @p selected Pointer where to store the list of malloc'ed strings
13143 * containing the path to each file selected. Must be @c NULL if the file
13144 * dialog is cancelled
13145 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13146 * the user selected @c Ok, @c EINA_FALSE otherwise.
13148 * The function should return the object representing the file selector
13150 * Elm_Web will run a second main loop to handle the dialog and normal
13151 * flow of the application will be restored when the object is deleted, so
13152 * the user should handle the popup properly in order to delete the object
13153 * when the action is finished.
13154 * If the function returns @c NULL the popup will be ignored.
13156 * @see elm_web_dialog_file selector_hook_set()
13158 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);
13160 * Callback type for the JS console message hook.
13162 * When a console message is added from JavaScript, any set function to the
13163 * console message hook will be called for the user to handle. There is no
13164 * default implementation of this hook.
13166 * The function parameters are:
13167 * @li @p data User data pointer set when setting the hook function
13168 * @li @p obj The elm_web object that originated the message
13169 * @li @p message The message sent
13170 * @li @p line_number The line number
13171 * @li @p source_id Source id
13173 * @see elm_web_console_message_hook_set()
13175 typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
13177 * Add a new web object to the parent.
13179 * @param parent The parent object.
13180 * @return The new object or NULL if it cannot be created.
13182 * @see elm_web_uri_set()
13183 * @see elm_web_webkit_view_get()
13185 EAPI Evas_Object *elm_web_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13188 * Get internal ewk_view object from web object.
13190 * Elementary may not provide some low level features of EWebKit,
13191 * instead of cluttering the API with proxy methods we opted to
13192 * return the internal reference. Be careful using it as it may
13193 * interfere with elm_web behavior.
13195 * @param obj The web object.
13196 * @return The internal ewk_view object or NULL if it does not
13197 * exist. (Failure to create or Elementary compiled without
13200 * @see elm_web_add()
13202 EAPI Evas_Object *elm_web_webkit_view_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13205 * Sets the function to call when a new window is requested
13207 * This hook will be called when a request to create a new window is
13208 * issued from the web page loaded.
13209 * There is no default implementation for this feature, so leaving this
13210 * unset or passing @c NULL in @p func will prevent new windows from
13213 * @param obj The web object where to set the hook function
13214 * @param func The hook function to be called when a window is requested
13215 * @param data User data
13217 EAPI void elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data);
13219 * Sets the function to call when an alert dialog
13221 * This hook will be called when a JavaScript alert dialog is requested.
13222 * If no function is set or @c NULL is passed in @p func, the default
13223 * implementation will take place.
13225 * @param obj The web object where to set the hook function
13226 * @param func The callback function to be used
13227 * @param data User data
13229 * @see elm_web_inwin_mode_set()
13231 EAPI void elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data);
13233 * Sets the function to call when an confirm dialog
13235 * This hook will be called when a JavaScript confirm dialog is requested.
13236 * If no function is set or @c NULL is passed in @p func, the default
13237 * implementation will take place.
13239 * @param obj The web object where to set the hook function
13240 * @param func The callback function to be used
13241 * @param data User data
13243 * @see elm_web_inwin_mode_set()
13245 EAPI void elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data);
13247 * Sets the function to call when an prompt dialog
13249 * This hook will be called when a JavaScript prompt dialog is requested.
13250 * If no function is set or @c NULL is passed in @p func, the default
13251 * implementation will take place.
13253 * @param obj The web object where to set the hook function
13254 * @param func The callback function to be used
13255 * @param data User data
13257 * @see elm_web_inwin_mode_set()
13259 EAPI void elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data);
13261 * Sets the function to call when an file selector dialog
13263 * This hook will be called when a JavaScript file selector dialog is
13265 * If no function is set or @c NULL is passed in @p func, the default
13266 * implementation will take place.
13268 * @param obj The web object where to set the hook function
13269 * @param func The callback function to be used
13270 * @param data User data
13272 * @see elm_web_inwin_mode_set()
13274 EAPI void elm_web_dialog_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data);
13276 * Sets the function to call when a console message is emitted from JS
13278 * This hook will be called when a console message is emitted from
13279 * JavaScript. There is no default implementation for this feature.
13281 * @param obj The web object where to set the hook function
13282 * @param func The callback function to be used
13283 * @param data User data
13285 EAPI void elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data);
13287 * Gets the status of the tab propagation
13289 * @param obj The web object to query
13290 * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
13292 * @see elm_web_tab_propagate_set()
13294 EAPI Eina_Bool elm_web_tab_propagate_get(const Evas_Object *obj);
13296 * Sets whether to use tab propagation
13298 * If tab propagation is enabled, whenever the user presses the Tab key,
13299 * Elementary will handle it and switch focus to the next widget.
13300 * The default value is disabled, where WebKit will handle the Tab key to
13301 * cycle focus though its internal objects, jumping to the next widget
13302 * only when that cycle ends.
13304 * @param obj The web object
13305 * @param propagate Whether to propagate Tab keys to Elementary or not
13307 EAPI void elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate);
13309 * Sets the URI for the web object
13311 * It must be a full URI, with resource included, in the form
13312 * http://www.enlightenment.org or file:///tmp/something.html
13314 * @param obj The web object
13315 * @param uri The URI to set
13316 * @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
13318 EAPI Eina_Bool elm_web_uri_set(Evas_Object *obj, const char *uri);
13320 * Gets the current URI for the object
13322 * The returned string must not be freed and is guaranteed to be
13325 * @param obj The web object
13326 * @return A stringshared internal string with the current URI, or NULL on
13329 EAPI const char *elm_web_uri_get(const Evas_Object *obj);
13331 * Gets the current title
13333 * The returned string must not be freed and is guaranteed to be
13336 * @param obj The web object
13337 * @return A stringshared internal string with the current title, or NULL on
13340 EAPI const char *elm_web_title_get(const Evas_Object *obj);
13342 * Sets the background color to be used by the web object
13344 * This is the color that will be used by default when the loaded page
13345 * does not set it's own. Color values are pre-multiplied.
13347 * @param obj The web object
13348 * @param r Red component
13349 * @param g Green component
13350 * @param b Blue component
13351 * @param a Alpha component
13353 EAPI void elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a);
13355 * Gets the background color to be used by the web object
13357 * This is the color that will be used by default when the loaded page
13358 * does not set it's own. Color values are pre-multiplied.
13360 * @param obj The web object
13361 * @param r Red component
13362 * @param g Green component
13363 * @param b Blue component
13364 * @param a Alpha component
13366 EAPI void elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
13368 * Gets a copy of the currently selected text
13370 * The string returned must be freed by the user when it's done with it.
13372 * @param obj The web object
13373 * @return A newly allocated string, or NULL if nothing is selected or an
13376 EAPI char *elm_view_selection_get(const Evas_Object *obj);
13378 * Tells the web object which index in the currently open popup was selected
13380 * When the user handles the popup creation from the "popup,created" signal,
13381 * it needs to tell the web object which item was selected by calling this
13382 * function with the index corresponding to the item.
13384 * @param obj The web object
13385 * @param index The index selected
13387 * @see elm_web_popup_destroy()
13389 EAPI void elm_web_popup_selected_set(Evas_Object *obj, int index);
13391 * Dismisses an open dropdown popup
13393 * When the popup from a dropdown widget is to be dismissed, either after
13394 * selecting an option or to cancel it, this function must be called, which
13395 * will later emit an "popup,willdelete" signal to notify the user that
13396 * any memory and objects related to this popup can be freed.
13398 * @param obj The web object
13399 * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE
13400 * if there was no menu to destroy
13402 EAPI Eina_Bool elm_web_popup_destroy(Evas_Object *obj);
13404 * Searches the given string in a document.
13406 * @param obj The web object where to search the text
13407 * @param string String to search
13408 * @param case_sensitive If search should be case sensitive or not
13409 * @param forward If search is from cursor and on or backwards
13410 * @param wrap If search should wrap at the end
13412 * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not
13415 EAPI Eina_Bool elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
13417 * Marks matches of the given string in a document.
13419 * @param obj The web object where to search text
13420 * @param string String to match
13421 * @param case_sensitive If match should be case sensitive or not
13422 * @param highlight If matches should be highlighted
13423 * @param limit Maximum amount of matches, or zero to unlimited
13425 * @return number of matched @a string
13427 EAPI unsigned int elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
13429 * Clears all marked matches in the document
13431 * @param obj The web object
13433 * @return EINA_TRUE on success, EINA_FALSE otherwise
13435 EAPI Eina_Bool elm_web_text_matches_unmark_all(Evas_Object *obj);
13437 * Sets whether to highlight the matched marks
13439 * If enabled, marks set with elm_web_text_matches_mark() will be
13442 * @param obj The web object
13443 * @param highlight Whether to highlight the marks or not
13445 * @return EINA_TRUE on success, EINA_FALSE otherwise
13447 EAPI Eina_Bool elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight);
13449 * Gets whether highlighting marks is enabled
13451 * @param The web object
13453 * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
13456 EAPI Eina_Bool elm_web_text_matches_highlight_get(const Evas_Object *obj);
13458 * Gets the overall loading progress of the page
13460 * Returns the estimated loading progress of the page, with a value between
13461 * 0.0 and 1.0. This is an estimated progress accounting for all the frames
13462 * included in the page.
13464 * @param The web object
13466 * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
13469 EAPI double elm_web_load_progress_get(const Evas_Object *obj);
13471 * Stops loading the current page
13473 * Cancels the loading of the current page in the web object. This will
13474 * cause a "load,error" signal to be emitted, with the is_cancellation
13475 * flag set to EINA_TRUE.
13477 * @param obj The web object
13479 * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
13481 EAPI Eina_Bool elm_web_stop(Evas_Object *obj);
13483 * Requests a reload of the current document in the object
13485 * @param obj The web object
13487 * @return EINA_TRUE on success, EINA_FALSE otherwise
13489 EAPI Eina_Bool elm_web_reload(Evas_Object *obj);
13491 * Requests a reload of the current document, avoiding any existing caches
13493 * @param obj The web object
13495 * @return EINA_TRUE on success, EINA_FALSE otherwise
13497 EAPI Eina_Bool elm_web_reload_full(Evas_Object *obj);
13499 * Goes back one step in the browsing history
13501 * This is equivalent to calling elm_web_object_navigate(obj, -1);
13503 * @param obj The web object
13505 * @return EINA_TRUE on success, EINA_FALSE otherwise
13507 * @see elm_web_history_enable_set()
13508 * @see elm_web_back_possible()
13509 * @see elm_web_forward()
13510 * @see elm_web_navigate()
13512 EAPI Eina_Bool elm_web_back(Evas_Object *obj);
13514 * Goes forward one step in the browsing history
13516 * This is equivalent to calling elm_web_object_navigate(obj, 1);
13518 * @param obj The web object
13520 * @return EINA_TRUE on success, EINA_FALSE otherwise
13522 * @see elm_web_history_enable_set()
13523 * @see elm_web_forward_possible()
13524 * @see elm_web_back()
13525 * @see elm_web_navigate()
13527 EAPI Eina_Bool elm_web_forward(Evas_Object *obj);
13529 * Jumps the given number of steps in the browsing history
13531 * The @p steps value can be a negative integer to back in history, or a
13532 * positive to move forward.
13534 * @param obj The web object
13535 * @param steps The number of steps to jump
13537 * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
13538 * history exists to jump the given number of steps
13540 * @see elm_web_history_enable_set()
13541 * @see elm_web_navigate_possible()
13542 * @see elm_web_back()
13543 * @see elm_web_forward()
13545 EAPI Eina_Bool elm_web_navigate(Evas_Object *obj, int steps);
13547 * Queries whether it's possible to go back in history
13549 * @param obj The web object
13551 * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
13554 EAPI Eina_Bool elm_web_back_possible(Evas_Object *obj);
13556 * Queries whether it's possible to go forward in history
13558 * @param obj The web object
13560 * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
13563 EAPI Eina_Bool elm_web_forward_possible(Evas_Object *obj);
13565 * Queries whether it's possible to jump the given number of steps
13567 * The @p steps value can be a negative integer to back in history, or a
13568 * positive to move forward.
13570 * @param obj The web object
13571 * @param steps The number of steps to check for
13573 * @return EINA_TRUE if enough history exists to perform the given jump,
13574 * EINA_FALSE otherwise
13576 EAPI Eina_Bool elm_web_navigate_possible(Evas_Object *obj, int steps);
13578 * Gets whether browsing history is enabled for the given object
13580 * @param obj The web object
13582 * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
13584 EAPI Eina_Bool elm_web_history_enable_get(const Evas_Object *obj);
13586 * Enables or disables the browsing history
13588 * @param obj The web object
13589 * @param enable Whether to enable or disable the browsing history
13591 EAPI void elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
13593 * Sets the zoom level of the web object
13595 * Zoom level matches the Webkit API, so 1.0 means normal zoom, with higher
13596 * values meaning zoom in and lower meaning zoom out. This function will
13597 * only affect the zoom level if the mode set with elm_web_zoom_mode_set()
13598 * is ::ELM_WEB_ZOOM_MODE_MANUAL.
13600 * @param obj The web object
13601 * @param zoom The zoom level to set
13603 EAPI void elm_web_zoom_set(Evas_Object *obj, double zoom);
13605 * Gets the current zoom level set on the web object
13607 * Note that this is the zoom level set on the web object and not that
13608 * of the underlying Webkit one. In the ::ELM_WEB_ZOOM_MODE_MANUAL mode,
13609 * the two zoom levels should match, but for the other two modes the
13610 * Webkit zoom is calculated internally to match the chosen mode without
13611 * changing the zoom level set for the web object.
13613 * @param obj The web object
13615 * @return The zoom level set on the object
13617 EAPI double elm_web_zoom_get(const Evas_Object *obj);
13619 * Sets the zoom mode to use
13621 * The modes can be any of those defined in ::Elm_Web_Zoom_Mode, except
13622 * ::ELM_WEB_ZOOM_MODE_LAST. The default is ::ELM_WEB_ZOOM_MODE_MANUAL.
13624 * ::ELM_WEB_ZOOM_MODE_MANUAL means the zoom level will be controlled
13625 * with the elm_web_zoom_set() function.
13626 * ::ELM_WEB_ZOOM_MODE_AUTO_FIT will calculate the needed zoom level to
13627 * make sure the entirety of the web object's contents are shown.
13628 * ::ELM_WEB_ZOOM_MODE_AUTO_FILL will calculate the needed zoom level to
13629 * fit the contents in the web object's size, without leaving any space
13632 * @param obj The web object
13633 * @param mode The mode to set
13635 EAPI void elm_web_zoom_mode_set(Evas_Object *obj, Elm_Web_Zoom_Mode mode);
13637 * Gets the currently set zoom mode
13639 * @param obj The web object
13641 * @return The current zoom mode set for the object, or
13642 * ::ELM_WEB_ZOOM_MODE_LAST on error
13644 EAPI Elm_Web_Zoom_Mode elm_web_zoom_mode_get(const Evas_Object *obj);
13646 * Shows the given region in the web object
13648 * @param obj The web object
13649 * @param x The x coordinate of the region to show
13650 * @param y The y coordinate of the region to show
13651 * @param w The width of the region to show
13652 * @param h The height of the region to show
13654 EAPI void elm_web_region_show(Evas_Object *obj, int x, int y, int w, int h);
13656 * Brings in the region to the visible area
13658 * Like elm_web_region_show(), but it animates the scrolling of the object
13661 * @param obj The web object
13662 * @param x The x coordinate of the region to show
13663 * @param y The y coordinate of the region to show
13664 * @param w The width of the region to show
13665 * @param h The height of the region to show
13667 EAPI void elm_web_region_bring_in(Evas_Object *obj, int x, int y, int w, int h);
13669 * Sets the default dialogs to use an Inwin instead of a normal window
13671 * If set, then the default implementation for the JavaScript dialogs and
13672 * file selector will be opened in an Inwin. Otherwise they will use a
13673 * normal separated window.
13675 * @param obj The web object
13676 * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
13678 EAPI void elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
13680 * Gets whether Inwin mode is set for the current object
13682 * @param obj The web object
13684 * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
13686 EAPI Eina_Bool elm_web_inwin_mode_get(const Evas_Object *obj);
13688 EAPI void elm_web_window_features_ref(Elm_Web_Window_Features *wf);
13689 EAPI void elm_web_window_features_unref(Elm_Web_Window_Features *wf);
13690 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);
13691 EAPI void elm_web_window_features_int_property_get(const Elm_Web_Window_Features *wf, int *x, int *y, int *w, int *h);
13699 * @defgroup Hoversel Hoversel
13701 * @image html img/widget/hoversel/preview-00.png
13702 * @image latex img/widget/hoversel/preview-00.eps
13704 * A hoversel is a button that pops up a list of items (automatically
13705 * choosing the direction to display) that have a label and, optionally, an
13706 * icon to select from. It is a convenience widget to avoid the need to do
13707 * all the piecing together yourself. It is intended for a small number of
13708 * items in the hoversel menu (no more than 8), though is capable of many
13711 * Signals that you can add callbacks for are:
13712 * "clicked" - the user clicked the hoversel button and popped up the sel
13713 * "selected" - an item in the hoversel list is selected. event_info is the item
13714 * "dismissed" - the hover is dismissed
13716 * See @ref tutorial_hoversel for an example.
13719 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
13721 * @brief Add a new Hoversel object
13723 * @param parent The parent object
13724 * @return The new object or NULL if it cannot be created
13726 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13728 * @brief This sets the hoversel to expand horizontally.
13730 * @param obj The hoversel object
13731 * @param horizontal If true, the hover will expand horizontally to the
13734 * @note The initial button will display horizontally regardless of this
13737 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
13739 * @brief This returns whether the hoversel is set to expand horizontally.
13741 * @param obj The hoversel object
13742 * @return If true, the hover will expand horizontally to the right.
13744 * @see elm_hoversel_horizontal_set()
13746 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13748 * @brief Set the Hover parent
13750 * @param obj The hoversel object
13751 * @param parent The parent to use
13753 * Sets the hover parent object, the area that will be darkened when the
13754 * hoversel is clicked. Should probably be the window that the hoversel is
13755 * in. See @ref Hover objects for more information.
13757 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
13759 * @brief Get the Hover parent
13761 * @param obj The hoversel object
13762 * @return The used parent
13764 * Gets the hover parent object.
13766 * @see elm_hoversel_hover_parent_set()
13768 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13770 * @brief Set the hoversel button label
13772 * @param obj The hoversel object
13773 * @param label The label text.
13775 * This sets the label of the button that is always visible (before it is
13776 * clicked and expanded).
13778 * @deprecated elm_object_text_set()
13780 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13782 * @brief Get the hoversel button label
13784 * @param obj The hoversel object
13785 * @return The label text.
13787 * @deprecated elm_object_text_get()
13789 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13791 * @brief Set the icon of the hoversel button
13793 * @param obj The hoversel object
13794 * @param icon The icon object
13796 * Sets the icon of the button that is always visible (before it is clicked
13797 * and expanded). Once the icon object is set, a previously set one will be
13798 * deleted, if you want to keep that old content object, use the
13799 * elm_hoversel_icon_unset() function.
13801 * @see elm_object_content_set() for the button widget
13803 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
13805 * @brief Get the icon of the hoversel button
13807 * @param obj The hoversel object
13808 * @return The icon object
13810 * Get the icon of the button that is always visible (before it is clicked
13811 * and expanded). Also see elm_object_content_get() for the button widget.
13813 * @see elm_hoversel_icon_set()
13815 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13817 * @brief Get and unparent the icon of the hoversel button
13819 * @param obj The hoversel object
13820 * @return The icon object that was being used
13822 * Unparent and return the icon of the button that is always visible
13823 * (before it is clicked and expanded).
13825 * @see elm_hoversel_icon_set()
13826 * @see elm_object_content_unset() for the button widget
13828 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13830 * @brief This triggers the hoversel popup from code, the same as if the user
13831 * had clicked the button.
13833 * @param obj The hoversel object
13835 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
13837 * @brief This dismisses the hoversel popup as if the user had clicked
13838 * outside the hover.
13840 * @param obj The hoversel object
13842 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
13844 * @brief Returns whether the hoversel is expanded.
13846 * @param obj The hoversel object
13847 * @return This will return EINA_TRUE if the hoversel is expanded or
13848 * EINA_FALSE if it is not expanded.
13850 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13852 * @brief This will remove all the children items from the hoversel.
13854 * @param obj The hoversel object
13856 * @warning Should @b not be called while the hoversel is active; use
13857 * elm_hoversel_expanded_get() to check first.
13859 * @see elm_hoversel_item_del_cb_set()
13860 * @see elm_hoversel_item_del()
13862 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
13864 * @brief Get the list of items within the given hoversel.
13866 * @param obj The hoversel object
13867 * @return Returns a list of Elm_Hoversel_Item*
13869 * @see elm_hoversel_item_add()
13871 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13873 * @brief Add an item to the hoversel button
13875 * @param obj The hoversel object
13876 * @param label The text label to use for the item (NULL if not desired)
13877 * @param icon_file An image file path on disk to use for the icon or standard
13878 * icon name (NULL if not desired)
13879 * @param icon_type The icon type if relevant
13880 * @param func Convenience function to call when this item is selected
13881 * @param data Data to pass to item-related functions
13882 * @return A handle to the item added.
13884 * This adds an item to the hoversel to show when it is clicked. Note: if you
13885 * need to use an icon from an edje file then use
13886 * elm_hoversel_item_icon_set() right after the this function, and set
13887 * icon_file to NULL here.
13889 * For more information on what @p icon_file and @p icon_type are see the
13890 * @ref Icon "icon documentation".
13892 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);
13894 * @brief Delete an item from the hoversel
13896 * @param item The item to delete
13898 * This deletes the item from the hoversel (should not be called while the
13899 * hoversel is active; use elm_hoversel_expanded_get() to check first).
13901 * @see elm_hoversel_item_add()
13902 * @see elm_hoversel_item_del_cb_set()
13904 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
13906 * @brief Set the function to be called when an item from the hoversel is
13909 * @param item The item to set the callback on
13910 * @param func The function called
13912 * That function will receive these parameters:
13913 * @li void *item_data
13914 * @li Evas_Object *the_item_object
13915 * @li Elm_Hoversel_Item *the_object_struct
13917 * @see elm_hoversel_item_add()
13919 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
13921 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
13922 * that will be passed to associated function callbacks.
13924 * @param item The item to get the data from
13925 * @return The data pointer set with elm_hoversel_item_add()
13927 * @see elm_hoversel_item_add()
13929 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
13931 * @brief This returns the label text of the given hoversel item.
13933 * @param item The item to get the label
13934 * @return The label text of the hoversel item
13936 * @see elm_hoversel_item_add()
13938 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
13940 * @brief This sets the icon for the given hoversel item.
13942 * @param item The item to set the icon
13943 * @param icon_file An image file path on disk to use for the icon or standard
13945 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
13946 * to NULL if the icon is not an edje file
13947 * @param icon_type The icon type
13949 * The icon can be loaded from the standard set, from an image file, or from
13952 * @see elm_hoversel_item_add()
13954 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);
13956 * @brief Get the icon object of the hoversel item
13958 * @param item The item to get the icon from
13959 * @param icon_file The image file path on disk used for the icon or standard
13961 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
13962 * if the icon is not an edje file
13963 * @param icon_type The icon type
13965 * @see elm_hoversel_item_icon_set()
13966 * @see elm_hoversel_item_add()
13968 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);
13974 * @defgroup Toolbar Toolbar
13975 * @ingroup Elementary
13977 * @image html img/widget/toolbar/preview-00.png
13978 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
13980 * @image html img/toolbar.png
13981 * @image latex img/toolbar.eps width=\textwidth
13983 * A toolbar is a widget that displays a list of items inside
13984 * a box. It can be scrollable, show a menu with items that don't fit
13985 * to toolbar size or even crop them.
13987 * Only one item can be selected at a time.
13989 * Items can have multiple states, or show menus when selected by the user.
13991 * Smart callbacks one can listen to:
13992 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
13993 * - "language,changed" - when the program language changes
13995 * Available styles for it:
13997 * - @c "transparent" - no background or shadow, just show the content
13999 * List of examples:
14000 * @li @ref toolbar_example_01
14001 * @li @ref toolbar_example_02
14002 * @li @ref toolbar_example_03
14006 * @addtogroup Toolbar
14011 * @enum _Elm_Toolbar_Shrink_Mode
14012 * @typedef Elm_Toolbar_Shrink_Mode
14014 * Set toolbar's items display behavior, it can be scrollabel,
14015 * show a menu with exceeding items, or simply hide them.
14017 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
14020 * Values <b> don't </b> work as bitmask, only one can be choosen.
14022 * @see elm_toolbar_mode_shrink_set()
14023 * @see elm_toolbar_mode_shrink_get()
14027 typedef enum _Elm_Toolbar_Shrink_Mode
14029 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
14030 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
14031 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
14032 ELM_TOOLBAR_SHRINK_MENU, /**< Inserts a button to pop up a menu with exceeding items. */
14033 } Elm_Toolbar_Shrink_Mode;
14035 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(). */
14037 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(). */
14040 * Add a new toolbar widget to the given parent Elementary
14041 * (container) object.
14043 * @param parent The parent object.
14044 * @return a new toolbar widget handle or @c NULL, on errors.
14046 * This function inserts a new toolbar widget on the canvas.
14050 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14053 * Set the icon size, in pixels, to be used by toolbar items.
14055 * @param obj The toolbar object
14056 * @param icon_size The icon size in pixels
14058 * @note Default value is @c 32. It reads value from elm config.
14060 * @see elm_toolbar_icon_size_get()
14064 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
14067 * Get the icon size, in pixels, to be used by toolbar items.
14069 * @param obj The toolbar object.
14070 * @return The icon size in pixels.
14072 * @see elm_toolbar_icon_size_set() for details.
14076 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14079 * Sets icon lookup order, for toolbar items' icons.
14081 * @param obj The toolbar object.
14082 * @param order The icon lookup order.
14084 * Icons added before calling this function will not be affected.
14085 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
14087 * @see elm_toolbar_icon_order_lookup_get()
14091 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
14094 * Gets the icon lookup order.
14096 * @param obj The toolbar object.
14097 * @return The icon lookup order.
14099 * @see elm_toolbar_icon_order_lookup_set() for details.
14103 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14106 * Set whether the toolbar items' should be selected by the user or not.
14108 * @param obj The toolbar object.
14109 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
14112 * This will turn off the ability to select items entirely and they will
14113 * neither appear selected nor emit selected signals. The clicked
14114 * callback function will still be called.
14116 * Selection is enabled by default.
14118 * @see elm_toolbar_no_select_mode_get().
14122 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14125 * Set whether the toolbar items' should be selected by the user or not.
14127 * @param obj The toolbar object.
14128 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
14129 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
14131 * @see elm_toolbar_no_select_mode_set() for details.
14135 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14138 * Append item to the toolbar.
14140 * @param obj The toolbar object.
14141 * @param icon A string with icon name or the absolute path of an image file.
14142 * @param label The label of the item.
14143 * @param func The function to call when the item is clicked.
14144 * @param data The data to associate with the item for related callbacks.
14145 * @return The created item or @c NULL upon failure.
14147 * A new item will be created and appended to the toolbar, i.e., will
14148 * be set as @b last item.
14150 * Items created with this method can be deleted with
14151 * elm_toolbar_item_del().
14153 * Associated @p data can be properly freed when item is deleted if a
14154 * callback function is set with elm_toolbar_item_del_cb_set().
14156 * If a function is passed as argument, it will be called everytime this item
14157 * is selected, i.e., the user clicks over an unselected item.
14158 * If such function isn't needed, just passing
14159 * @c NULL as @p func is enough. The same should be done for @p data.
14161 * Toolbar will load icon image from fdo or current theme.
14162 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14163 * If an absolute path is provided it will load it direct from a file.
14165 * @see elm_toolbar_item_icon_set()
14166 * @see elm_toolbar_item_del()
14167 * @see elm_toolbar_item_del_cb_set()
14171 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);
14174 * Prepend item to the toolbar.
14176 * @param obj The toolbar object.
14177 * @param icon A string with icon name or the absolute path of an image file.
14178 * @param label The label of the item.
14179 * @param func The function to call when the item is clicked.
14180 * @param data The data to associate with the item for related callbacks.
14181 * @return The created item or @c NULL upon failure.
14183 * A new item will be created and prepended to the toolbar, i.e., will
14184 * be set as @b first item.
14186 * Items created with this method can be deleted with
14187 * elm_toolbar_item_del().
14189 * Associated @p data can be properly freed when item is deleted if a
14190 * callback function is set with elm_toolbar_item_del_cb_set().
14192 * If a function is passed as argument, it will be called everytime this item
14193 * is selected, i.e., the user clicks over an unselected item.
14194 * If such function isn't needed, just passing
14195 * @c NULL as @p func is enough. The same should be done for @p data.
14197 * Toolbar will load icon image from fdo or current theme.
14198 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14199 * If an absolute path is provided it will load it direct from a file.
14201 * @see elm_toolbar_item_icon_set()
14202 * @see elm_toolbar_item_del()
14203 * @see elm_toolbar_item_del_cb_set()
14207 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);
14210 * Insert a new item into the toolbar object before item @p before.
14212 * @param obj The toolbar object.
14213 * @param before The toolbar item to insert before.
14214 * @param icon A string with icon name or the absolute path of an image file.
14215 * @param label The label of the item.
14216 * @param func The function to call when the item is clicked.
14217 * @param data The data to associate with the item for related callbacks.
14218 * @return The created item or @c NULL upon failure.
14220 * A new item will be created and added to the toolbar. Its position in
14221 * this toolbar will be just before item @p before.
14223 * Items created with this method can be deleted with
14224 * elm_toolbar_item_del().
14226 * Associated @p data can be properly freed when item is deleted if a
14227 * callback function is set with elm_toolbar_item_del_cb_set().
14229 * If a function is passed as argument, it will be called everytime this item
14230 * is selected, i.e., the user clicks over an unselected item.
14231 * If such function isn't needed, just passing
14232 * @c NULL as @p func is enough. The same should be done for @p data.
14234 * Toolbar will load icon image from fdo or current theme.
14235 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14236 * If an absolute path is provided it will load it direct from a file.
14238 * @see elm_toolbar_item_icon_set()
14239 * @see elm_toolbar_item_del()
14240 * @see elm_toolbar_item_del_cb_set()
14244 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);
14247 * Insert a new item into the toolbar object after item @p after.
14249 * @param obj The toolbar object.
14250 * @param after The toolbar item to insert after.
14251 * @param icon A string with icon name or the absolute path of an image file.
14252 * @param label The label of the item.
14253 * @param func The function to call when the item is clicked.
14254 * @param data The data to associate with the item for related callbacks.
14255 * @return The created item or @c NULL upon failure.
14257 * A new item will be created and added to the toolbar. Its position in
14258 * this toolbar will be just after item @p after.
14260 * Items created with this method can be deleted with
14261 * elm_toolbar_item_del().
14263 * Associated @p data can be properly freed when item is deleted if a
14264 * callback function is set with elm_toolbar_item_del_cb_set().
14266 * If a function is passed as argument, it will be called everytime this item
14267 * is selected, i.e., the user clicks over an unselected item.
14268 * If such function isn't needed, just passing
14269 * @c NULL as @p func is enough. The same should be done for @p data.
14271 * Toolbar will load icon image from fdo or current theme.
14272 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14273 * If an absolute path is provided it will load it direct from a file.
14275 * @see elm_toolbar_item_icon_set()
14276 * @see elm_toolbar_item_del()
14277 * @see elm_toolbar_item_del_cb_set()
14281 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);
14284 * Get the first item in the given toolbar widget's list of
14287 * @param obj The toolbar object
14288 * @return The first item or @c NULL, if it has no items (and on
14291 * @see elm_toolbar_item_append()
14292 * @see elm_toolbar_last_item_get()
14296 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14299 * Get the last item in the given toolbar widget's list of
14302 * @param obj The toolbar object
14303 * @return The last item or @c NULL, if it has no items (and on
14306 * @see elm_toolbar_item_prepend()
14307 * @see elm_toolbar_first_item_get()
14311 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14314 * Get the item after @p item in toolbar.
14316 * @param item The toolbar item.
14317 * @return The item after @p item, or @c NULL if none or on failure.
14319 * @note If it is the last item, @c NULL will be returned.
14321 * @see elm_toolbar_item_append()
14325 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14328 * Get the item before @p item in toolbar.
14330 * @param item The toolbar item.
14331 * @return The item before @p item, or @c NULL if none or on failure.
14333 * @note If it is the first item, @c NULL will be returned.
14335 * @see elm_toolbar_item_prepend()
14339 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14342 * Get the toolbar object from an item.
14344 * @param item The item.
14345 * @return The toolbar object.
14347 * This returns the toolbar object itself that an item belongs to.
14351 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14354 * Set the priority of a toolbar item.
14356 * @param item The toolbar item.
14357 * @param priority The item priority. The default is zero.
14359 * This is used only when the toolbar shrink mode is set to
14360 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
14361 * When space is less than required, items with low priority
14362 * will be removed from the toolbar and added to a dynamically-created menu,
14363 * while items with higher priority will remain on the toolbar,
14364 * with the same order they were added.
14366 * @see elm_toolbar_item_priority_get()
14370 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
14373 * Get the priority of a toolbar item.
14375 * @param item The toolbar item.
14376 * @return The @p item priority, or @c 0 on failure.
14378 * @see elm_toolbar_item_priority_set() for details.
14382 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14385 * Get the label of item.
14387 * @param item The item of toolbar.
14388 * @return The label of item.
14390 * The return value is a pointer to the label associated to @p item when
14391 * it was created, with function elm_toolbar_item_append() or similar,
14393 * with function elm_toolbar_item_label_set. If no label
14394 * was passed as argument, it will return @c NULL.
14396 * @see elm_toolbar_item_label_set() for more details.
14397 * @see elm_toolbar_item_append()
14401 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14404 * Set the label of item.
14406 * @param item The item of toolbar.
14407 * @param text The label of item.
14409 * The label to be displayed by the item.
14410 * Label will be placed at icons bottom (if set).
14412 * If a label was passed as argument on item creation, with function
14413 * elm_toolbar_item_append() or similar, it will be already
14414 * displayed by the item.
14416 * @see elm_toolbar_item_label_get()
14417 * @see elm_toolbar_item_append()
14421 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
14424 * Return the data associated with a given toolbar widget item.
14426 * @param item The toolbar widget item handle.
14427 * @return The data associated with @p item.
14429 * @see elm_toolbar_item_data_set()
14433 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14436 * Set the data associated with a given toolbar widget item.
14438 * @param item The toolbar widget item handle.
14439 * @param data The new data pointer to set to @p item.
14441 * This sets new item data on @p item.
14443 * @warning The old data pointer won't be touched by this function, so
14444 * the user had better to free that old data himself/herself.
14448 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
14451 * Returns a pointer to a toolbar item by its label.
14453 * @param obj The toolbar object.
14454 * @param label The label of the item to find.
14456 * @return The pointer to the toolbar item matching @p label or @c NULL
14461 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14464 * Get whether the @p item is selected or not.
14466 * @param item The toolbar item.
14467 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
14468 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
14470 * @see elm_toolbar_selected_item_set() for details.
14471 * @see elm_toolbar_item_selected_get()
14475 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14478 * Set the selected state of an item.
14480 * @param item The toolbar item
14481 * @param selected The selected state
14483 * This sets the selected state of the given item @p it.
14484 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
14486 * If a new item is selected the previosly selected will be unselected.
14487 * Previoulsy selected item can be get with function
14488 * elm_toolbar_selected_item_get().
14490 * Selected items will be highlighted.
14492 * @see elm_toolbar_item_selected_get()
14493 * @see elm_toolbar_selected_item_get()
14497 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14500 * Get the selected item.
14502 * @param obj The toolbar object.
14503 * @return The selected toolbar item.
14505 * The selected item can be unselected with function
14506 * elm_toolbar_item_selected_set().
14508 * The selected item always will be highlighted on toolbar.
14510 * @see elm_toolbar_selected_items_get()
14514 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14517 * Set the icon associated with @p item.
14519 * @param obj The parent of this item.
14520 * @param item The toolbar item.
14521 * @param icon A string with icon name or the absolute path of an image file.
14523 * Toolbar will load icon image from fdo or current theme.
14524 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14525 * If an absolute path is provided it will load it direct from a file.
14527 * @see elm_toolbar_icon_order_lookup_set()
14528 * @see elm_toolbar_icon_order_lookup_get()
14532 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
14535 * Get the string used to set the icon of @p item.
14537 * @param item The toolbar item.
14538 * @return The string associated with the icon object.
14540 * @see elm_toolbar_item_icon_set() for details.
14544 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14547 * Get the object of @p item.
14549 * @param item The toolbar item.
14550 * @return The object
14554 EAPI Evas_Object *elm_toolbar_item_object_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14557 * Get the icon object of @p item.
14559 * @param item The toolbar item.
14560 * @return The icon object
14562 * @see elm_toolbar_item_icon_set() or elm_toolbar_item_icon_memfile_set() for details.
14566 EAPI Evas_Object *elm_toolbar_item_icon_object_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14569 * Set the icon associated with @p item to an image in a binary buffer.
14571 * @param item The toolbar item.
14572 * @param img The binary data that will be used as an image
14573 * @param size The size of binary data @p img
14574 * @param format Optional format of @p img to pass to the image loader
14575 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
14577 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
14579 * @note The icon image set by this function can be changed by
14580 * elm_toolbar_item_icon_set().
14584 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);
14587 * Delete them item from the toolbar.
14589 * @param item The item of toolbar to be deleted.
14591 * @see elm_toolbar_item_append()
14592 * @see elm_toolbar_item_del_cb_set()
14596 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14599 * Set the function called when a toolbar item is freed.
14601 * @param item The item to set the callback on.
14602 * @param func The function called.
14604 * If there is a @p func, then it will be called prior item's memory release.
14605 * That will be called with the following arguments:
14607 * @li item's Evas object;
14610 * This way, a data associated to a toolbar item could be properly freed.
14614 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14617 * Get a value whether toolbar item is disabled or not.
14619 * @param item The item.
14620 * @return The disabled state.
14622 * @see elm_toolbar_item_disabled_set() for more details.
14626 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14629 * Sets the disabled/enabled state of a toolbar item.
14631 * @param item The item.
14632 * @param disabled The disabled state.
14634 * A disabled item cannot be selected or unselected. It will also
14635 * change its appearance (generally greyed out). This sets the
14636 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
14641 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
14644 * Set or unset item as a separator.
14646 * @param item The toolbar item.
14647 * @param setting @c EINA_TRUE to set item @p item as separator or
14648 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
14650 * Items aren't set as separator by default.
14652 * If set as separator it will display separator theme, so won't display
14655 * @see elm_toolbar_item_separator_get()
14659 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
14662 * Get a value whether item is a separator or not.
14664 * @param item The toolbar item.
14665 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
14666 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
14668 * @see elm_toolbar_item_separator_set() for details.
14672 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14675 * Set the shrink state of toolbar @p obj.
14677 * @param obj The toolbar object.
14678 * @param shrink_mode Toolbar's items display behavior.
14680 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
14681 * but will enforce a minimun size so all the items will fit, won't scroll
14682 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
14683 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
14684 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
14688 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
14691 * Get the shrink mode of toolbar @p obj.
14693 * @param obj The toolbar object.
14694 * @return Toolbar's items display behavior.
14696 * @see elm_toolbar_mode_shrink_set() for details.
14700 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14703 * Enable/disable homogenous mode.
14705 * @param obj The toolbar object
14706 * @param homogeneous Assume the items within the toolbar are of the
14707 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
14709 * This will enable the homogeneous mode where items are of the same size.
14710 * @see elm_toolbar_homogeneous_get()
14714 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
14717 * Get whether the homogenous mode is enabled.
14719 * @param obj The toolbar object.
14720 * @return Assume the items within the toolbar are of the same height
14721 * and width (EINA_TRUE = on, EINA_FALSE = off).
14723 * @see elm_toolbar_homogeneous_set()
14727 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14730 * Enable/disable homogenous mode.
14732 * @param obj The toolbar object
14733 * @param homogeneous Assume the items within the toolbar are of the
14734 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
14736 * This will enable the homogeneous mode where items are of the same size.
14737 * @see elm_toolbar_homogeneous_get()
14739 * @deprecated use elm_toolbar_homogeneous_set() instead.
14743 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
14746 * Get whether the homogenous mode is enabled.
14748 * @param obj The toolbar object.
14749 * @return Assume the items within the toolbar are of the same height
14750 * and width (EINA_TRUE = on, EINA_FALSE = off).
14752 * @see elm_toolbar_homogeneous_set()
14753 * @deprecated use elm_toolbar_homogeneous_get() instead.
14757 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14760 * Set the parent object of the toolbar items' menus.
14762 * @param obj The toolbar object.
14763 * @param parent The parent of the menu objects.
14765 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
14767 * For more details about setting the parent for toolbar menus, see
14768 * elm_menu_parent_set().
14770 * @see elm_menu_parent_set() for details.
14771 * @see elm_toolbar_item_menu_set() for details.
14775 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14778 * Get the parent object of the toolbar items' menus.
14780 * @param obj The toolbar object.
14781 * @return The parent of the menu objects.
14783 * @see elm_toolbar_menu_parent_set() for details.
14787 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14790 * Set the alignment of the items.
14792 * @param obj The toolbar object.
14793 * @param align The new alignment, a float between <tt> 0.0 </tt>
14794 * and <tt> 1.0 </tt>.
14796 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
14797 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
14800 * Centered items by default.
14802 * @see elm_toolbar_align_get()
14806 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
14809 * Get the alignment of the items.
14811 * @param obj The toolbar object.
14812 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
14815 * @see elm_toolbar_align_set() for details.
14819 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14822 * Set whether the toolbar item opens a menu.
14824 * @param item The toolbar item.
14825 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
14827 * A toolbar item can be set to be a menu, using this function.
14829 * Once it is set to be a menu, it can be manipulated through the
14830 * menu-like function elm_toolbar_menu_parent_set() and the other
14831 * elm_menu functions, using the Evas_Object @c menu returned by
14832 * elm_toolbar_item_menu_get().
14834 * So, items to be displayed in this item's menu should be added with
14835 * elm_menu_item_add().
14837 * The following code exemplifies the most basic usage:
14839 * tb = elm_toolbar_add(win)
14840 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
14841 * elm_toolbar_item_menu_set(item, EINA_TRUE);
14842 * elm_toolbar_menu_parent_set(tb, win);
14843 * menu = elm_toolbar_item_menu_get(item);
14844 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
14845 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
14849 * @see elm_toolbar_item_menu_get()
14853 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
14856 * Get toolbar item's menu.
14858 * @param item The toolbar item.
14859 * @return Item's menu object or @c NULL on failure.
14861 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
14862 * this function will set it.
14864 * @see elm_toolbar_item_menu_set() for details.
14868 EAPI Evas_Object *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14871 * Add a new state to @p item.
14873 * @param item The item.
14874 * @param icon A string with icon name or the absolute path of an image file.
14875 * @param label The label of the new state.
14876 * @param func The function to call when the item is clicked when this
14877 * state is selected.
14878 * @param data The data to associate with the state.
14879 * @return The toolbar item state, or @c NULL upon failure.
14881 * Toolbar will load icon image from fdo or current theme.
14882 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14883 * If an absolute path is provided it will load it direct from a file.
14885 * States created with this function can be removed with
14886 * elm_toolbar_item_state_del().
14888 * @see elm_toolbar_item_state_del()
14889 * @see elm_toolbar_item_state_sel()
14890 * @see elm_toolbar_item_state_get()
14894 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);
14897 * Delete a previoulsy added state to @p item.
14899 * @param item The toolbar item.
14900 * @param state The state to be deleted.
14901 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
14903 * @see elm_toolbar_item_state_add()
14905 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
14908 * Set @p state as the current state of @p it.
14910 * @param it The item.
14911 * @param state The state to use.
14912 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
14914 * If @p state is @c NULL, it won't select any state and the default item's
14915 * icon and label will be used. It's the same behaviour than
14916 * elm_toolbar_item_state_unser().
14918 * @see elm_toolbar_item_state_unset()
14922 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
14925 * Unset the state of @p it.
14927 * @param it The item.
14929 * The default icon and label from this item will be displayed.
14931 * @see elm_toolbar_item_state_set() for more details.
14935 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
14938 * Get the current state of @p it.
14940 * @param item The item.
14941 * @return The selected state or @c NULL if none is selected or on failure.
14943 * @see elm_toolbar_item_state_set() for details.
14944 * @see elm_toolbar_item_state_unset()
14945 * @see elm_toolbar_item_state_add()
14949 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
14952 * Get the state after selected state in toolbar's @p item.
14954 * @param it The toolbar item to change state.
14955 * @return The state after current state, or @c NULL on failure.
14957 * If last state is selected, this function will return first state.
14959 * @see elm_toolbar_item_state_set()
14960 * @see elm_toolbar_item_state_add()
14964 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
14967 * Get the state before selected state in toolbar's @p item.
14969 * @param it The toolbar item to change state.
14970 * @return The state before current state, or @c NULL on failure.
14972 * If first state is selected, this function will return last state.
14974 * @see elm_toolbar_item_state_set()
14975 * @see elm_toolbar_item_state_add()
14979 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
14982 * Set the text to be shown in a given toolbar item's tooltips.
14984 * @param item Target item.
14985 * @param text The text to set in the content.
14987 * Setup the text as tooltip to object. The item can have only one tooltip,
14988 * so any previous tooltip data - set with this function or
14989 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
14991 * @see elm_object_tooltip_text_set() for more details.
14995 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
14998 * Set the content to be shown in the tooltip item.
15000 * Setup the tooltip to item. The item can have only one tooltip,
15001 * so any previous tooltip data is removed. @p func(with @p data) will
15002 * be called every time that need show the tooltip and it should
15003 * return a valid Evas_Object. This object is then managed fully by
15004 * tooltip system and is deleted when the tooltip is gone.
15006 * @param item the toolbar item being attached a tooltip.
15007 * @param func the function used to create the tooltip contents.
15008 * @param data what to provide to @a func as callback data/context.
15009 * @param del_cb called when data is not needed anymore, either when
15010 * another callback replaces @a func, the tooltip is unset with
15011 * elm_toolbar_item_tooltip_unset() or the owner @a item
15012 * dies. This callback receives as the first parameter the
15013 * given @a data, and @c event_info is the item.
15015 * @see elm_object_tooltip_content_cb_set() for more details.
15019 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);
15022 * Unset tooltip from item.
15024 * @param item toolbar item to remove previously set tooltip.
15026 * Remove tooltip from item. The callback provided as del_cb to
15027 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
15028 * it is not used anymore.
15030 * @see elm_object_tooltip_unset() for more details.
15031 * @see elm_toolbar_item_tooltip_content_cb_set()
15035 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15038 * Sets a different style for this item tooltip.
15040 * @note before you set a style you should define a tooltip with
15041 * elm_toolbar_item_tooltip_content_cb_set() or
15042 * elm_toolbar_item_tooltip_text_set()
15044 * @param item toolbar item with tooltip already set.
15045 * @param style the theme style to use (default, transparent, ...)
15047 * @see elm_object_tooltip_style_set() for more details.
15051 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15054 * Get the style for this item tooltip.
15056 * @param item toolbar item with tooltip already set.
15057 * @return style the theme style in use, defaults to "default". If the
15058 * object does not have a tooltip set, then NULL is returned.
15060 * @see elm_object_tooltip_style_get() for more details.
15061 * @see elm_toolbar_item_tooltip_style_set()
15065 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15068 * Set the type of mouse pointer/cursor decoration to be shown,
15069 * when the mouse pointer is over the given toolbar widget item
15071 * @param item toolbar item to customize cursor on
15072 * @param cursor the cursor type's name
15074 * This function works analogously as elm_object_cursor_set(), but
15075 * here the cursor's changing area is restricted to the item's
15076 * area, and not the whole widget's. Note that that item cursors
15077 * have precedence over widget cursors, so that a mouse over an
15078 * item with custom cursor set will always show @b that cursor.
15080 * If this function is called twice for an object, a previously set
15081 * cursor will be unset on the second call.
15083 * @see elm_object_cursor_set()
15084 * @see elm_toolbar_item_cursor_get()
15085 * @see elm_toolbar_item_cursor_unset()
15089 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15092 * Get the type of mouse pointer/cursor decoration set to be shown,
15093 * when the mouse pointer is over the given toolbar widget item
15095 * @param item toolbar item with custom cursor set
15096 * @return the cursor type's name or @c NULL, if no custom cursors
15097 * were set to @p item (and on errors)
15099 * @see elm_object_cursor_get()
15100 * @see elm_toolbar_item_cursor_set()
15101 * @see elm_toolbar_item_cursor_unset()
15105 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15108 * Unset any custom mouse pointer/cursor decoration set to be
15109 * shown, when the mouse pointer is over the given toolbar widget
15110 * item, thus making it show the @b default cursor again.
15112 * @param item a toolbar item
15114 * Use this call to undo any custom settings on this item's cursor
15115 * decoration, bringing it back to defaults (no custom style set).
15117 * @see elm_object_cursor_unset()
15118 * @see elm_toolbar_item_cursor_set()
15122 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15125 * Set a different @b style for a given custom cursor set for a
15128 * @param item toolbar item with custom cursor set
15129 * @param style the <b>theme style</b> to use (e.g. @c "default",
15130 * @c "transparent", etc)
15132 * This function only makes sense when one is using custom mouse
15133 * cursor decorations <b>defined in a theme file</b>, which can have,
15134 * given a cursor name/type, <b>alternate styles</b> on it. It
15135 * works analogously as elm_object_cursor_style_set(), but here
15136 * applyed only to toolbar item objects.
15138 * @warning Before you set a cursor style you should have definen a
15139 * custom cursor previously on the item, with
15140 * elm_toolbar_item_cursor_set()
15142 * @see elm_toolbar_item_cursor_engine_only_set()
15143 * @see elm_toolbar_item_cursor_style_get()
15147 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15150 * Get the current @b style set for a given toolbar item's custom
15153 * @param item toolbar item with custom cursor set.
15154 * @return style the cursor style in use. If the object does not
15155 * have a cursor set, then @c NULL is returned.
15157 * @see elm_toolbar_item_cursor_style_set() for more details
15161 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15164 * Set if the (custom)cursor for a given toolbar item should be
15165 * searched in its theme, also, or should only rely on the
15166 * rendering engine.
15168 * @param item item with custom (custom) cursor already set on
15169 * @param engine_only Use @c EINA_TRUE to have cursors looked for
15170 * only on those provided by the rendering engine, @c EINA_FALSE to
15171 * have them searched on the widget's theme, as well.
15173 * @note This call is of use only if you've set a custom cursor
15174 * for toolbar items, with elm_toolbar_item_cursor_set().
15176 * @note By default, cursors will only be looked for between those
15177 * provided by the rendering engine.
15181 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15184 * Get if the (custom) cursor for a given toolbar item is being
15185 * searched in its theme, also, or is only relying on the rendering
15188 * @param item a toolbar item
15189 * @return @c EINA_TRUE, if cursors are being looked for only on
15190 * those provided by the rendering engine, @c EINA_FALSE if they
15191 * are being searched on the widget's theme, as well.
15193 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
15197 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15200 * Change a toolbar's orientation
15201 * @param obj The toolbar object
15202 * @param vertical If @c EINA_TRUE, the toolbar is vertical
15203 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15205 * @deprecated use elm_toolbar_horizontal_set() instead.
15207 EINA_DEPRECATED EAPI void elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
15210 * Change a toolbar's orientation
15211 * @param obj The toolbar object
15212 * @param horizontal If @c EINA_TRUE, the toolbar is horizontal
15213 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15216 EAPI void elm_toolbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15219 * Get a toolbar's orientation
15220 * @param obj The toolbar object
15221 * @return If @c EINA_TRUE, the toolbar is vertical
15222 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15224 * @deprecated use elm_toolbar_horizontal_get() instead.
15226 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_orientation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15229 * Get a toolbar's orientation
15230 * @param obj The toolbar object
15231 * @return If @c EINA_TRUE, the toolbar is horizontal
15232 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15235 EAPI Eina_Bool elm_toolbar_horizontal_get(const Evas_Object *obj);
15241 EAPI double elm_tooltip_delay_get(void);
15242 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
15243 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
15244 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
15245 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
15246 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);
15247 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15248 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15249 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15252 * @defgroup Cursors Cursors
15254 * The Elementary cursor is an internal smart object used to
15255 * customize the mouse cursor displayed over objects (or
15256 * widgets). In the most common scenario, the cursor decoration
15257 * comes from the graphical @b engine Elementary is running
15258 * on. Those engines may provide different decorations for cursors,
15259 * and Elementary provides functions to choose them (think of X11
15260 * cursors, as an example).
15262 * There's also the possibility of, besides using engine provided
15263 * cursors, also use ones coming from Edje theming files. Both
15264 * globally and per widget, Elementary makes it possible for one to
15265 * make the cursors lookup to be held on engines only or on
15266 * Elementary's theme file, too. To set cursor's hot spot,
15267 * two data items should be added to cursor's theme: "hot_x" and
15268 * "hot_y", that are the offset from upper-left corner of the cursor
15269 * (coordinates 0,0).
15275 * Set the cursor to be shown when mouse is over the object
15277 * Set the cursor that will be displayed when mouse is over the
15278 * object. The object can have only one cursor set to it, so if
15279 * this function is called twice for an object, the previous set
15281 * If using X cursors, a definition of all the valid cursor names
15282 * is listed on Elementary_Cursors.h. If an invalid name is set
15283 * the default cursor will be used.
15285 * @param obj the object being set a cursor.
15286 * @param cursor the cursor name to be used.
15290 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
15293 * Get the cursor to be shown when mouse is over the object
15295 * @param obj an object with cursor already set.
15296 * @return the cursor name.
15300 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15303 * Unset cursor for object
15305 * Unset cursor for object, and set the cursor to default if the mouse
15306 * was over this object.
15308 * @param obj Target object
15309 * @see elm_object_cursor_set()
15313 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15316 * Sets a different style for this object cursor.
15318 * @note before you set a style you should define a cursor with
15319 * elm_object_cursor_set()
15321 * @param obj an object with cursor already set.
15322 * @param style the theme style to use (default, transparent, ...)
15326 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15329 * Get the style for this object cursor.
15331 * @param obj an object with cursor already set.
15332 * @return style the theme style in use, defaults to "default". If the
15333 * object does not have a cursor set, then NULL is returned.
15337 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15340 * Set if the cursor set should be searched on the theme or should use
15341 * the provided by the engine, only.
15343 * @note before you set if should look on theme you should define a cursor
15344 * with elm_object_cursor_set(). By default it will only look for cursors
15345 * provided by the engine.
15347 * @param obj an object with cursor already set.
15348 * @param engine_only boolean to define it cursors should be looked only
15349 * between the provided by the engine or searched on widget's theme as well.
15353 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15356 * Get the cursor engine only usage for this object cursor.
15358 * @param obj an object with cursor already set.
15359 * @return engine_only boolean to define it cursors should be
15360 * looked only between the provided by the engine or searched on
15361 * widget's theme as well. If the object does not have a cursor
15362 * set, then EINA_FALSE is returned.
15366 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15369 * Get the configured cursor engine only usage
15371 * This gets the globally configured exclusive usage of engine cursors.
15373 * @return 1 if only engine cursors should be used
15376 EAPI int elm_cursor_engine_only_get(void);
15379 * Set the configured cursor engine only usage
15381 * This sets the globally configured exclusive usage of engine cursors.
15382 * It won't affect cursors set before changing this value.
15384 * @param engine_only If 1 only engine cursors will be enabled, if 0 will
15385 * look for them on theme before.
15386 * @return EINA_TRUE if value is valid and setted (0 or 1)
15389 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
15396 * @defgroup Menu Menu
15398 * @image html img/widget/menu/preview-00.png
15399 * @image latex img/widget/menu/preview-00.eps
15401 * A menu is a list of items displayed above its parent. When the menu is
15402 * showing its parent is darkened. Each item can have a sub-menu. The menu
15403 * object can be used to display a menu on a right click event, in a toolbar,
15406 * Signals that you can add callbacks for are:
15407 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
15408 * event_info is NULL.
15410 * @see @ref tutorial_menu
15413 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
15415 * @brief Add a new menu to the parent
15417 * @param parent The parent object.
15418 * @return The new object or NULL if it cannot be created.
15420 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15422 * @brief Set the parent for the given menu widget
15424 * @param obj The menu object.
15425 * @param parent The new parent.
15427 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15429 * @brief Get the parent for the given menu widget
15431 * @param obj The menu object.
15432 * @return The parent.
15434 * @see elm_menu_parent_set()
15436 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15438 * @brief Move the menu to a new position
15440 * @param obj The menu object.
15441 * @param x The new position.
15442 * @param y The new position.
15444 * Sets the top-left position of the menu to (@p x,@p y).
15446 * @note @p x and @p y coordinates are relative to parent.
15448 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
15450 * @brief Close a opened menu
15452 * @param obj the menu object
15455 * Hides the menu and all it's sub-menus.
15457 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
15459 * @brief Returns a list of @p item's items.
15461 * @param obj The menu object
15462 * @return An Eina_List* of @p item's items
15464 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15466 * @brief Get the Evas_Object of an Elm_Menu_Item
15468 * @param item The menu item object.
15469 * @return The edje object containing the swallowed content
15471 * @warning Don't manipulate this object!
15473 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15475 * @brief Add an item at the end of the given menu widget
15477 * @param obj The menu object.
15478 * @param parent The parent menu item (optional)
15479 * @param icon A icon display on the item. The icon will be destryed by the menu.
15480 * @param label The label of the item.
15481 * @param func Function called when the user select the item.
15482 * @param data Data sent by the callback.
15483 * @return Returns the new item.
15485 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);
15487 * @brief Set the label of a menu item
15489 * @param item The menu item object.
15490 * @param label The label to set for @p item
15492 * @warning Don't use this funcion on items created with
15493 * elm_menu_item_add_object() or elm_menu_item_separator_add().
15495 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
15497 * @brief Get the label of a menu item
15499 * @param item The menu item object.
15500 * @return The label of @p item
15502 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15503 EAPI void elm_menu_item_icon_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
15504 EAPI const char *elm_menu_item_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15505 EAPI const Evas_Object *elm_menu_item_object_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15508 * @brief Set the selected state of @p item.
15510 * @param item The menu item object.
15511 * @param selected The selected/unselected state of the item
15513 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15515 * @brief Get the selected state of @p item.
15517 * @param item The menu item object.
15518 * @return The selected/unselected state of the item
15520 * @see elm_menu_item_selected_set()
15522 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15524 * @brief Set the disabled state of @p item.
15526 * @param item The menu item object.
15527 * @param disabled The enabled/disabled state of the item
15529 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15531 * @brief Get the disabled state of @p item.
15533 * @param item The menu item object.
15534 * @return The enabled/disabled state of the item
15536 * @see elm_menu_item_disabled_set()
15538 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15540 * @brief Add a separator item to menu @p obj under @p parent.
15542 * @param obj The menu object
15543 * @param parent The item to add the separator under
15544 * @return The created item or NULL on failure
15546 * This is item is a @ref Separator.
15548 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
15550 * @brief Returns whether @p item is a separator.
15552 * @param item The item to check
15553 * @return If true, @p item is a separator
15555 * @see elm_menu_item_separator_add()
15557 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15559 * @brief Deletes an item from the menu.
15561 * @param item The item to delete.
15563 * @see elm_menu_item_add()
15565 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15567 * @brief Set the function called when a menu item is deleted.
15569 * @param item The item to set the callback on
15570 * @param func The function called
15572 * @see elm_menu_item_add()
15573 * @see elm_menu_item_del()
15575 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15577 * @brief Returns the data associated with menu item @p item.
15579 * @param item The item
15580 * @return The data associated with @p item or NULL if none was set.
15582 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
15584 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15586 * @brief Sets the data to be associated with menu item @p item.
15588 * @param item The item
15589 * @param data The data to be associated with @p item
15591 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
15593 * @brief Returns a list of @p item's subitems.
15595 * @param item The item
15596 * @return An Eina_List* of @p item's subitems
15598 * @see elm_menu_add()
15600 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15601 EAPI const Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
15602 EAPI const Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
15603 EAPI const Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
15604 EAPI const Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15605 EAPI const Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15612 * @defgroup List List
15613 * @ingroup Elementary
15615 * @image html img/widget/list/preview-00.png
15616 * @image latex img/widget/list/preview-00.eps width=\textwidth
15618 * @image html img/list.png
15619 * @image latex img/list.eps width=\textwidth
15621 * A list widget is a container whose children are displayed vertically or
15622 * horizontally, in order, and can be selected.
15623 * The list can accept only one or multiple items selection. Also has many
15624 * modes of items displaying.
15626 * A list is a very simple type of list widget. For more robust
15627 * lists, @ref Genlist should probably be used.
15629 * Smart callbacks one can listen to:
15630 * - @c "activated" - The user has double-clicked or pressed
15631 * (enter|return|spacebar) on an item. The @c event_info parameter
15632 * is the item that was activated.
15633 * - @c "clicked,double" - The user has double-clicked an item.
15634 * The @c event_info parameter is the item that was double-clicked.
15635 * - "selected" - when the user selected an item
15636 * - "unselected" - when the user unselected an item
15637 * - "longpressed" - an item in the list is long-pressed
15638 * - "edge,top" - the list is scrolled until the top edge
15639 * - "edge,bottom" - the list is scrolled until the bottom edge
15640 * - "edge,left" - the list is scrolled until the left edge
15641 * - "edge,right" - the list is scrolled until the right edge
15642 * - "language,changed" - the program's language changed
15644 * Available styles for it:
15647 * List of examples:
15648 * @li @ref list_example_01
15649 * @li @ref list_example_02
15650 * @li @ref list_example_03
15659 * @enum _Elm_List_Mode
15660 * @typedef Elm_List_Mode
15662 * Set list's resize behavior, transverse axis scroll and
15663 * items cropping. See each mode's description for more details.
15665 * @note Default value is #ELM_LIST_SCROLL.
15667 * Values <b> don't </b> work as bitmask, only one can be choosen.
15669 * @see elm_list_mode_set()
15670 * @see elm_list_mode_get()
15674 typedef enum _Elm_List_Mode
15676 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. */
15677 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). */
15678 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. */
15679 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. */
15680 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
15683 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(). */
15686 * Add a new list widget to the given parent Elementary
15687 * (container) object.
15689 * @param parent The parent object.
15690 * @return a new list widget handle or @c NULL, on errors.
15692 * This function inserts a new list widget on the canvas.
15696 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15701 * @param obj The list object
15703 * @note Call before running show() on the list object.
15704 * @warning If not called, it won't display the list properly.
15707 * li = elm_list_add(win);
15708 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
15709 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
15711 * evas_object_show(li);
15716 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
15719 * Enable or disable multiple items selection on the list object.
15721 * @param obj The list object
15722 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
15725 * Disabled by default. If disabled, the user can select a single item of
15726 * the list each time. Selected items are highlighted on list.
15727 * If enabled, many items can be selected.
15729 * If a selected item is selected again, it will be unselected.
15731 * @see elm_list_multi_select_get()
15735 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
15738 * Get a value whether multiple items selection is enabled or not.
15740 * @see elm_list_multi_select_set() for details.
15742 * @param obj The list object.
15743 * @return @c EINA_TRUE means multiple items selection is enabled.
15744 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
15745 * @c EINA_FALSE is returned.
15749 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15752 * Set which mode to use for the list object.
15754 * @param obj The list object
15755 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
15756 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
15758 * Set list's resize behavior, transverse axis scroll and
15759 * items cropping. See each mode's description for more details.
15761 * @note Default value is #ELM_LIST_SCROLL.
15763 * Only one can be set, if a previous one was set, it will be changed
15764 * by the new mode set. Bitmask won't work as well.
15766 * @see elm_list_mode_get()
15770 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
15773 * Get the mode the list is at.
15775 * @param obj The list object
15776 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
15777 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
15779 * @note see elm_list_mode_set() for more information.
15783 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15786 * Enable or disable horizontal mode on the list object.
15788 * @param obj The list object.
15789 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
15790 * disable it, i.e., to enable vertical mode.
15792 * @note Vertical mode is set by default.
15794 * On horizontal mode items are displayed on list from left to right,
15795 * instead of from top to bottom. Also, the list will scroll horizontally.
15796 * Each item will presents left icon on top and right icon, or end, at
15799 * @see elm_list_horizontal_get()
15803 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15806 * Get a value whether horizontal mode is enabled or not.
15808 * @param obj The list object.
15809 * @return @c EINA_TRUE means horizontal mode selection is enabled.
15810 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
15811 * @c EINA_FALSE is returned.
15813 * @see elm_list_horizontal_set() for details.
15817 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15820 * Enable or disable always select mode on the list object.
15822 * @param obj The list object
15823 * @param always_select @c EINA_TRUE to enable always select mode or
15824 * @c EINA_FALSE to disable it.
15826 * @note Always select mode is disabled by default.
15828 * Default behavior of list items is to only call its callback function
15829 * the first time it's pressed, i.e., when it is selected. If a selected
15830 * item is pressed again, and multi-select is disabled, it won't call
15831 * this function (if multi-select is enabled it will unselect the item).
15833 * If always select is enabled, it will call the callback function
15834 * everytime a item is pressed, so it will call when the item is selected,
15835 * and again when a selected item is pressed.
15837 * @see elm_list_always_select_mode_get()
15838 * @see elm_list_multi_select_set()
15842 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
15845 * Get a value whether always select mode is enabled or not, meaning that
15846 * an item will always call its callback function, even if already selected.
15848 * @param obj The list object
15849 * @return @c EINA_TRUE means horizontal mode selection is enabled.
15850 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
15851 * @c EINA_FALSE is returned.
15853 * @see elm_list_always_select_mode_set() for details.
15857 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15860 * Set bouncing behaviour when the scrolled content reaches an edge.
15862 * Tell the internal scroller object whether it should bounce or not
15863 * when it reaches the respective edges for each axis.
15865 * @param obj The list object
15866 * @param h_bounce Whether to bounce or not in the horizontal axis.
15867 * @param v_bounce Whether to bounce or not in the vertical axis.
15869 * @see elm_scroller_bounce_set()
15873 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
15876 * Get the bouncing behaviour of the internal scroller.
15878 * Get whether the internal scroller should bounce when the edge of each
15879 * axis is reached scrolling.
15881 * @param obj The list object.
15882 * @param h_bounce Pointer where to store the bounce state of the horizontal
15884 * @param v_bounce Pointer where to store the bounce state of the vertical
15887 * @see elm_scroller_bounce_get()
15888 * @see elm_list_bounce_set()
15892 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
15895 * Set the scrollbar policy.
15897 * @param obj The list object
15898 * @param policy_h Horizontal scrollbar policy.
15899 * @param policy_v Vertical scrollbar policy.
15901 * This sets the scrollbar visibility policy for the given scroller.
15902 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
15903 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
15904 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
15905 * This applies respectively for the horizontal and vertical scrollbars.
15907 * The both are disabled by default, i.e., are set to
15908 * #ELM_SCROLLER_POLICY_OFF.
15912 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
15915 * Get the scrollbar policy.
15917 * @see elm_list_scroller_policy_get() for details.
15919 * @param obj The list object.
15920 * @param policy_h Pointer where to store horizontal scrollbar policy.
15921 * @param policy_v Pointer where to store vertical scrollbar policy.
15925 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);
15928 * Append a new item to the list object.
15930 * @param obj The list object.
15931 * @param label The label of the list item.
15932 * @param icon The icon object to use for the left side of the item. An
15933 * icon can be any Evas object, but usually it is an icon created
15934 * with elm_icon_add().
15935 * @param end The icon object to use for the right side of the item. An
15936 * icon can be any Evas object.
15937 * @param func The function to call when the item is clicked.
15938 * @param data The data to associate with the item for related callbacks.
15940 * @return The created item or @c NULL upon failure.
15942 * A new item will be created and appended to the list, i.e., will
15943 * be set as @b last item.
15945 * Items created with this method can be deleted with
15946 * elm_list_item_del().
15948 * Associated @p data can be properly freed when item is deleted if a
15949 * callback function is set with elm_list_item_del_cb_set().
15951 * If a function is passed as argument, it will be called everytime this item
15952 * is selected, i.e., the user clicks over an unselected item.
15953 * If always select is enabled it will call this function every time
15954 * user clicks over an item (already selected or not).
15955 * If such function isn't needed, just passing
15956 * @c NULL as @p func is enough. The same should be done for @p data.
15958 * Simple example (with no function callback or data associated):
15960 * li = elm_list_add(win);
15961 * ic = elm_icon_add(win);
15962 * elm_icon_file_set(ic, "path/to/image", NULL);
15963 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
15964 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
15966 * evas_object_show(li);
15969 * @see elm_list_always_select_mode_set()
15970 * @see elm_list_item_del()
15971 * @see elm_list_item_del_cb_set()
15972 * @see elm_list_clear()
15973 * @see elm_icon_add()
15977 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);
15980 * Prepend a new item to the list object.
15982 * @param obj The list object.
15983 * @param label The label of the list item.
15984 * @param icon The icon object to use for the left side of the item. An
15985 * icon can be any Evas object, but usually it is an icon created
15986 * with elm_icon_add().
15987 * @param end The icon object to use for the right side of the item. An
15988 * icon can be any Evas object.
15989 * @param func The function to call when the item is clicked.
15990 * @param data The data to associate with the item for related callbacks.
15992 * @return The created item or @c NULL upon failure.
15994 * A new item will be created and prepended to the list, i.e., will
15995 * be set as @b first item.
15997 * Items created with this method can be deleted with
15998 * elm_list_item_del().
16000 * Associated @p data can be properly freed when item is deleted if a
16001 * callback function is set with elm_list_item_del_cb_set().
16003 * If a function is passed as argument, it will be called everytime this item
16004 * is selected, i.e., the user clicks over an unselected item.
16005 * If always select is enabled it will call this function every time
16006 * user clicks over an item (already selected or not).
16007 * If such function isn't needed, just passing
16008 * @c NULL as @p func is enough. The same should be done for @p data.
16010 * @see elm_list_item_append() for a simple code example.
16011 * @see elm_list_always_select_mode_set()
16012 * @see elm_list_item_del()
16013 * @see elm_list_item_del_cb_set()
16014 * @see elm_list_clear()
16015 * @see elm_icon_add()
16019 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);
16022 * Insert a new item into the list object before item @p before.
16024 * @param obj The list object.
16025 * @param before The list item to insert before.
16026 * @param label The label of the list item.
16027 * @param icon The icon object to use for the left side of the item. An
16028 * icon can be any Evas object, but usually it is an icon created
16029 * with elm_icon_add().
16030 * @param end The icon object to use for the right side of the item. An
16031 * icon can be any Evas object.
16032 * @param func The function to call when the item is clicked.
16033 * @param data The data to associate with the item for related callbacks.
16035 * @return The created item or @c NULL upon failure.
16037 * A new item will be created and added to the list. Its position in
16038 * this list will be just before item @p before.
16040 * Items created with this method can be deleted with
16041 * elm_list_item_del().
16043 * Associated @p data can be properly freed when item is deleted if a
16044 * callback function is set with elm_list_item_del_cb_set().
16046 * If a function is passed as argument, it will be called everytime this item
16047 * is selected, i.e., the user clicks over an unselected item.
16048 * If always select is enabled it will call this function every time
16049 * user clicks over an item (already selected or not).
16050 * If such function isn't needed, just passing
16051 * @c NULL as @p func is enough. The same should be done for @p data.
16053 * @see elm_list_item_append() for a simple code example.
16054 * @see elm_list_always_select_mode_set()
16055 * @see elm_list_item_del()
16056 * @see elm_list_item_del_cb_set()
16057 * @see elm_list_clear()
16058 * @see elm_icon_add()
16062 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);
16065 * Insert a new item into the list object after item @p after.
16067 * @param obj The list object.
16068 * @param after The list item to insert after.
16069 * @param label The label of the list item.
16070 * @param icon The icon object to use for the left side of the item. An
16071 * icon can be any Evas object, but usually it is an icon created
16072 * with elm_icon_add().
16073 * @param end The icon object to use for the right side of the item. An
16074 * icon can be any Evas object.
16075 * @param func The function to call when the item is clicked.
16076 * @param data The data to associate with the item for related callbacks.
16078 * @return The created item or @c NULL upon failure.
16080 * A new item will be created and added to the list. Its position in
16081 * this list will be just after item @p after.
16083 * Items created with this method can be deleted with
16084 * elm_list_item_del().
16086 * Associated @p data can be properly freed when item is deleted if a
16087 * callback function is set with elm_list_item_del_cb_set().
16089 * If a function is passed as argument, it will be called everytime this item
16090 * is selected, i.e., the user clicks over an unselected item.
16091 * If always select is enabled it will call this function every time
16092 * user clicks over an item (already selected or not).
16093 * If such function isn't needed, just passing
16094 * @c NULL as @p func is enough. The same should be done for @p data.
16096 * @see elm_list_item_append() for a simple code example.
16097 * @see elm_list_always_select_mode_set()
16098 * @see elm_list_item_del()
16099 * @see elm_list_item_del_cb_set()
16100 * @see elm_list_clear()
16101 * @see elm_icon_add()
16105 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);
16108 * Insert a new item into the sorted list object.
16110 * @param obj The list object.
16111 * @param label The label of the list item.
16112 * @param icon The icon object to use for the left side of the item. An
16113 * icon can be any Evas object, but usually it is an icon created
16114 * with elm_icon_add().
16115 * @param end The icon object to use for the right side of the item. An
16116 * icon can be any Evas object.
16117 * @param func The function to call when the item is clicked.
16118 * @param data The data to associate with the item for related callbacks.
16119 * @param cmp_func The comparing function to be used to sort list
16120 * items <b>by #Elm_List_Item item handles</b>. This function will
16121 * receive two items and compare them, returning a non-negative integer
16122 * if the second item should be place after the first, or negative value
16123 * if should be placed before.
16125 * @return The created item or @c NULL upon failure.
16127 * @note This function inserts values into a list object assuming it was
16128 * sorted and the result will be sorted.
16130 * A new item will be created and added to the list. Its position in
16131 * this list will be found comparing the new item with previously inserted
16132 * items using function @p cmp_func.
16134 * Items created with this method can be deleted with
16135 * elm_list_item_del().
16137 * Associated @p data can be properly freed when item is deleted if a
16138 * callback function is set with elm_list_item_del_cb_set().
16140 * If a function is passed as argument, it will be called everytime this item
16141 * is selected, i.e., the user clicks over an unselected item.
16142 * If always select is enabled it will call this function every time
16143 * user clicks over an item (already selected or not).
16144 * If such function isn't needed, just passing
16145 * @c NULL as @p func is enough. The same should be done for @p data.
16147 * @see elm_list_item_append() for a simple code example.
16148 * @see elm_list_always_select_mode_set()
16149 * @see elm_list_item_del()
16150 * @see elm_list_item_del_cb_set()
16151 * @see elm_list_clear()
16152 * @see elm_icon_add()
16156 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);
16159 * Remove all list's items.
16161 * @param obj The list object
16163 * @see elm_list_item_del()
16164 * @see elm_list_item_append()
16168 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16171 * Get a list of all the list items.
16173 * @param obj The list object
16174 * @return An @c Eina_List of list items, #Elm_List_Item,
16175 * or @c NULL on failure.
16177 * @see elm_list_item_append()
16178 * @see elm_list_item_del()
16179 * @see elm_list_clear()
16183 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16186 * Get the selected item.
16188 * @param obj The list object.
16189 * @return The selected list item.
16191 * The selected item can be unselected with function
16192 * elm_list_item_selected_set().
16194 * The selected item always will be highlighted on list.
16196 * @see elm_list_selected_items_get()
16200 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16203 * Return a list of the currently selected list items.
16205 * @param obj The list object.
16206 * @return An @c Eina_List of list items, #Elm_List_Item,
16207 * or @c NULL on failure.
16209 * Multiple items can be selected if multi select is enabled. It can be
16210 * done with elm_list_multi_select_set().
16212 * @see elm_list_selected_item_get()
16213 * @see elm_list_multi_select_set()
16217 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16220 * Set the selected state of an item.
16222 * @param item The list item
16223 * @param selected The selected state
16225 * This sets the selected state of the given item @p it.
16226 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
16228 * If a new item is selected the previosly selected will be unselected,
16229 * unless multiple selection is enabled with elm_list_multi_select_set().
16230 * Previoulsy selected item can be get with function
16231 * elm_list_selected_item_get().
16233 * Selected items will be highlighted.
16235 * @see elm_list_item_selected_get()
16236 * @see elm_list_selected_item_get()
16237 * @see elm_list_multi_select_set()
16241 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16244 * Get whether the @p item is selected or not.
16246 * @param item The list item.
16247 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
16248 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
16250 * @see elm_list_selected_item_set() for details.
16251 * @see elm_list_item_selected_get()
16255 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16258 * Set or unset item as a separator.
16260 * @param it The list item.
16261 * @param setting @c EINA_TRUE to set item @p it as separator or
16262 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
16264 * Items aren't set as separator by default.
16266 * If set as separator it will display separator theme, so won't display
16269 * @see elm_list_item_separator_get()
16273 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
16276 * Get a value whether item is a separator or not.
16278 * @see elm_list_item_separator_set() for details.
16280 * @param it The list item.
16281 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
16282 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
16286 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16289 * Show @p item in the list view.
16291 * @param item The list item to be shown.
16293 * It won't animate list until item is visible. If such behavior is wanted,
16294 * use elm_list_bring_in() intead.
16298 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16301 * Bring in the given item to list view.
16303 * @param item The item.
16305 * This causes list to jump to the given item @p item and show it
16306 * (by scrolling), if it is not fully visible.
16308 * This may use animation to do so and take a period of time.
16310 * If animation isn't wanted, elm_list_item_show() can be used.
16314 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16317 * Delete them item from the list.
16319 * @param item The item of list to be deleted.
16321 * If deleting all list items is required, elm_list_clear()
16322 * should be used instead of getting items list and deleting each one.
16324 * @see elm_list_clear()
16325 * @see elm_list_item_append()
16326 * @see elm_list_item_del_cb_set()
16330 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16333 * Set the function called when a list item is freed.
16335 * @param item The item to set the callback on
16336 * @param func The function called
16338 * If there is a @p func, then it will be called prior item's memory release.
16339 * That will be called with the following arguments:
16341 * @li item's Evas object;
16344 * This way, a data associated to a list item could be properly freed.
16348 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16351 * Get the data associated to the item.
16353 * @param item The list item
16354 * @return The data associated to @p item
16356 * The return value is a pointer to data associated to @p item when it was
16357 * created, with function elm_list_item_append() or similar. If no data
16358 * was passed as argument, it will return @c NULL.
16360 * @see elm_list_item_append()
16364 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16367 * Get the left side icon associated to the item.
16369 * @param item The list item
16370 * @return The left side icon associated to @p item
16372 * The return value is a pointer to the icon associated to @p item when
16374 * created, with function elm_list_item_append() or similar, or later
16375 * with function elm_list_item_icon_set(). If no icon
16376 * was passed as argument, it will return @c NULL.
16378 * @see elm_list_item_append()
16379 * @see elm_list_item_icon_set()
16383 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16386 * Set the left side icon associated to the item.
16388 * @param item The list item
16389 * @param icon The left side icon object to associate with @p item
16391 * The icon object to use at left side of the item. An
16392 * icon can be any Evas object, but usually it is an icon created
16393 * with elm_icon_add().
16395 * Once the icon object is set, a previously set one will be deleted.
16396 * @warning Setting the same icon for two items will cause the icon to
16397 * dissapear from the first item.
16399 * If an icon was passed as argument on item creation, with function
16400 * elm_list_item_append() or similar, it will be already
16401 * associated to the item.
16403 * @see elm_list_item_append()
16404 * @see elm_list_item_icon_get()
16408 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
16411 * Get the right side icon associated to the item.
16413 * @param item The list item
16414 * @return The right side icon associated to @p item
16416 * The return value is a pointer to the icon associated to @p item when
16418 * created, with function elm_list_item_append() or similar, or later
16419 * with function elm_list_item_icon_set(). If no icon
16420 * was passed as argument, it will return @c NULL.
16422 * @see elm_list_item_append()
16423 * @see elm_list_item_icon_set()
16427 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16430 * Set the right side icon associated to the item.
16432 * @param item The list item
16433 * @param end The right side icon object to associate with @p item
16435 * The icon object to use at right side of the item. An
16436 * icon can be any Evas object, but usually it is an icon created
16437 * with elm_icon_add().
16439 * Once the icon object is set, a previously set one will be deleted.
16440 * @warning Setting the same icon for two items will cause the icon to
16441 * dissapear from the first item.
16443 * If an icon was passed as argument on item creation, with function
16444 * elm_list_item_append() or similar, it will be already
16445 * associated to the item.
16447 * @see elm_list_item_append()
16448 * @see elm_list_item_end_get()
16452 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
16453 EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16456 * Gets the base object of the item.
16458 * @param item The list item
16459 * @return The base object associated with @p item
16461 * Base object is the @c Evas_Object that represents that item.
16465 EAPI Evas_Object *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16468 * Get the label of item.
16470 * @param item The item of list.
16471 * @return The label of item.
16473 * The return value is a pointer to the label associated to @p item when
16474 * it was created, with function elm_list_item_append(), or later
16475 * with function elm_list_item_label_set. If no label
16476 * was passed as argument, it will return @c NULL.
16478 * @see elm_list_item_label_set() for more details.
16479 * @see elm_list_item_append()
16483 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16486 * Set the label of item.
16488 * @param item The item of list.
16489 * @param text The label of item.
16491 * The label to be displayed by the item.
16492 * Label will be placed between left and right side icons (if set).
16494 * If a label was passed as argument on item creation, with function
16495 * elm_list_item_append() or similar, it will be already
16496 * displayed by the item.
16498 * @see elm_list_item_label_get()
16499 * @see elm_list_item_append()
16503 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
16507 * Get the item before @p it in list.
16509 * @param it The list item.
16510 * @return The item before @p it, or @c NULL if none or on failure.
16512 * @note If it is the first item, @c NULL will be returned.
16514 * @see elm_list_item_append()
16515 * @see elm_list_items_get()
16519 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16522 * Get the item after @p it in list.
16524 * @param it The list item.
16525 * @return The item after @p it, or @c NULL if none or on failure.
16527 * @note If it is the last item, @c NULL will be returned.
16529 * @see elm_list_item_append()
16530 * @see elm_list_items_get()
16534 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16537 * Sets the disabled/enabled state of a list item.
16539 * @param it The item.
16540 * @param disabled The disabled state.
16542 * A disabled item cannot be selected or unselected. It will also
16543 * change its appearance (generally greyed out). This sets the
16544 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
16549 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
16552 * Get a value whether list item is disabled or not.
16554 * @param it The item.
16555 * @return The disabled state.
16557 * @see elm_list_item_disabled_set() for more details.
16561 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16564 * Set the text to be shown in a given list item's tooltips.
16566 * @param item Target item.
16567 * @param text The text to set in the content.
16569 * Setup the text as tooltip to object. The item can have only one tooltip,
16570 * so any previous tooltip data - set with this function or
16571 * elm_list_item_tooltip_content_cb_set() - is removed.
16573 * @see elm_object_tooltip_text_set() for more details.
16577 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
16581 * @brief Disable size restrictions on an object's tooltip
16582 * @param item The tooltip's anchor object
16583 * @param disable If EINA_TRUE, size restrictions are disabled
16584 * @return EINA_FALSE on failure, EINA_TRUE on success
16586 * This function allows a tooltip to expand beyond its parant window's canvas.
16587 * It will instead be limited only by the size of the display.
16589 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
16591 * @brief Retrieve size restriction state of an object's tooltip
16592 * @param obj The tooltip's anchor object
16593 * @return If EINA_TRUE, size restrictions are disabled
16595 * This function returns whether a tooltip is allowed to expand beyond
16596 * its parant window's canvas.
16597 * It will instead be limited only by the size of the display.
16599 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16602 * Set the content to be shown in the tooltip item.
16604 * Setup the tooltip to item. The item can have only one tooltip,
16605 * so any previous tooltip data is removed. @p func(with @p data) will
16606 * be called every time that need show the tooltip and it should
16607 * return a valid Evas_Object. This object is then managed fully by
16608 * tooltip system and is deleted when the tooltip is gone.
16610 * @param item the list item being attached a tooltip.
16611 * @param func the function used to create the tooltip contents.
16612 * @param data what to provide to @a func as callback data/context.
16613 * @param del_cb called when data is not needed anymore, either when
16614 * another callback replaces @a func, the tooltip is unset with
16615 * elm_list_item_tooltip_unset() or the owner @a item
16616 * dies. This callback receives as the first parameter the
16617 * given @a data, and @c event_info is the item.
16619 * @see elm_object_tooltip_content_cb_set() for more details.
16623 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);
16626 * Unset tooltip from item.
16628 * @param item list item to remove previously set tooltip.
16630 * Remove tooltip from item. The callback provided as del_cb to
16631 * elm_list_item_tooltip_content_cb_set() will be called to notify
16632 * it is not used anymore.
16634 * @see elm_object_tooltip_unset() for more details.
16635 * @see elm_list_item_tooltip_content_cb_set()
16639 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16642 * Sets a different style for this item tooltip.
16644 * @note before you set a style you should define a tooltip with
16645 * elm_list_item_tooltip_content_cb_set() or
16646 * elm_list_item_tooltip_text_set()
16648 * @param item list item with tooltip already set.
16649 * @param style the theme style to use (default, transparent, ...)
16651 * @see elm_object_tooltip_style_set() for more details.
16655 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
16658 * Get the style for this item tooltip.
16660 * @param item list item with tooltip already set.
16661 * @return style the theme style in use, defaults to "default". If the
16662 * object does not have a tooltip set, then NULL is returned.
16664 * @see elm_object_tooltip_style_get() for more details.
16665 * @see elm_list_item_tooltip_style_set()
16669 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16672 * Set the type of mouse pointer/cursor decoration to be shown,
16673 * when the mouse pointer is over the given list widget item
16675 * @param item list item to customize cursor on
16676 * @param cursor the cursor type's name
16678 * This function works analogously as elm_object_cursor_set(), but
16679 * here the cursor's changing area is restricted to the item's
16680 * area, and not the whole widget's. Note that that item cursors
16681 * have precedence over widget cursors, so that a mouse over an
16682 * item with custom cursor set will always show @b that cursor.
16684 * If this function is called twice for an object, a previously set
16685 * cursor will be unset on the second call.
16687 * @see elm_object_cursor_set()
16688 * @see elm_list_item_cursor_get()
16689 * @see elm_list_item_cursor_unset()
16693 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
16696 * Get the type of mouse pointer/cursor decoration set to be shown,
16697 * when the mouse pointer is over the given list widget item
16699 * @param item list item with custom cursor set
16700 * @return the cursor type's name or @c NULL, if no custom cursors
16701 * were set to @p item (and on errors)
16703 * @see elm_object_cursor_get()
16704 * @see elm_list_item_cursor_set()
16705 * @see elm_list_item_cursor_unset()
16709 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16712 * Unset any custom mouse pointer/cursor decoration set to be
16713 * shown, when the mouse pointer is over the given list widget
16714 * item, thus making it show the @b default cursor again.
16716 * @param item a list item
16718 * Use this call to undo any custom settings on this item's cursor
16719 * decoration, bringing it back to defaults (no custom style set).
16721 * @see elm_object_cursor_unset()
16722 * @see elm_list_item_cursor_set()
16726 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16729 * Set a different @b style for a given custom cursor set for a
16732 * @param item list item with custom cursor set
16733 * @param style the <b>theme style</b> to use (e.g. @c "default",
16734 * @c "transparent", etc)
16736 * This function only makes sense when one is using custom mouse
16737 * cursor decorations <b>defined in a theme file</b>, which can have,
16738 * given a cursor name/type, <b>alternate styles</b> on it. It
16739 * works analogously as elm_object_cursor_style_set(), but here
16740 * applyed only to list item objects.
16742 * @warning Before you set a cursor style you should have definen a
16743 * custom cursor previously on the item, with
16744 * elm_list_item_cursor_set()
16746 * @see elm_list_item_cursor_engine_only_set()
16747 * @see elm_list_item_cursor_style_get()
16751 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
16754 * Get the current @b style set for a given list item's custom
16757 * @param item list item with custom cursor set.
16758 * @return style the cursor style in use. If the object does not
16759 * have a cursor set, then @c NULL is returned.
16761 * @see elm_list_item_cursor_style_set() for more details
16765 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16768 * Set if the (custom)cursor for a given list item should be
16769 * searched in its theme, also, or should only rely on the
16770 * rendering engine.
16772 * @param item item with custom (custom) cursor already set on
16773 * @param engine_only Use @c EINA_TRUE to have cursors looked for
16774 * only on those provided by the rendering engine, @c EINA_FALSE to
16775 * have them searched on the widget's theme, as well.
16777 * @note This call is of use only if you've set a custom cursor
16778 * for list items, with elm_list_item_cursor_set().
16780 * @note By default, cursors will only be looked for between those
16781 * provided by the rendering engine.
16785 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
16788 * Get if the (custom) cursor for a given list item is being
16789 * searched in its theme, also, or is only relying on the rendering
16792 * @param item a list item
16793 * @return @c EINA_TRUE, if cursors are being looked for only on
16794 * those provided by the rendering engine, @c EINA_FALSE if they
16795 * are being searched on the widget's theme, as well.
16797 * @see elm_list_item_cursor_engine_only_set(), for more details
16801 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16808 * @defgroup Slider Slider
16809 * @ingroup Elementary
16811 * @image html img/widget/slider/preview-00.png
16812 * @image latex img/widget/slider/preview-00.eps width=\textwidth
16814 * The slider adds a dragable “slider” widget for selecting the value of
16815 * something within a range.
16817 * A slider can be horizontal or vertical. It can contain an Icon and has a
16818 * primary label as well as a units label (that is formatted with floating
16819 * point values and thus accepts a printf-style format string, like
16820 * “%1.2f units”. There is also an indicator string that may be somewhere
16821 * else (like on the slider itself) that also accepts a format string like
16822 * units. Label, Icon Unit and Indicator strings/objects are optional.
16824 * A slider may be inverted which means values invert, with high vales being
16825 * on the left or top and low values on the right or bottom (as opposed to
16826 * normally being low on the left or top and high on the bottom and right).
16828 * The slider should have its minimum and maximum values set by the
16829 * application with elm_slider_min_max_set() and value should also be set by
16830 * the application before use with elm_slider_value_set(). The span of the
16831 * slider is its length (horizontally or vertically). This will be scaled by
16832 * the object or applications scaling factor. At any point code can query the
16833 * slider for its value with elm_slider_value_get().
16835 * Smart callbacks one can listen to:
16836 * - "changed" - Whenever the slider value is changed by the user.
16837 * - "slider,drag,start" - dragging the slider indicator around has started.
16838 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
16839 * - "delay,changed" - A short time after the value is changed by the user.
16840 * This will be called only when the user stops dragging for
16841 * a very short period or when they release their
16842 * finger/mouse, so it avoids possibly expensive reactions to
16843 * the value change.
16845 * Available styles for it:
16848 * Default contents parts of the slider widget that you can use for are:
16849 * @li "elm.swallow.icon" - A icon of the slider
16850 * @li "elm.swallow.end" - A end part content of the slider
16852 * Here is an example on its usage:
16853 * @li @ref slider_example
16856 #define ELM_SLIDER_CONTENT_ICON "elm.swallow.icon"
16857 #define ELM_SLIDER_CONTENT_END "elm.swallow.end"
16860 * @addtogroup Slider
16865 * Add a new slider widget to the given parent Elementary
16866 * (container) object.
16868 * @param parent The parent object.
16869 * @return a new slider widget handle or @c NULL, on errors.
16871 * This function inserts a new slider widget on the canvas.
16875 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16878 * Set the label of a given slider widget
16880 * @param obj The progress bar object
16881 * @param label The text label string, in UTF-8
16884 * @deprecated use elm_object_text_set() instead.
16886 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
16889 * Get the label of a given slider widget
16891 * @param obj The progressbar object
16892 * @return The text label string, in UTF-8
16895 * @deprecated use elm_object_text_get() instead.
16897 EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16900 * Set the icon object of the slider object.
16902 * @param obj The slider object.
16903 * @param icon The icon object.
16905 * On horizontal mode, icon is placed at left, and on vertical mode,
16908 * @note Once the icon object is set, a previously set one will be deleted.
16909 * If you want to keep that old content object, use the
16910 * elm_slider_icon_unset() function.
16912 * @warning If the object being set does not have minimum size hints set,
16913 * it won't get properly displayed.
16916 * @deprecated use elm_object_content_set() instead.
16918 EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
16921 * Unset an icon set on a given slider widget.
16923 * @param obj The slider object.
16924 * @return The icon object that was being used, if any was set, or
16925 * @c NULL, otherwise (and on errors).
16927 * On horizontal mode, icon is placed at left, and on vertical mode,
16930 * This call will unparent and return the icon object which was set
16931 * for this widget, previously, on success.
16933 * @see elm_slider_icon_set() for more details
16934 * @see elm_slider_icon_get()
16935 * @deprecated use elm_object_content_unset() instead.
16939 EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
16942 * Retrieve the icon object set for a given slider widget.
16944 * @param obj The slider object.
16945 * @return The icon object's handle, if @p obj had one set, or @c NULL,
16946 * otherwise (and on errors).
16948 * On horizontal mode, icon is placed at left, and on vertical mode,
16951 * @see elm_slider_icon_set() for more details
16952 * @see elm_slider_icon_unset()
16956 EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16959 * Set the end object of the slider object.
16961 * @param obj The slider object.
16962 * @param end The end object.
16964 * On horizontal mode, end is placed at left, and on vertical mode,
16965 * placed at bottom.
16967 * @note Once the icon object is set, a previously set one will be deleted.
16968 * If you want to keep that old content object, use the
16969 * elm_slider_end_unset() function.
16971 * @warning If the object being set does not have minimum size hints set,
16972 * it won't get properly displayed.
16976 EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
16979 * Unset an end object set on a given slider widget.
16981 * @param obj The slider object.
16982 * @return The end object that was being used, if any was set, or
16983 * @c NULL, otherwise (and on errors).
16985 * On horizontal mode, end is placed at left, and on vertical mode,
16986 * placed at bottom.
16988 * This call will unparent and return the icon object which was set
16989 * for this widget, previously, on success.
16991 * @see elm_slider_end_set() for more details.
16992 * @see elm_slider_end_get()
16996 EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
16999 * Retrieve the end object set for a given slider widget.
17001 * @param obj The slider object.
17002 * @return The end object's handle, if @p obj had one set, or @c NULL,
17003 * otherwise (and on errors).
17005 * On horizontal mode, icon is placed at right, and on vertical mode,
17006 * placed at bottom.
17008 * @see elm_slider_end_set() for more details.
17009 * @see elm_slider_end_unset()
17013 EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17016 * Set the (exact) length of the bar region of a given slider widget.
17018 * @param obj The slider object.
17019 * @param size The length of the slider's bar region.
17021 * This sets the minimum width (when in horizontal mode) or height
17022 * (when in vertical mode) of the actual bar area of the slider
17023 * @p obj. This in turn affects the object's minimum size. Use
17024 * this when you're not setting other size hints expanding on the
17025 * given direction (like weight and alignment hints) and you would
17026 * like it to have a specific size.
17028 * @note Icon, end, label, indicator and unit text around @p obj
17029 * will require their
17030 * own space, which will make @p obj to require more the @p size,
17033 * @see elm_slider_span_size_get()
17037 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17040 * Get the length set for the bar region of a given slider widget
17042 * @param obj The slider object.
17043 * @return The length of the slider's bar region.
17045 * If that size was not set previously, with
17046 * elm_slider_span_size_set(), this call will return @c 0.
17050 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17053 * Set the format string for the unit label.
17055 * @param obj The slider object.
17056 * @param format The format string for the unit display.
17058 * Unit label is displayed all the time, if set, after slider's bar.
17059 * In horizontal mode, at right and in vertical mode, at bottom.
17061 * If @c NULL, unit label won't be visible. If not it sets the format
17062 * string for the label text. To the label text is provided a floating point
17063 * value, so the label text can display up to 1 floating point value.
17064 * Note that this is optional.
17066 * Use a format string such as "%1.2f meters" for example, and it will
17067 * display values like: "3.14 meters" for a value equal to 3.14159.
17069 * Default is unit label disabled.
17071 * @see elm_slider_indicator_format_get()
17075 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17078 * Get the unit label format of the slider.
17080 * @param obj The slider object.
17081 * @return The unit label format string in UTF-8.
17083 * Unit label is displayed all the time, if set, after slider's bar.
17084 * In horizontal mode, at right and in vertical mode, at bottom.
17086 * @see elm_slider_unit_format_set() for more
17087 * information on how this works.
17091 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17094 * Set the format string for the indicator label.
17096 * @param obj The slider object.
17097 * @param indicator The format string for the indicator display.
17099 * The slider may display its value somewhere else then unit label,
17100 * for example, above the slider knob that is dragged around. This function
17101 * sets the format string used for this.
17103 * If @c NULL, indicator label won't be visible. If not it sets the format
17104 * string for the label text. To the label text is provided a floating point
17105 * value, so the label text can display up to 1 floating point value.
17106 * Note that this is optional.
17108 * Use a format string such as "%1.2f meters" for example, and it will
17109 * display values like: "3.14 meters" for a value equal to 3.14159.
17111 * Default is indicator label disabled.
17113 * @see elm_slider_indicator_format_get()
17117 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
17120 * Get the indicator label format of the slider.
17122 * @param obj The slider object.
17123 * @return The indicator label format string in UTF-8.
17125 * The slider may display its value somewhere else then unit label,
17126 * for example, above the slider knob that is dragged around. This function
17127 * gets the format string used for this.
17129 * @see elm_slider_indicator_format_set() for more
17130 * information on how this works.
17134 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17137 * Set the format function pointer for the indicator label
17139 * @param obj The slider object.
17140 * @param func The indicator format function.
17141 * @param free_func The freeing function for the format string.
17143 * Set the callback function to format the indicator string.
17145 * @see elm_slider_indicator_format_set() for more info on how this works.
17149 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);
17152 * Set the format function pointer for the units label
17154 * @param obj The slider object.
17155 * @param func The units format function.
17156 * @param free_func The freeing function for the format string.
17158 * Set the callback function to format the indicator string.
17160 * @see elm_slider_units_format_set() for more info on how this works.
17164 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);
17167 * Set the orientation of a given slider widget.
17169 * @param obj The slider object.
17170 * @param horizontal Use @c EINA_TRUE to make @p obj to be
17171 * @b horizontal, @c EINA_FALSE to make it @b vertical.
17173 * Use this function to change how your slider is to be
17174 * disposed: vertically or horizontally.
17176 * By default it's displayed horizontally.
17178 * @see elm_slider_horizontal_get()
17182 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17185 * Retrieve the orientation of a given slider widget
17187 * @param obj The slider object.
17188 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17189 * @c EINA_FALSE if it's @b vertical (and on errors).
17191 * @see elm_slider_horizontal_set() for more details.
17195 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17198 * Set the minimum and maximum values for the slider.
17200 * @param obj The slider object.
17201 * @param min The minimum value.
17202 * @param max The maximum value.
17204 * Define the allowed range of values to be selected by the user.
17206 * If actual value is less than @p min, it will be updated to @p min. If it
17207 * is bigger then @p max, will be updated to @p max. Actual value can be
17208 * get with elm_slider_value_get().
17210 * By default, min is equal to 0.0, and max is equal to 1.0.
17212 * @warning Maximum must be greater than minimum, otherwise behavior
17215 * @see elm_slider_min_max_get()
17219 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17222 * Get the minimum and maximum values of the slider.
17224 * @param obj The slider object.
17225 * @param min Pointer where to store the minimum value.
17226 * @param max Pointer where to store the maximum value.
17228 * @note If only one value is needed, the other pointer can be passed
17231 * @see elm_slider_min_max_set() for details.
17235 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17238 * Set the value the slider displays.
17240 * @param obj The slider object.
17241 * @param val The value to be displayed.
17243 * Value will be presented on the unit label following format specified with
17244 * elm_slider_unit_format_set() and on indicator with
17245 * elm_slider_indicator_format_set().
17247 * @warning The value must to be between min and max values. This values
17248 * are set by elm_slider_min_max_set().
17250 * @see elm_slider_value_get()
17251 * @see elm_slider_unit_format_set()
17252 * @see elm_slider_indicator_format_set()
17253 * @see elm_slider_min_max_set()
17257 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17260 * Get the value displayed by the spinner.
17262 * @param obj The spinner object.
17263 * @return The value displayed.
17265 * @see elm_spinner_value_set() for details.
17269 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17272 * Invert a given slider widget's displaying values order
17274 * @param obj The slider object.
17275 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17276 * @c EINA_FALSE to bring it back to default, non-inverted values.
17278 * A slider may be @b inverted, in which state it gets its
17279 * values inverted, with high vales being on the left or top and
17280 * low values on the right or bottom, as opposed to normally have
17281 * the low values on the former and high values on the latter,
17282 * respectively, for horizontal and vertical modes.
17284 * @see elm_slider_inverted_get()
17288 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
17291 * Get whether a given slider widget's displaying values are
17294 * @param obj The slider object.
17295 * @return @c EINA_TRUE, if @p obj has inverted values,
17296 * @c EINA_FALSE otherwise (and on errors).
17298 * @see elm_slider_inverted_set() for more details.
17302 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17305 * Set whether to enlarge slider indicator (augmented knob) or not.
17307 * @param obj The slider object.
17308 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
17309 * let the knob always at default size.
17311 * By default, indicator will be bigger while dragged by the user.
17313 * @warning It won't display values set with
17314 * elm_slider_indicator_format_set() if you disable indicator.
17318 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
17321 * Get whether a given slider widget's enlarging indicator or not.
17323 * @param obj The slider object.
17324 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
17325 * @c EINA_FALSE otherwise (and on errors).
17327 * @see elm_slider_indicator_show_set() for details.
17331 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17340 * @addtogroup Actionslider Actionslider
17342 * A actionslider is a switcher for 2 or 3 labels with customizable magnet
17343 * properties. The indicator is the element the user drags to choose a label.
17344 * When the position is set with magnet, when released the indicator will be
17345 * moved to it if it's nearest the magnetized position.
17347 * @note By default all positions are set as enabled.
17349 * Signals that you can add callbacks for are:
17351 * "selected" - when user selects an enabled position (the label is passed
17354 * "pos_changed" - when the indicator reaches any of the positions("left",
17355 * "right" or "center").
17357 * See an example of actionslider usage @ref actionslider_example_page "here"
17361 typedef enum _Elm_Actionslider_Indicator_Pos
17363 ELM_ACTIONSLIDER_INDICATOR_NONE,
17364 ELM_ACTIONSLIDER_INDICATOR_LEFT,
17365 ELM_ACTIONSLIDER_INDICATOR_RIGHT,
17366 ELM_ACTIONSLIDER_INDICATOR_CENTER
17367 } Elm_Actionslider_Indicator_Pos;
17369 typedef enum _Elm_Actionslider_Magnet_Pos
17371 ELM_ACTIONSLIDER_MAGNET_NONE = 0,
17372 ELM_ACTIONSLIDER_MAGNET_LEFT = 1 << 0,
17373 ELM_ACTIONSLIDER_MAGNET_CENTER = 1 << 1,
17374 ELM_ACTIONSLIDER_MAGNET_RIGHT= 1 << 2,
17375 ELM_ACTIONSLIDER_MAGNET_ALL = (1 << 3) -1,
17376 ELM_ACTIONSLIDER_MAGNET_BOTH = (1 << 3)
17377 } Elm_Actionslider_Magnet_Pos;
17379 typedef enum _Elm_Actionslider_Label_Pos
17381 ELM_ACTIONSLIDER_LABEL_LEFT,
17382 ELM_ACTIONSLIDER_LABEL_RIGHT,
17383 ELM_ACTIONSLIDER_LABEL_CENTER,
17384 ELM_ACTIONSLIDER_LABEL_BUTTON
17385 } Elm_Actionslider_Label_Pos;
17387 /* smart callbacks called:
17388 * "indicator,position" - when a button reaches to the special position like "left", "right" and "center".
17392 * Add a new actionslider to the parent.
17394 * @param parent The parent object
17395 * @return The new actionslider object or NULL if it cannot be created
17397 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17400 * Set actionslider label.
17402 * @param[in] obj The actionslider object
17403 * @param[in] pos The position of the label.
17404 * (ELM_ACTIONSLIDER_LABEL_LEFT, ELM_ACTIONSLIDER_LABEL_RIGHT)
17405 * @param label The label which is going to be set.
17407 EAPI void elm_actionslider_label_set(Evas_Object *obj, Elm_Actionslider_Label_Pos pos, const char *label) EINA_ARG_NONNULL(1);
17409 * Get actionslider labels.
17411 * @param obj The actionslider object
17412 * @param left_label A char** to place the left_label of @p obj into.
17413 * @param center_label A char** to place the center_label of @p obj into.
17414 * @param right_label A char** to place the right_label of @p obj into.
17416 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);
17418 * Get actionslider selected label.
17420 * @param obj The actionslider object
17421 * @return The selected label
17423 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17425 * Set actionslider indicator position.
17427 * @param obj The actionslider object.
17428 * @param pos The position of the indicator.
17430 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Indicator_Pos pos) EINA_ARG_NONNULL(1);
17432 * Get actionslider indicator position.
17434 * @param obj The actionslider object.
17435 * @return The position of the indicator.
17437 EAPI Elm_Actionslider_Indicator_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17439 * Set actionslider magnet position. To make multiple positions magnets @c or
17440 * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT)
17442 * @param obj The actionslider object.
17443 * @param pos Bit mask indicating the magnet positions.
17445 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
17447 * Get actionslider magnet position.
17449 * @param obj The actionslider object.
17450 * @return The positions with magnet property.
17452 EAPI Elm_Actionslider_Magnet_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17454 * Set actionslider enabled position. To set multiple positions as enabled @c or
17455 * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT).
17457 * @note All the positions are enabled by default.
17459 * @param obj The actionslider object.
17460 * @param pos Bit mask indicating the enabled positions.
17462 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
17464 * Get actionslider enabled position.
17466 * @param obj The actionslider object.
17467 * @return The enabled positions.
17469 EAPI Elm_Actionslider_Magnet_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17471 * Set the label used on the indicator.
17473 * @param obj The actionslider object
17474 * @param label The label to be set on the indicator.
17475 * @deprecated use elm_object_text_set() instead.
17477 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17479 * Get the label used on the indicator object.
17481 * @param obj The actionslider object
17482 * @return The indicator label
17483 * @deprecated use elm_object_text_get() instead.
17485 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
17488 * Hold actionslider object movement.
17490 * @param[in] obj The actionslider object
17491 * @param[in] flag Actionslider hold/release
17492 * (EINA_TURE = hold/EIN_FALSE = release)
17494 * @ingroup Actionslider
17496 EAPI void elm_actionslider_hold(Evas_Object *obj, Eina_Bool flag) EINA_ARG_NONNULL(1);
17504 * @defgroup Genlist Genlist
17506 * @image html img/widget/genlist/preview-00.png
17507 * @image latex img/widget/genlist/preview-00.eps
17508 * @image html img/genlist.png
17509 * @image latex img/genlist.eps
17511 * This widget aims to have more expansive list than the simple list in
17512 * Elementary that could have more flexible items and allow many more entries
17513 * while still being fast and low on memory usage. At the same time it was
17514 * also made to be able to do tree structures. But the price to pay is more
17515 * complexity when it comes to usage. If all you want is a simple list with
17516 * icons and a single label, use the normal @ref List object.
17518 * Genlist has a fairly large API, mostly because it's relatively complex,
17519 * trying to be both expansive, powerful and efficient. First we will begin
17520 * an overview on the theory behind genlist.
17522 * @section Genlist_Item_Class Genlist item classes - creating items
17524 * In order to have the ability to add and delete items on the fly, genlist
17525 * implements a class (callback) system where the application provides a
17526 * structure with information about that type of item (genlist may contain
17527 * multiple different items with different classes, states and styles).
17528 * Genlist will call the functions in this struct (methods) when an item is
17529 * "realized" (i.e., created dynamically, while the user is scrolling the
17530 * grid). All objects will simply be deleted when no longer needed with
17531 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
17532 * following members:
17533 * - @c item_style - This is a constant string and simply defines the name
17534 * of the item style. It @b must be specified and the default should be @c
17537 * - @c func - A struct with pointers to functions that will be called when
17538 * an item is going to be actually created. All of them receive a @c data
17539 * parameter that will point to the same data passed to
17540 * elm_genlist_item_append() and related item creation functions, and a @c
17541 * obj parameter that points to the genlist object itself.
17543 * The function pointers inside @c func are @c label_get, @c icon_get, @c
17544 * state_get and @c del. The 3 first functions also receive a @c part
17545 * parameter described below. A brief description of these functions follows:
17547 * - @c label_get - The @c part parameter is the name string of one of the
17548 * existing text parts in the Edje group implementing the item's theme.
17549 * This function @b must return a strdup'()ed string, as the caller will
17550 * free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
17551 * - @c content_get - The @c part parameter is the name string of one of the
17552 * existing (content) swallow parts in the Edje group implementing the item's
17553 * theme. It must return @c NULL, when no content is desired, or a valid
17554 * object handle, otherwise. The object will be deleted by the genlist on
17555 * its deletion or when the item is "unrealized". See
17556 * #Elm_Genlist_Item_Icon_Get_Cb.
17557 * - @c func.state_get - The @c part parameter is the name string of one of
17558 * the state parts in the Edje group implementing the item's theme. Return
17559 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
17560 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
17561 * and @c "elm" as "emission" and "source" arguments, respectively, when
17562 * the state is true (the default is false), where @c XXX is the name of
17563 * the (state) part. See #Elm_Genlist_Item_State_Get_Cb.
17564 * - @c func.del - This is intended for use when genlist items are deleted,
17565 * so any data attached to the item (e.g. its data parameter on creation)
17566 * can be deleted. See #Elm_Genlist_Item_Del_Cb.
17568 * available item styles:
17570 * - default_style - The text part is a textblock
17572 * @image html img/widget/genlist/preview-04.png
17573 * @image latex img/widget/genlist/preview-04.eps
17577 * @image html img/widget/genlist/preview-01.png
17578 * @image latex img/widget/genlist/preview-01.eps
17580 * - icon_top_text_bottom
17582 * @image html img/widget/genlist/preview-02.png
17583 * @image latex img/widget/genlist/preview-02.eps
17587 * @image html img/widget/genlist/preview-03.png
17588 * @image latex img/widget/genlist/preview-03.eps
17590 * @section Genlist_Items Structure of items
17592 * An item in a genlist can have 0 or more text labels (they can be regular
17593 * text or textblock Evas objects - that's up to the style to determine), 0
17594 * or more contents (which are simply objects swallowed into the genlist item's
17595 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
17596 * behavior left to the user to define. The Edje part names for each of
17597 * these properties will be looked up, in the theme file for the genlist,
17598 * under the Edje (string) data items named @c "labels", @c "contents" and @c
17599 * "states", respectively. For each of those properties, if more than one
17600 * part is provided, they must have names listed separated by spaces in the
17601 * data fields. For the default genlist item theme, we have @b one label
17602 * part (@c "elm.text"), @b two content parts (@c "elm.swalllow.icon" and @c
17603 * "elm.swallow.end") and @b no state parts.
17605 * A genlist item may be at one of several styles. Elementary provides one
17606 * by default - "default", but this can be extended by system or application
17607 * custom themes/overlays/extensions (see @ref Theme "themes" for more
17610 * @section Genlist_Manipulation Editing and Navigating
17612 * Items can be added by several calls. All of them return a @ref
17613 * Elm_Genlist_Item handle that is an internal member inside the genlist.
17614 * They all take a data parameter that is meant to be used for a handle to
17615 * the applications internal data (eg the struct with the original item
17616 * data). The parent parameter is the parent genlist item this belongs to if
17617 * it is a tree or an indexed group, and NULL if there is no parent. The
17618 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
17619 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
17620 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
17621 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
17622 * is set then this item is group index item that is displayed at the top
17623 * until the next group comes. The func parameter is a convenience callback
17624 * that is called when the item is selected and the data parameter will be
17625 * the func_data parameter, obj be the genlist object and event_info will be
17626 * the genlist item.
17628 * elm_genlist_item_append() adds an item to the end of the list, or if
17629 * there is a parent, to the end of all the child items of the parent.
17630 * elm_genlist_item_prepend() is the same but adds to the beginning of
17631 * the list or children list. elm_genlist_item_insert_before() inserts at
17632 * item before another item and elm_genlist_item_insert_after() inserts after
17633 * the indicated item.
17635 * The application can clear the list with elm_genlist_clear() which deletes
17636 * all the items in the list and elm_genlist_item_del() will delete a specific
17637 * item. elm_genlist_item_subitems_clear() will clear all items that are
17638 * children of the indicated parent item.
17640 * To help inspect list items you can jump to the item at the top of the list
17641 * with elm_genlist_first_item_get() which will return the item pointer, and
17642 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
17643 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
17644 * and previous items respectively relative to the indicated item. Using
17645 * these calls you can walk the entire item list/tree. Note that as a tree
17646 * the items are flattened in the list, so elm_genlist_item_parent_get() will
17647 * let you know which item is the parent (and thus know how to skip them if
17650 * @section Genlist_Muti_Selection Multi-selection
17652 * If the application wants multiple items to be able to be selected,
17653 * elm_genlist_multi_select_set() can enable this. If the list is
17654 * single-selection only (the default), then elm_genlist_selected_item_get()
17655 * will return the selected item, if any, or NULL I none is selected. If the
17656 * list is multi-select then elm_genlist_selected_items_get() will return a
17657 * list (that is only valid as long as no items are modified (added, deleted,
17658 * selected or unselected)).
17660 * @section Genlist_Usage_Hints Usage hints
17662 * There are also convenience functions. elm_genlist_item_genlist_get() will
17663 * return the genlist object the item belongs to. elm_genlist_item_show()
17664 * will make the scroller scroll to show that specific item so its visible.
17665 * elm_genlist_item_data_get() returns the data pointer set by the item
17666 * creation functions.
17668 * If an item changes (state of boolean changes, label or contents change),
17669 * then use elm_genlist_item_update() to have genlist update the item with
17670 * the new state. Genlist will re-realize the item thus call the functions
17671 * in the _Elm_Genlist_Item_Class for that item.
17673 * To programmatically (un)select an item use elm_genlist_item_selected_set().
17674 * To get its selected state use elm_genlist_item_selected_get(). Similarly
17675 * to expand/contract an item and get its expanded state, use
17676 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
17677 * again to make an item disabled (unable to be selected and appear
17678 * differently) use elm_genlist_item_disabled_set() to set this and
17679 * elm_genlist_item_disabled_get() to get the disabled state.
17681 * In general to indicate how the genlist should expand items horizontally to
17682 * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
17683 * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
17684 * mode means that if items are too wide to fit, the scroller will scroll
17685 * horizontally. Otherwise items are expanded to fill the width of the
17686 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
17687 * to the viewport width and limited to that size. This can be combined with
17688 * a different style that uses edjes' ellipsis feature (cutting text off like
17691 * Items will only call their selection func and callback when first becoming
17692 * selected. Any further clicks will do nothing, unless you enable always
17693 * select with elm_genlist_always_select_mode_set(). This means even if
17694 * selected, every click will make the selected callbacks be called.
17695 * elm_genlist_no_select_mode_set() will turn off the ability to select
17696 * items entirely and they will neither appear selected nor call selected
17697 * callback functions.
17699 * Remember that you can create new styles and add your own theme augmentation
17700 * per application with elm_theme_extension_add(). If you absolutely must
17701 * have a specific style that overrides any theme the user or system sets up
17702 * you can use elm_theme_overlay_add() to add such a file.
17704 * @section Genlist_Implementation Implementation
17706 * Evas tracks every object you create. Every time it processes an event
17707 * (mouse move, down, up etc.) it needs to walk through objects and find out
17708 * what event that affects. Even worse every time it renders display updates,
17709 * in order to just calculate what to re-draw, it needs to walk through many
17710 * many many objects. Thus, the more objects you keep active, the more
17711 * overhead Evas has in just doing its work. It is advisable to keep your
17712 * active objects to the minimum working set you need. Also remember that
17713 * object creation and deletion carries an overhead, so there is a
17714 * middle-ground, which is not easily determined. But don't keep massive lists
17715 * of objects you can't see or use. Genlist does this with list objects. It
17716 * creates and destroys them dynamically as you scroll around. It groups them
17717 * into blocks so it can determine the visibility etc. of a whole block at
17718 * once as opposed to having to walk the whole list. This 2-level list allows
17719 * for very large numbers of items to be in the list (tests have used up to
17720 * 2,000,000 items). Also genlist employs a queue for adding items. As items
17721 * may be different sizes, every item added needs to be calculated as to its
17722 * size and thus this presents a lot of overhead on populating the list, this
17723 * genlist employs a queue. Any item added is queued and spooled off over
17724 * time, actually appearing some time later, so if your list has many members
17725 * you may find it takes a while for them to all appear, with your process
17726 * consuming a lot of CPU while it is busy spooling.
17728 * Genlist also implements a tree structure, but it does so with callbacks to
17729 * the application, with the application filling in tree structures when
17730 * requested (allowing for efficient building of a very deep tree that could
17731 * even be used for file-management). See the above smart signal callbacks for
17734 * @section Genlist_Smart_Events Genlist smart events
17736 * Signals that you can add callbacks for are:
17737 * - @c "activated" - The user has double-clicked or pressed
17738 * (enter|return|spacebar) on an item. The @c event_info parameter is the
17739 * item that was activated.
17740 * - @c "clicked,double" - The user has double-clicked an item. The @c
17741 * event_info parameter is the item that was double-clicked.
17742 * - @c "selected" - This is called when a user has made an item selected.
17743 * The event_info parameter is the genlist item that was selected.
17744 * - @c "unselected" - This is called when a user has made an item
17745 * unselected. The event_info parameter is the genlist item that was
17747 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
17748 * called and the item is now meant to be expanded. The event_info
17749 * parameter is the genlist item that was indicated to expand. It is the
17750 * job of this callback to then fill in the child items.
17751 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
17752 * called and the item is now meant to be contracted. The event_info
17753 * parameter is the genlist item that was indicated to contract. It is the
17754 * job of this callback to then delete the child items.
17755 * - @c "expand,request" - This is called when a user has indicated they want
17756 * to expand a tree branch item. The callback should decide if the item can
17757 * expand (has any children) and then call elm_genlist_item_expanded_set()
17758 * appropriately to set the state. The event_info parameter is the genlist
17759 * item that was indicated to expand.
17760 * - @c "contract,request" - This is called when a user has indicated they
17761 * want to contract a tree branch item. The callback should decide if the
17762 * item can contract (has any children) and then call
17763 * elm_genlist_item_expanded_set() appropriately to set the state. The
17764 * event_info parameter is the genlist item that was indicated to contract.
17765 * - @c "realized" - This is called when the item in the list is created as a
17766 * real evas object. event_info parameter is the genlist item that was
17767 * created. The object may be deleted at any time, so it is up to the
17768 * caller to not use the object pointer from elm_genlist_item_object_get()
17769 * in a way where it may point to freed objects.
17770 * - @c "unrealized" - This is called just before an item is unrealized.
17771 * After this call content objects provided will be deleted and the item
17772 * object itself delete or be put into a floating cache.
17773 * - @c "drag,start,up" - This is called when the item in the list has been
17774 * dragged (not scrolled) up.
17775 * - @c "drag,start,down" - This is called when the item in the list has been
17776 * dragged (not scrolled) down.
17777 * - @c "drag,start,left" - This is called when the item in the list has been
17778 * dragged (not scrolled) left.
17779 * - @c "drag,start,right" - This is called when the item in the list has
17780 * been dragged (not scrolled) right.
17781 * - @c "drag,stop" - This is called when the item in the list has stopped
17783 * - @c "drag" - This is called when the item in the list is being dragged.
17784 * - @c "longpressed" - This is called when the item is pressed for a certain
17785 * amount of time. By default it's 1 second.
17786 * - @c "scroll,anim,start" - This is called when scrolling animation has
17788 * - @c "scroll,anim,stop" - This is called when scrolling animation has
17790 * - @c "scroll,drag,start" - This is called when dragging the content has
17792 * - @c "scroll,drag,stop" - This is called when dragging the content has
17794 * - @c "edge,top" - This is called when the genlist is scrolled until
17796 * - @c "edge,bottom" - This is called when the genlist is scrolled
17797 * until the bottom edge.
17798 * - @c "edge,left" - This is called when the genlist is scrolled
17799 * until the left edge.
17800 * - @c "edge,right" - This is called when the genlist is scrolled
17801 * until the right edge.
17802 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
17804 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
17806 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
17808 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
17810 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
17811 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
17812 * multi-touch pinched in.
17813 * - @c "swipe" - This is called when the genlist is swiped.
17814 * - @c "moved" - This is called when a genlist item is moved.
17815 * - @c "language,changed" - This is called when the program's language is
17818 * @section Genlist_Examples Examples
17820 * Here is a list of examples that use the genlist, trying to show some of
17821 * its capabilities:
17822 * - @ref genlist_example_01
17823 * - @ref genlist_example_02
17824 * - @ref genlist_example_03
17825 * - @ref genlist_example_04
17826 * - @ref genlist_example_05
17830 * @addtogroup Genlist
17835 * @enum _Elm_Genlist_Item_Flags
17836 * @typedef Elm_Genlist_Item_Flags
17838 * Defines if the item is of any special type (has subitems or it's the
17839 * index of a group), or is just a simple item.
17843 typedef enum _Elm_Genlist_Item_Flags
17845 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
17846 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
17847 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
17848 } Elm_Genlist_Item_Flags;
17849 typedef enum _Elm_Genlist_Item_Field_Flags
17851 ELM_GENLIST_ITEM_FIELD_ALL = 0,
17852 ELM_GENLIST_ITEM_FIELD_LABEL = (1 << 0),
17853 ELM_GENLIST_ITEM_FIELD_ICON = (1 << 1),
17854 ELM_GENLIST_ITEM_FIELD_STATE = (1 << 2)
17855 } Elm_Genlist_Item_Field_Flags;
17856 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
17857 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
17858 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func;
17859 typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
17860 typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part);
17861 typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
17862 typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj);
17863 typedef void (*GenlistItemMovedFunc) ( Evas_Object *genlist, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after);
17866 * @struct _Elm_Genlist_Item_Class
17868 * Genlist item class definition structs.
17870 * This struct contains the style and fetching functions that will define the
17871 * contents of each item.
17873 * @see @ref Genlist_Item_Class
17875 struct _Elm_Genlist_Item_Class
17877 const char *item_style;
17879 GenlistItemLabelGetFunc label_get;
17880 GenlistItemIconGetFunc icon_get;
17881 GenlistItemStateGetFunc state_get;
17882 GenlistItemDelFunc del;
17883 GenlistItemMovedFunc moved;
17885 const char *edit_item_style;
17886 const char *mode_item_style;
17888 #define Elm_Genlist_Item_Class_Func Elm_Gen_Item_Class_Func
17890 * Add a new genlist widget to the given parent Elementary
17891 * (container) object
17893 * @param parent The parent object
17894 * @return a new genlist widget handle or @c NULL, on errors
17896 * This function inserts a new genlist widget on the canvas.
17898 * @see elm_genlist_item_append()
17899 * @see elm_genlist_item_del()
17900 * @see elm_genlist_clear()
17904 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17906 * Remove all items from a given genlist widget.
17908 * @param obj The genlist object
17910 * This removes (and deletes) all items in @p obj, leaving it empty.
17912 * @see elm_genlist_item_del(), to remove just one item.
17916 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
17918 * Enable or disable multi-selection in the genlist
17920 * @param obj The genlist object
17921 * @param multi Multi-select enable/disable. Default is disabled.
17923 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
17924 * the list. This allows more than 1 item to be selected. To retrieve the list
17925 * of selected items, use elm_genlist_selected_items_get().
17927 * @see elm_genlist_selected_items_get()
17928 * @see elm_genlist_multi_select_get()
17932 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
17934 * Gets if multi-selection in genlist is enabled or disabled.
17936 * @param obj The genlist object
17937 * @return Multi-select enabled/disabled
17938 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
17940 * @see elm_genlist_multi_select_set()
17944 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17946 * This sets the horizontal stretching mode.
17948 * @param obj The genlist object
17949 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
17951 * This sets the mode used for sizing items horizontally. Valid modes
17952 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
17953 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
17954 * the scroller will scroll horizontally. Otherwise items are expanded
17955 * to fill the width of the viewport of the scroller. If it is
17956 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
17957 * limited to that size.
17959 * @see elm_genlist_horizontal_get()
17963 EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
17965 * Gets the horizontal stretching mode.
17967 * @param obj The genlist object
17968 * @return The mode to use
17969 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
17971 * @see elm_genlist_horizontal_set()
17975 EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17977 * Set the always select mode.
17979 * @param obj The genlist object
17980 * @param always_select The always select mode (@c EINA_TRUE = on, @c
17981 * EINA_FALSE = off). Default is @c EINA_FALSE.
17983 * Items will only call their selection func and callback when first
17984 * becoming selected. Any further clicks will do nothing, unless you
17985 * enable always select with elm_genlist_always_select_mode_set().
17986 * This means that, even if selected, every click will make the selected
17987 * callbacks be called.
17989 * @see elm_genlist_always_select_mode_get()
17993 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
17995 * Get the always select mode.
17997 * @param obj The genlist object
17998 * @return The always select mode
17999 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18001 * @see elm_genlist_always_select_mode_set()
18005 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18007 * Enable/disable the no select mode.
18009 * @param obj The genlist object
18010 * @param no_select The no select mode
18011 * (EINA_TRUE = on, EINA_FALSE = off)
18013 * This will turn off the ability to select items entirely and they
18014 * will neither appear selected nor call selected callback functions.
18016 * @see elm_genlist_no_select_mode_get()
18020 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
18022 * Gets whether the no select mode is enabled.
18024 * @param obj The genlist object
18025 * @return The no select mode
18026 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18028 * @see elm_genlist_no_select_mode_set()
18032 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18034 * Enable/disable compress mode.
18036 * @param obj The genlist object
18037 * @param compress The compress mode
18038 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
18040 * This will enable the compress mode where items are "compressed"
18041 * horizontally to fit the genlist scrollable viewport width. This is
18042 * special for genlist. Do not rely on
18043 * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
18044 * work as genlist needs to handle it specially.
18046 * @see elm_genlist_compress_mode_get()
18050 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
18052 * Get whether the compress mode is enabled.
18054 * @param obj The genlist object
18055 * @return The compress mode
18056 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18058 * @see elm_genlist_compress_mode_set()
18062 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18064 * Enable/disable height-for-width mode.
18066 * @param obj The genlist object
18067 * @param setting The height-for-width mode (@c EINA_TRUE = on,
18068 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
18070 * With height-for-width mode the item width will be fixed (restricted
18071 * to a minimum of) to the list width when calculating its size in
18072 * order to allow the height to be calculated based on it. This allows,
18073 * for instance, text block to wrap lines if the Edje part is
18074 * configured with "text.min: 0 1".
18076 * @note This mode will make list resize slower as it will have to
18077 * recalculate every item height again whenever the list width
18080 * @note When height-for-width mode is enabled, it also enables
18081 * compress mode (see elm_genlist_compress_mode_set()) and
18082 * disables homogeneous (see elm_genlist_homogeneous_set()).
18086 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
18088 * Get whether the height-for-width mode is enabled.
18090 * @param obj The genlist object
18091 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
18096 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18098 * Enable/disable horizontal and vertical bouncing effect.
18100 * @param obj The genlist object
18101 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
18102 * EINA_FALSE = off). Default is @c EINA_FALSE.
18103 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
18104 * EINA_FALSE = off). Default is @c EINA_TRUE.
18106 * This will enable or disable the scroller bouncing effect for the
18107 * genlist. See elm_scroller_bounce_set() for details.
18109 * @see elm_scroller_bounce_set()
18110 * @see elm_genlist_bounce_get()
18114 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18116 * Get whether the horizontal and vertical bouncing effect is enabled.
18118 * @param obj The genlist object
18119 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
18121 * @param v_bounce Pointer to a bool to receive if the bounce vertically
18124 * @see elm_genlist_bounce_set()
18128 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18130 * Enable/disable homogenous mode.
18132 * @param obj The genlist object
18133 * @param homogeneous Assume the items within the genlist are of the
18134 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
18137 * This will enable the homogeneous mode where items are of the same
18138 * height and width so that genlist may do the lazy-loading at its
18139 * maximum (which increases the performance for scrolling the list). This
18140 * implies 'compressed' mode.
18142 * @see elm_genlist_compress_mode_set()
18143 * @see elm_genlist_homogeneous_get()
18147 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
18149 * Get whether the homogenous mode is enabled.
18151 * @param obj The genlist object
18152 * @return Assume the items within the genlist are of the same height
18153 * and width (EINA_TRUE = on, EINA_FALSE = off)
18155 * @see elm_genlist_homogeneous_set()
18159 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18161 * Set the maximum number of items within an item block
18163 * @param obj The genlist object
18164 * @param n Maximum number of items within an item block. Default is 32.
18166 * This will configure the block count to tune to the target with
18167 * particular performance matrix.
18169 * A block of objects will be used to reduce the number of operations due to
18170 * many objects in the screen. It can determine the visibility, or if the
18171 * object has changed, it theme needs to be updated, etc. doing this kind of
18172 * calculation to the entire block, instead of per object.
18174 * The default value for the block count is enough for most lists, so unless
18175 * you know you will have a lot of objects visible in the screen at the same
18176 * time, don't try to change this.
18178 * @see elm_genlist_block_count_get()
18179 * @see @ref Genlist_Implementation
18183 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
18185 * Get the maximum number of items within an item block
18187 * @param obj The genlist object
18188 * @return Maximum number of items within an item block
18190 * @see elm_genlist_block_count_set()
18194 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18196 * Set the timeout in seconds for the longpress event.
18198 * @param obj The genlist object
18199 * @param timeout timeout in seconds. Default is 1.
18201 * This option will change how long it takes to send an event "longpressed"
18202 * after the mouse down signal is sent to the list. If this event occurs, no
18203 * "clicked" event will be sent.
18205 * @see elm_genlist_longpress_timeout_set()
18209 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18211 * Get the timeout in seconds for the longpress event.
18213 * @param obj The genlist object
18214 * @return timeout in seconds
18216 * @see elm_genlist_longpress_timeout_get()
18220 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18222 * Append a new item in a given genlist widget.
18224 * @param obj The genlist object
18225 * @param itc The item class for the item
18226 * @param data The item data
18227 * @param parent The parent item, or NULL if none
18228 * @param flags Item flags
18229 * @param func Convenience function called when the item is selected
18230 * @param func_data Data passed to @p func above.
18231 * @return A handle to the item added or @c NULL if not possible
18233 * This adds the given item to the end of the list or the end of
18234 * the children list if the @p parent is given.
18236 * @see elm_genlist_item_prepend()
18237 * @see elm_genlist_item_insert_before()
18238 * @see elm_genlist_item_insert_after()
18239 * @see elm_genlist_item_del()
18243 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);
18245 * Prepend a new item in a given genlist widget.
18247 * @param obj The genlist object
18248 * @param itc The item class for the item
18249 * @param data The item data
18250 * @param parent The parent item, or NULL if none
18251 * @param flags Item flags
18252 * @param func Convenience function called when the item is selected
18253 * @param func_data Data passed to @p func above.
18254 * @return A handle to the item added or NULL if not possible
18256 * This adds an item to the beginning of the list or beginning of the
18257 * children of the parent if given.
18259 * @see elm_genlist_item_append()
18260 * @see elm_genlist_item_insert_before()
18261 * @see elm_genlist_item_insert_after()
18262 * @see elm_genlist_item_del()
18266 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);
18268 * Insert an item before another in a genlist widget
18270 * @param obj The genlist object
18271 * @param itc The item class for the item
18272 * @param data The item data
18273 * @param before The item to place this new one before.
18274 * @param flags Item flags
18275 * @param func Convenience function called when the item is selected
18276 * @param func_data Data passed to @p func above.
18277 * @return A handle to the item added or @c NULL if not possible
18279 * This inserts an item before another in the list. It will be in the
18280 * same tree level or group as the item it is inserted before.
18282 * @see elm_genlist_item_append()
18283 * @see elm_genlist_item_prepend()
18284 * @see elm_genlist_item_insert_after()
18285 * @see elm_genlist_item_del()
18289 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);
18291 * Insert an item after another in a genlist widget
18293 * @param obj The genlist object
18294 * @param itc The item class for the item
18295 * @param data The item data
18296 * @param after The item to place this new one after.
18297 * @param flags Item flags
18298 * @param func Convenience function called when the item is selected
18299 * @param func_data Data passed to @p func above.
18300 * @return A handle to the item added or @c NULL if not possible
18302 * This inserts an item after another in the list. It will be in the
18303 * same tree level or group as the item it is inserted after.
18305 * @see elm_genlist_item_append()
18306 * @see elm_genlist_item_prepend()
18307 * @see elm_genlist_item_insert_before()
18308 * @see elm_genlist_item_del()
18312 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);
18314 * Insert a new item into the sorted genlist object
18316 * @param obj The genlist object
18317 * @param itc The item class for the item
18318 * @param data The item data
18319 * @param parent The parent item, or NULL if none
18320 * @param flags Item flags
18321 * @param comp The function called for the sort
18322 * @param func Convenience function called when item selected
18323 * @param func_data Data passed to @p func above.
18324 * @return A handle to the item added or NULL if not possible
18328 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);
18329 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);
18330 /* operations to retrieve existing items */
18332 * Get the selectd item in the genlist.
18334 * @param obj The genlist object
18335 * @return The selected item, or NULL if none is selected.
18337 * This gets the selected item in the list (if multi-selection is enabled, only
18338 * the item that was first selected in the list is returned - which is not very
18339 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
18342 * If no item is selected, NULL is returned.
18344 * @see elm_genlist_selected_items_get()
18348 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18350 * Get a list of selected items in the genlist.
18352 * @param obj The genlist object
18353 * @return The list of selected items, or NULL if none are selected.
18355 * It returns a list of the selected items. This list pointer is only valid so
18356 * long as the selection doesn't change (no items are selected or unselected, or
18357 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
18358 * pointers. The order of the items in this list is the order which they were
18359 * selected, i.e. the first item in this list is the first item that was
18360 * selected, and so on.
18362 * @note If not in multi-select mode, consider using function
18363 * elm_genlist_selected_item_get() instead.
18365 * @see elm_genlist_multi_select_set()
18366 * @see elm_genlist_selected_item_get()
18370 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18372 * Get the mode item style of items in the genlist
18373 * @param obj The genlist object
18374 * @return The mode item style string, or NULL if none is specified
18376 * This is a constant string and simply defines the name of the
18377 * style that will be used for mode animations. It can be
18378 * @c NULL if you don't plan to use Genlist mode. See
18379 * elm_genlist_item_mode_set() for more info.
18383 EAPI const char *elm_genlist_mode_item_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18385 * Set the mode item style of items in the genlist
18386 * @param obj The genlist object
18387 * @param style The mode item style string, or NULL if none is desired
18389 * This is a constant string and simply defines the name of the
18390 * style that will be used for mode animations. It can be
18391 * @c NULL if you don't plan to use Genlist mode. See
18392 * elm_genlist_item_mode_set() for more info.
18396 EAPI void elm_genlist_mode_item_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
18398 * Get a list of realized items in genlist
18400 * @param obj The genlist object
18401 * @return The list of realized items, nor NULL if none are realized.
18403 * This returns a list of the realized items in the genlist. The list
18404 * contains Elm_Genlist_Item pointers. The list must be freed by the
18405 * caller when done with eina_list_free(). The item pointers in the
18406 * list are only valid so long as those items are not deleted or the
18407 * genlist is not deleted.
18409 * @see elm_genlist_realized_items_update()
18413 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18415 * Get the item that is at the x, y canvas coords.
18417 * @param obj The gelinst object.
18418 * @param x The input x coordinate
18419 * @param y The input y coordinate
18420 * @param posret The position relative to the item returned here
18421 * @return The item at the coordinates or NULL if none
18423 * This returns the item at the given coordinates (which are canvas
18424 * relative, not object-relative). If an item is at that coordinate,
18425 * that item handle is returned, and if @p posret is not NULL, the
18426 * integer pointed to is set to a value of -1, 0 or 1, depending if
18427 * the coordinate is on the upper portion of that item (-1), on the
18428 * middle section (0) or on the lower part (1). If NULL is returned as
18429 * an item (no item found there), then posret may indicate -1 or 1
18430 * based if the coordinate is above or below all items respectively in
18435 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);
18437 * Get the first item in the genlist
18439 * This returns the first item in the list.
18441 * @param obj The genlist object
18442 * @return The first item, or NULL if none
18446 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18448 * Get the last item in the genlist
18450 * This returns the last item in the list.
18452 * @return The last item, or NULL if none
18456 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18458 * Set the scrollbar policy
18460 * @param obj The genlist object
18461 * @param policy_h Horizontal scrollbar policy.
18462 * @param policy_v Vertical scrollbar policy.
18464 * This sets the scrollbar visibility policy for the given genlist
18465 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
18466 * made visible if it is needed, and otherwise kept hidden.
18467 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
18468 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
18469 * respectively for the horizontal and vertical scrollbars. Default is
18470 * #ELM_SMART_SCROLLER_POLICY_AUTO
18472 * @see elm_genlist_scroller_policy_get()
18476 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
18478 * Get the scrollbar policy
18480 * @param obj The genlist object
18481 * @param policy_h Pointer to store the horizontal scrollbar policy.
18482 * @param policy_v Pointer to store the vertical scrollbar policy.
18484 * @see elm_genlist_scroller_policy_set()
18488 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);
18490 * Get the @b next item in a genlist widget's internal list of items,
18491 * given a handle to one of those items.
18493 * @param item The genlist item to fetch next from
18494 * @return The item after @p item, or @c NULL if there's none (and
18497 * This returns the item placed after the @p item, on the container
18500 * @see elm_genlist_item_prev_get()
18504 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18506 * Get the @b previous item in a genlist widget's internal list of items,
18507 * given a handle to one of those items.
18509 * @param item The genlist item to fetch previous from
18510 * @return The item before @p item, or @c NULL if there's none (and
18513 * This returns the item placed before the @p item, on the container
18516 * @see elm_genlist_item_next_get()
18520 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18522 * Get the genlist object's handle which contains a given genlist
18525 * @param item The item to fetch the container from
18526 * @return The genlist (parent) object
18528 * This returns the genlist object itself that an item belongs to.
18532 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18534 * Get the parent item of the given item
18536 * @param it The item
18537 * @return The parent of the item or @c NULL if it has no parent.
18539 * This returns the item that was specified as parent of the item @p it on
18540 * elm_genlist_item_append() and insertion related functions.
18544 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18546 * Remove all sub-items (children) of the given item
18548 * @param it The item
18550 * This removes all items that are children (and their descendants) of the
18551 * given item @p it.
18553 * @see elm_genlist_clear()
18554 * @see elm_genlist_item_del()
18558 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18560 * Set whether a given genlist item is selected or not
18562 * @param it The item
18563 * @param selected Use @c EINA_TRUE, to make it selected, @c
18564 * EINA_FALSE to make it unselected
18566 * This sets the selected state of an item. If multi selection is
18567 * not enabled on the containing genlist and @p selected is @c
18568 * EINA_TRUE, any other previously selected items will get
18569 * unselected in favor of this new one.
18571 * @see elm_genlist_item_selected_get()
18575 EINA_DEPRECATED EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
18577 * Get whether a given genlist item is selected or not
18579 * @param it The item
18580 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
18582 * @see elm_genlist_item_selected_set() for more details
18586 EINA_DEPRECATED EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18588 * Sets the expanded state of an item.
18590 * @param it The item
18591 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
18593 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
18596 * The theme will respond to this change visually, and a signal "expanded" or
18597 * "contracted" will be sent from the genlist with a pointer to the item that
18598 * has been expanded/contracted.
18600 * Calling this function won't show or hide any child of this item (if it is
18601 * a parent). You must manually delete and create them on the callbacks fo
18602 * the "expanded" or "contracted" signals.
18604 * @see elm_genlist_item_expanded_get()
18608 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
18610 * Get the expanded state of an item
18612 * @param it The item
18613 * @return The expanded state
18615 * This gets the expanded state of an item.
18617 * @see elm_genlist_item_expanded_set()
18621 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18623 * Get the depth of expanded item
18625 * @param it The genlist item object
18626 * @return The depth of expanded item
18630 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18632 * Set whether a given genlist item is disabled or not.
18634 * @param it The item
18635 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
18636 * to enable it back.
18638 * A disabled item cannot be selected or unselected. It will also
18639 * change its appearance, to signal the user it's disabled.
18641 * @see elm_genlist_item_disabled_get()
18645 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
18647 * Get whether a given genlist item is disabled or not.
18649 * @param it The item
18650 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
18653 * @see elm_genlist_item_disabled_set() for more details
18657 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18659 * Sets the display only state of an item.
18661 * @param it The item
18662 * @param display_only @c EINA_TRUE if the item is display only, @c
18663 * EINA_FALSE otherwise.
18665 * A display only item cannot be selected or unselected. It is for
18666 * display only and not selecting or otherwise clicking, dragging
18667 * etc. by the user, thus finger size rules will not be applied to
18670 * It's good to set group index items to display only state.
18672 * @see elm_genlist_item_display_only_get()
18676 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
18678 * Get the display only state of an item
18680 * @param it The item
18681 * @return @c EINA_TRUE if the item is display only, @c
18682 * EINA_FALSE otherwise.
18684 * @see elm_genlist_item_display_only_set()
18688 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18690 * Show the portion of a genlist's internal list containing a given
18691 * item, immediately.
18693 * @param it The item to display
18695 * This causes genlist to jump to the given item @p it and show it (by
18696 * immediately scrolling to that position), if it is not fully visible.
18698 * @see elm_genlist_item_bring_in()
18699 * @see elm_genlist_item_top_show()
18700 * @see elm_genlist_item_middle_show()
18704 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18706 * Animatedly bring in, to the visible are of a genlist, a given
18709 * @param it The item to display
18711 * This causes genlist to jump to the given item @p it and show it (by
18712 * animatedly scrolling), if it is not fully visible. This may use animation
18713 * to do so and take a period of time
18715 * @see elm_genlist_item_show()
18716 * @see elm_genlist_item_top_bring_in()
18717 * @see elm_genlist_item_middle_bring_in()
18721 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18723 * Show the portion of a genlist's internal list containing a given
18724 * item, immediately.
18726 * @param it The item to display
18728 * This causes genlist to jump to the given item @p it and show it (by
18729 * immediately scrolling to that position), if it is not fully visible.
18731 * The item will be positioned at the top of the genlist viewport.
18733 * @see elm_genlist_item_show()
18734 * @see elm_genlist_item_top_bring_in()
18738 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18740 * Animatedly bring in, to the visible are of a genlist, a given
18743 * @param it The item
18745 * This causes genlist to jump to the given item @p it and show it (by
18746 * animatedly scrolling), if it is not fully visible. This may use animation
18747 * to do so and take a period of time
18749 * The item will be positioned at the top of the genlist viewport.
18751 * @see elm_genlist_item_bring_in()
18752 * @see elm_genlist_item_top_show()
18756 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18758 * Show the portion of a genlist's internal list containing a given
18759 * item, immediately.
18761 * @param it The item to display
18763 * This causes genlist to jump to the given item @p it and show it (by
18764 * immediately scrolling to that position), if it is not fully visible.
18766 * The item will be positioned at the middle of the genlist viewport.
18768 * @see elm_genlist_item_show()
18769 * @see elm_genlist_item_middle_bring_in()
18773 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18775 * Animatedly bring in, to the visible are of a genlist, a given
18778 * @param it The item
18780 * This causes genlist to jump to the given item @p it and show it (by
18781 * animatedly scrolling), if it is not fully visible. This may use animation
18782 * to do so and take a period of time
18784 * The item will be positioned at the middle of the genlist viewport.
18786 * @see elm_genlist_item_bring_in()
18787 * @see elm_genlist_item_middle_show()
18791 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18793 * Remove a genlist item from the its parent, deleting it.
18795 * @param item The item to be removed.
18796 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
18798 * @see elm_genlist_clear(), to remove all items in a genlist at
18803 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18805 * Return the data associated to a given genlist item
18807 * @param item The genlist item.
18808 * @return the data associated to this item.
18810 * This returns the @c data value passed on the
18811 * elm_genlist_item_append() and related item addition calls.
18813 * @see elm_genlist_item_append()
18814 * @see elm_genlist_item_data_set()
18818 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18820 * Set the data associated to a given genlist item
18822 * @param item The genlist item
18823 * @param data The new data pointer to set on it
18825 * This @b overrides the @c data value passed on the
18826 * elm_genlist_item_append() and related item addition calls. This
18827 * function @b won't call elm_genlist_item_update() automatically,
18828 * so you'd issue it afterwards if you want to hove the item
18829 * updated to reflect the that new data.
18831 * @see elm_genlist_item_data_get()
18835 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
18837 * Tells genlist to "orphan" icons fetchs by the item class
18839 * @param it The item
18841 * This instructs genlist to release references to icons in the item,
18842 * meaning that they will no longer be managed by genlist and are
18843 * floating "orphans" that can be re-used elsewhere if the user wants
18848 EAPI void elm_genlist_item_contents_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18849 EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18851 * Get the real Evas object created to implement the view of a
18852 * given genlist item
18854 * @param item The genlist item.
18855 * @return the Evas object implementing this item's view.
18857 * This returns the actual Evas object used to implement the
18858 * specified genlist item's view. This may be @c NULL, as it may
18859 * not have been created or may have been deleted, at any time, by
18860 * the genlist. <b>Do not modify this object</b> (move, resize,
18861 * show, hide, etc.), as the genlist is controlling it. This
18862 * function is for querying, emitting custom signals or hooking
18863 * lower level callbacks for events on that object. Do not delete
18864 * this object under any circumstances.
18866 * @see elm_genlist_item_data_get()
18870 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18872 * Update the contents of an item
18874 * @param it The item
18876 * This updates an item by calling all the item class functions again
18877 * to get the icons, labels and states. Use this when the original
18878 * item data has changed and the changes are desired to be reflected.
18880 * Use elm_genlist_realized_items_update() to update all already realized
18883 * @see elm_genlist_realized_items_update()
18887 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18888 EAPI void elm_genlist_item_fields_update(Elm_Genlist_Item *it, const char *parts, Elm_Genlist_Item_Field_Flags itf) EINA_ARG_NONNULL(1);
18890 * Update the item class of an item
18892 * @param it The item
18893 * @param itc The item class for the item
18895 * This sets another class fo the item, changing the way that it is
18896 * displayed. After changing the item class, elm_genlist_item_update() is
18897 * called on the item @p it.
18901 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
18902 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18904 * Set the text to be shown in a given genlist item's tooltips.
18906 * @param item The genlist item
18907 * @param text The text to set in the content
18909 * This call will setup the text to be used as tooltip to that item
18910 * (analogous to elm_object_tooltip_text_set(), but being item
18911 * tooltips with higher precedence than object tooltips). It can
18912 * have only one tooltip at a time, so any previous tooltip data
18913 * will get removed.
18915 * In order to set an icon or something else as a tooltip, look at
18916 * elm_genlist_item_tooltip_content_cb_set().
18920 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
18922 * Set the content to be shown in a given genlist item's tooltips
18924 * @param item The genlist item.
18925 * @param func The function returning the tooltip contents.
18926 * @param data What to provide to @a func as callback data/context.
18927 * @param del_cb Called when data is not needed anymore, either when
18928 * another callback replaces @p func, the tooltip is unset with
18929 * elm_genlist_item_tooltip_unset() or the owner @p item
18930 * dies. This callback receives as its first parameter the
18931 * given @p data, being @c event_info the item handle.
18933 * This call will setup the tooltip's contents to @p item
18934 * (analogous to elm_object_tooltip_content_cb_set(), but being
18935 * item tooltips with higher precedence than object tooltips). It
18936 * can have only one tooltip at a time, so any previous tooltip
18937 * content will get removed. @p func (with @p data) will be called
18938 * every time Elementary needs to show the tooltip and it should
18939 * return a valid Evas object, which will be fully managed by the
18940 * tooltip system, getting deleted when the tooltip is gone.
18942 * In order to set just a text as a tooltip, look at
18943 * elm_genlist_item_tooltip_text_set().
18947 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);
18949 * Unset a tooltip from a given genlist item
18951 * @param item genlist item to remove a previously set tooltip from.
18953 * This call removes any tooltip set on @p item. The callback
18954 * provided as @c del_cb to
18955 * elm_genlist_item_tooltip_content_cb_set() will be called to
18956 * notify it is not used anymore (and have resources cleaned, if
18959 * @see elm_genlist_item_tooltip_content_cb_set()
18963 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18965 * Set a different @b style for a given genlist item's tooltip.
18967 * @param item genlist item with tooltip set
18968 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
18969 * "default", @c "transparent", etc)
18971 * Tooltips can have <b>alternate styles</b> to be displayed on,
18972 * which are defined by the theme set on Elementary. This function
18973 * works analogously as elm_object_tooltip_style_set(), but here
18974 * applied only to genlist item objects. The default style for
18975 * tooltips is @c "default".
18977 * @note before you set a style you should define a tooltip with
18978 * elm_genlist_item_tooltip_content_cb_set() or
18979 * elm_genlist_item_tooltip_text_set()
18981 * @see elm_genlist_item_tooltip_style_get()
18985 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
18987 * Get the style set a given genlist item's tooltip.
18989 * @param item genlist item with tooltip already set on.
18990 * @return style the theme style in use, which defaults to
18991 * "default". If the object does not have a tooltip set,
18992 * then @c NULL is returned.
18994 * @see elm_genlist_item_tooltip_style_set() for more details
18998 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19000 * Set the type of mouse pointer/cursor decoration to be shown,
19001 * when the mouse pointer is over the given genlist widget item
19003 * @param item genlist item to customize cursor on
19004 * @param cursor the cursor type's name
19006 * This function works analogously as elm_object_cursor_set(), but
19007 * here the cursor's changing area is restricted to the item's
19008 * area, and not the whole widget's. Note that that item cursors
19009 * have precedence over widget cursors, so that a mouse over @p
19010 * item will always show cursor @p type.
19012 * If this function is called twice for an object, a previously set
19013 * cursor will be unset on the second call.
19015 * @see elm_object_cursor_set()
19016 * @see elm_genlist_item_cursor_get()
19017 * @see elm_genlist_item_cursor_unset()
19021 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
19023 * Get the type of mouse pointer/cursor decoration set to be shown,
19024 * when the mouse pointer is over the given genlist widget item
19026 * @param item genlist item with custom cursor set
19027 * @return the cursor type's name or @c NULL, if no custom cursors
19028 * were set to @p item (and on errors)
19030 * @see elm_object_cursor_get()
19031 * @see elm_genlist_item_cursor_set() for more details
19032 * @see elm_genlist_item_cursor_unset()
19036 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19038 * Unset any custom mouse pointer/cursor decoration set to be
19039 * shown, when the mouse pointer is over the given genlist widget
19040 * item, thus making it show the @b default cursor again.
19042 * @param item a genlist item
19044 * Use this call to undo any custom settings on this item's cursor
19045 * decoration, bringing it back to defaults (no custom style set).
19047 * @see elm_object_cursor_unset()
19048 * @see elm_genlist_item_cursor_set() for more details
19052 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19054 * Set a different @b style for a given custom cursor set for a
19057 * @param item genlist item with custom cursor set
19058 * @param style the <b>theme style</b> to use (e.g. @c "default",
19059 * @c "transparent", etc)
19061 * This function only makes sense when one is using custom mouse
19062 * cursor decorations <b>defined in a theme file</b> , which can
19063 * have, given a cursor name/type, <b>alternate styles</b> on
19064 * it. It works analogously as elm_object_cursor_style_set(), but
19065 * here applied only to genlist item objects.
19067 * @warning Before you set a cursor style you should have defined a
19068 * custom cursor previously on the item, with
19069 * elm_genlist_item_cursor_set()
19071 * @see elm_genlist_item_cursor_engine_only_set()
19072 * @see elm_genlist_item_cursor_style_get()
19076 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19078 * Get the current @b style set for a given genlist item's custom
19081 * @param item genlist item with custom cursor set.
19082 * @return style the cursor style in use. If the object does not
19083 * have a cursor set, then @c NULL is returned.
19085 * @see elm_genlist_item_cursor_style_set() for more details
19089 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19091 * Set if the (custom) cursor for a given genlist item should be
19092 * searched in its theme, also, or should only rely on the
19093 * rendering engine.
19095 * @param item item with custom (custom) cursor already set on
19096 * @param engine_only Use @c EINA_TRUE to have cursors looked for
19097 * only on those provided by the rendering engine, @c EINA_FALSE to
19098 * have them searched on the widget's theme, as well.
19100 * @note This call is of use only if you've set a custom cursor
19101 * for genlist items, with elm_genlist_item_cursor_set().
19103 * @note By default, cursors will only be looked for between those
19104 * provided by the rendering engine.
19108 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
19110 * Get if the (custom) cursor for a given genlist item is being
19111 * searched in its theme, also, or is only relying on the rendering
19114 * @param item a genlist item
19115 * @return @c EINA_TRUE, if cursors are being looked for only on
19116 * those provided by the rendering engine, @c EINA_FALSE if they
19117 * are being searched on the widget's theme, as well.
19119 * @see elm_genlist_item_cursor_engine_only_set(), for more details
19123 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19125 * Update the contents of all realized items.
19127 * @param obj The genlist object.
19129 * This updates all realized items by calling all the item class functions again
19130 * to get the icons, labels and states. Use this when the original
19131 * item data has changed and the changes are desired to be reflected.
19133 * To update just one item, use elm_genlist_item_update().
19135 * @see elm_genlist_realized_items_get()
19136 * @see elm_genlist_item_update()
19140 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
19142 * Activate a genlist mode on an item
19144 * @param item The genlist item
19145 * @param mode Mode name
19146 * @param mode_set Boolean to define set or unset mode.
19148 * A genlist mode is a different way of selecting an item. Once a mode is
19149 * activated on an item, any other selected item is immediately unselected.
19150 * This feature provides an easy way of implementing a new kind of animation
19151 * for selecting an item, without having to entirely rewrite the item style
19152 * theme. However, the elm_genlist_selected_* API can't be used to get what
19153 * item is activate for a mode.
19155 * The current item style will still be used, but applying a genlist mode to
19156 * an item will select it using a different kind of animation.
19158 * The current active item for a mode can be found by
19159 * elm_genlist_mode_item_get().
19161 * The characteristics of genlist mode are:
19162 * - Only one mode can be active at any time, and for only one item.
19163 * - Genlist handles deactivating other items when one item is activated.
19164 * - A mode is defined in the genlist theme (edc), and more modes can easily
19166 * - A mode style and the genlist item style are different things. They
19167 * can be combined to provide a default style to the item, with some kind
19168 * of animation for that item when the mode is activated.
19170 * When a mode is activated on an item, a new view for that item is created.
19171 * The theme of this mode defines the animation that will be used to transit
19172 * the item from the old view to the new view. This second (new) view will be
19173 * active for that item while the mode is active on the item, and will be
19174 * destroyed after the mode is totally deactivated from that item.
19176 * @see elm_genlist_mode_get()
19177 * @see elm_genlist_mode_item_get()
19181 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
19183 * Get the last (or current) genlist mode used.
19185 * @param obj The genlist object
19187 * This function just returns the name of the last used genlist mode. It will
19188 * be the current mode if it's still active.
19190 * @see elm_genlist_item_mode_set()
19191 * @see elm_genlist_mode_item_get()
19195 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19197 * Get active genlist mode item
19199 * @param obj The genlist object
19200 * @return The active item for that current mode. Or @c NULL if no item is
19201 * activated with any mode.
19203 * This function returns the item that was activated with a mode, by the
19204 * function elm_genlist_item_mode_set().
19206 * @see elm_genlist_item_mode_set()
19207 * @see elm_genlist_mode_get()
19211 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19216 * @param obj The genlist object
19217 * @param reorder_mode The reorder mode
19218 * (EINA_TRUE = on, EINA_FALSE = off)
19222 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
19225 * Get the reorder mode
19227 * @param obj The genlist object
19228 * @return The reorder mode
19229 * (EINA_TRUE = on, EINA_FALSE = off)
19233 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19235 EAPI void elm_genlist_edit_mode_set(Evas_Object *obj, Eina_Bool edit_mode) EINA_ARG_NONNULL(1);
19236 EAPI Eina_Bool elm_genlist_edit_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19237 EAPI void elm_genlist_item_rename_mode_set(Elm_Genlist_Item *it, Eina_Bool renamed) EINA_ARG_NONNULL(1);
19238 EAPI Eina_Bool elm_genlist_item_rename_mode_get(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19239 EAPI void elm_genlist_item_move_after(Elm_Genlist_Item *it, Elm_Genlist_Item *after ) EINA_ARG_NONNULL(1, 2);
19240 EAPI void elm_genlist_item_move_before(Elm_Genlist_Item *it, Elm_Genlist_Item *before) EINA_ARG_NONNULL(1, 2);
19241 EAPI void elm_genlist_effect_set(const Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19242 EAPI void elm_genlist_pinch_zoom_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19243 EAPI void elm_genlist_pinch_zoom_mode_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19244 EAPI Eina_Bool elm_genlist_pinch_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19251 * @page tutorial_check Check example
19252 * @dontinclude check_example_01.c
19254 * This example will show 2 checkboxes, one with just a label and the second
19255 * one with both a label and an icon. This example also ilustrates how to
19256 * have the checkbox change the value of a variable and how to react to those
19259 * We will start with the usual setup code:
19262 * And now we create our first checkbox, set its label, tell it to change
19263 * the value of @p value when the checkbox stats is changed and ask to be
19264 * notified of state changes:
19267 * For our second checkbox we are going to set an icon so we need to create
19270 * @note For simplicity we are using a rectangle as icon, but any evas object
19273 * And for our second checkbox we set the label, icon and state to true:
19276 * We now do some more setup:
19279 * And finally implement the callback that will be called when the first
19280 * checkbox's state changes. This callback will use @p data to print a
19283 * @note This work because @p data is @p value(from the main function) and @p
19284 * value is changed when the checkbox is changed.
19286 * Our example will look like this:
19287 * @image html screenshots/check_example_01.png
19288 * @image latex screenshots/check_example_01.eps
19290 * @example check_example_01.c
19293 * @defgroup Check Check
19295 * @brief The check widget allows for toggling a value between true and
19298 * Check objects are a lot like radio objects in layout and functionality
19299 * except they do not work as a group, but independently and only toggle the
19300 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
19301 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
19302 * returns the current state. For convenience, like the radio objects, you
19303 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
19304 * for it to modify.
19306 * Signals that you can add callbacks for are:
19307 * "changed" - This is called whenever the user changes the state of one of
19308 * the check object(event_info is NULL).
19310 * @ref tutorial_check should give you a firm grasp of how to use this widget.
19314 * @brief Add a new Check object
19316 * @param parent The parent object
19317 * @return The new object or NULL if it cannot be created
19319 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19321 * @brief Set the text label of the check object
19323 * @param obj The check object
19324 * @param label The text label string in UTF-8
19326 * @deprecated use elm_object_text_set() instead.
19328 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19330 * @brief Get the text label of the check object
19332 * @param obj The check object
19333 * @return The text label string in UTF-8
19335 * @deprecated use elm_object_text_get() instead.
19337 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19339 * @brief Set the icon object of the check object
19341 * @param obj The check object
19342 * @param icon The icon object
19344 * Once the icon object is set, a previously set one will be deleted.
19345 * If you want to keep that old content object, use the
19346 * elm_check_icon_unset() function.
19348 EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19350 * @brief Get the icon object of the check object
19352 * @param obj The check object
19353 * @return The icon object
19355 EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19357 * @brief Unset the icon used for the check object
19359 * @param obj The check object
19360 * @return The icon object that was being used
19362 * Unparent and return the icon object which was set for this widget.
19364 EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19366 * @brief Set the on/off state of the check object
19368 * @param obj The check object
19369 * @param state The state to use (1 == on, 0 == off)
19371 * This sets the state of the check. If set
19372 * with elm_check_state_pointer_set() the state of that variable is also
19373 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
19375 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
19377 * @brief Get the state of the check object
19379 * @param obj The check object
19380 * @return The boolean state
19382 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19384 * @brief Set a convenience pointer to a boolean to change
19386 * @param obj The check object
19387 * @param statep Pointer to the boolean to modify
19389 * This sets a pointer to a boolean, that, in addition to the check objects
19390 * state will also be modified directly. To stop setting the object pointed
19391 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
19392 * then when this is called, the check objects state will also be modified to
19393 * reflect the value of the boolean @p statep points to, just like calling
19394 * elm_check_state_set().
19396 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
19402 * @defgroup Radio Radio
19404 * @image html img/widget/radio/preview-00.png
19405 * @image latex img/widget/radio/preview-00.eps
19407 * @brief Radio is a widget that allows for 1 or more options to be displayed
19408 * and have the user choose only 1 of them.
19410 * A radio object contains an indicator, an optional Label and an optional
19411 * icon object. While it's possible to have a group of only one radio they,
19412 * are normally used in groups of 2 or more. To add a radio to a group use
19413 * elm_radio_group_add(). The radio object(s) will select from one of a set
19414 * of integer values, so any value they are configuring needs to be mapped to
19415 * a set of integers. To configure what value that radio object represents,
19416 * use elm_radio_state_value_set() to set the integer it represents. To set
19417 * the value the whole group(which one is currently selected) is to indicate
19418 * use elm_radio_value_set() on any group member, and to get the groups value
19419 * use elm_radio_value_get(). For convenience the radio objects are also able
19420 * to directly set an integer(int) to the value that is selected. To specify
19421 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
19422 * The radio objects will modify this directly. That implies the pointer must
19423 * point to valid memory for as long as the radio objects exist.
19425 * Signals that you can add callbacks for are:
19426 * @li changed - This is called whenever the user changes the state of one of
19427 * the radio objects within the group of radio objects that work together.
19429 * Default contents parts of the radio widget that you can use for are:
19430 * @li "elm.swallow.content" - A icon of the radio
19432 * @ref tutorial_radio show most of this API in action.
19436 * @brief Add a new radio to the parent
19438 * @param parent The parent object
19439 * @return The new object or NULL if it cannot be created
19441 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19443 * @brief Set the text label of the radio object
19445 * @param obj The radio object
19446 * @param label The text label string in UTF-8
19448 * @deprecated use elm_object_text_set() instead.
19450 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19452 * @brief Get the text label of the radio object
19454 * @param obj The radio object
19455 * @return The text label string in UTF-8
19457 * @deprecated use elm_object_text_set() instead.
19459 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19461 * @brief Set the icon object of the radio object
19463 * @param obj The radio object
19464 * @param icon The icon object
19466 * Once the icon object is set, a previously set one will be deleted. If you
19467 * want to keep that old content object, use the elm_radio_icon_unset()
19470 * @deprecated use elm_object_content_set() instead.
19472 EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19474 * @brief Get the icon object of the radio object
19476 * @param obj The radio object
19477 * @return The icon object
19479 * @see elm_radio_icon_set()
19481 EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19483 * @brief Unset the icon used for the radio object
19485 * @param obj The radio object
19486 * @return The icon object that was being used
19488 * Unparent and return the icon object which was set for this widget.
19490 * @see elm_radio_icon_set()
19491 * @deprecated use elm_object_content_unset() instead.
19493 EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19495 * @brief Add this radio to a group of other radio objects
19497 * @param obj The radio object
19498 * @param group Any object whose group the @p obj is to join.
19500 * Radio objects work in groups. Each member should have a different integer
19501 * value assigned. In order to have them work as a group, they need to know
19502 * about each other. This adds the given radio object to the group of which
19503 * the group object indicated is a member.
19505 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
19507 * @brief Set the integer value that this radio object represents
19509 * @param obj The radio object
19510 * @param value The value to use if this radio object is selected
19512 * This sets the value of the radio.
19514 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
19516 * @brief Get the integer value that this radio object represents
19518 * @param obj The radio object
19519 * @return The value used if this radio object is selected
19521 * This gets the value of the radio.
19523 * @see elm_radio_value_set()
19525 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19527 * @brief Set the value of the radio.
19529 * @param obj The radio object
19530 * @param value The value to use for the group
19532 * This sets the value of the radio group and will also set the value if
19533 * pointed to, to the value supplied, but will not call any callbacks.
19535 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
19537 * @brief Get the state of the radio object
19539 * @param obj The radio object
19540 * @return The integer state
19542 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19544 * @brief Set a convenience pointer to a integer to change
19546 * @param obj The radio object
19547 * @param valuep Pointer to the integer to modify
19549 * This sets a pointer to a integer, that, in addition to the radio objects
19550 * state will also be modified directly. To stop setting the object pointed
19551 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
19552 * when this is called, the radio objects state will also be modified to
19553 * reflect the value of the integer valuep points to, just like calling
19554 * elm_radio_value_set().
19556 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
19562 * @defgroup Pager Pager
19564 * @image html img/widget/pager/preview-00.png
19565 * @image latex img/widget/pager/preview-00.eps
19567 * @brief Widget that allows flipping between 1 or more “pages” of objects.
19569 * The flipping between “pages” of objects is animated. All content in pager
19570 * is kept in a stack, the last content to be added will be on the top of the
19571 * stack(be visible).
19573 * Objects can be pushed or popped from the stack or deleted as normal.
19574 * Pushes and pops will animate (and a pop will delete the object once the
19575 * animation is finished). Any object already in the pager can be promoted to
19576 * the top(from its current stacking position) through the use of
19577 * elm_pager_content_promote(). Objects are pushed to the top with
19578 * elm_pager_content_push() and when the top item is no longer wanted, simply
19579 * pop it with elm_pager_content_pop() and it will also be deleted. If an
19580 * object is no longer needed and is not the top item, just delete it as
19581 * normal. You can query which objects are the top and bottom with
19582 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
19584 * Signals that you can add callbacks for are:
19585 * "hide,finished" - when the previous page is hided
19587 * This widget has the following styles available:
19590 * @li fade_translucide
19591 * @li fade_invisible
19592 * @note This styles affect only the flipping animations, the appearance when
19593 * not animating is unaffected by styles.
19595 * @ref tutorial_pager gives a good overview of the usage of the API.
19599 * Add a new pager to the parent
19601 * @param parent The parent object
19602 * @return The new object or NULL if it cannot be created
19606 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19608 * @brief Push an object to the top of the pager stack (and show it).
19610 * @param obj The pager object
19611 * @param content The object to push
19613 * The object pushed becomes a child of the pager, it will be controlled and
19614 * deleted when the pager is deleted.
19616 * @note If the content is already in the stack use
19617 * elm_pager_content_promote().
19618 * @warning Using this function on @p content already in the stack results in
19619 * undefined behavior.
19621 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
19623 * @brief Pop the object that is on top of the stack
19625 * @param obj The pager object
19627 * This pops the object that is on the top(visible) of the pager, makes it
19628 * disappear, then deletes the object. The object that was underneath it on
19629 * the stack will become visible.
19631 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
19633 * @brief Moves an object already in the pager stack to the top of the stack.
19635 * @param obj The pager object
19636 * @param content The object to promote
19638 * This will take the @p content and move it to the top of the stack as
19639 * if it had been pushed there.
19641 * @note If the content isn't already in the stack use
19642 * elm_pager_content_push().
19643 * @warning Using this function on @p content not already in the stack
19644 * results in undefined behavior.
19646 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
19648 * @brief Return the object at the bottom of the pager stack
19650 * @param obj The pager object
19651 * @return The bottom object or NULL if none
19653 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19655 * @brief Return the object at the top of the pager stack
19657 * @param obj The pager object
19658 * @return The top object or NULL if none
19660 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19662 EAPI void elm_pager_to_content_pop(Evas_Object *obj, Evas_Object *content); EINA_ARG_NONNULL(1);
19663 EAPI void elm_pager_animation_disabled_set(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
19670 * @defgroup Slideshow Slideshow
19672 * @image html img/widget/slideshow/preview-00.png
19673 * @image latex img/widget/slideshow/preview-00.eps
19675 * This widget, as the name indicates, is a pre-made image
19676 * slideshow panel, with API functions acting on (child) image
19677 * items presentation. Between those actions, are:
19678 * - advance to next/previous image
19679 * - select the style of image transition animation
19680 * - set the exhibition time for each image
19681 * - start/stop the slideshow
19683 * The transition animations are defined in the widget's theme,
19684 * consequently new animations can be added without having to
19685 * update the widget's code.
19687 * @section Slideshow_Items Slideshow items
19689 * For slideshow items, just like for @ref Genlist "genlist" ones,
19690 * the user defines a @b classes, specifying functions that will be
19691 * called on the item's creation and deletion times.
19693 * The #Elm_Slideshow_Item_Class structure contains the following
19696 * - @c func.get - When an item is displayed, this function is
19697 * called, and it's where one should create the item object, de
19698 * facto. For example, the object can be a pure Evas image object
19699 * or an Elementary @ref Photocam "photocam" widget. See
19700 * #SlideshowItemGetFunc.
19701 * - @c func.del - When an item is no more displayed, this function
19702 * is called, where the user must delete any data associated to
19703 * the item. See #SlideshowItemDelFunc.
19705 * @section Slideshow_Caching Slideshow caching
19707 * The slideshow provides facilities to have items adjacent to the
19708 * one being displayed <b>already "realized"</b> (i.e. loaded) for
19709 * you, so that the system does not have to decode image data
19710 * anymore at the time it has to actually switch images on its
19711 * viewport. The user is able to set the numbers of items to be
19712 * cached @b before and @b after the current item, in the widget's
19715 * Smart events one can add callbacks for are:
19717 * - @c "changed" - when the slideshow switches its view to a new
19720 * List of examples for the slideshow widget:
19721 * @li @ref slideshow_example
19725 * @addtogroup Slideshow
19729 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
19730 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
19731 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Slideshow item handle */
19732 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
19733 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
19736 * @struct _Elm_Slideshow_Item_Class
19738 * Slideshow item class definition. See @ref Slideshow_Items for
19741 struct _Elm_Slideshow_Item_Class
19743 struct _Elm_Slideshow_Item_Class_Func
19745 SlideshowItemGetFunc get;
19746 SlideshowItemDelFunc del;
19748 }; /**< #Elm_Slideshow_Item_Class member definitions */
19751 * Add a new slideshow widget to the given parent Elementary
19752 * (container) object
19754 * @param parent The parent object
19755 * @return A new slideshow widget handle or @c NULL, on errors
19757 * This function inserts a new slideshow widget on the canvas.
19759 * @ingroup Slideshow
19761 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19764 * Add (append) a new item in a given slideshow widget.
19766 * @param obj The slideshow object
19767 * @param itc The item class for the item
19768 * @param data The item's data
19769 * @return A handle to the item added or @c NULL, on errors
19771 * Add a new item to @p obj's internal list of items, appending it.
19772 * The item's class must contain the function really fetching the
19773 * image object to show for this item, which could be an Evas image
19774 * object or an Elementary photo, for example. The @p data
19775 * parameter is going to be passed to both class functions of the
19778 * @see #Elm_Slideshow_Item_Class
19779 * @see elm_slideshow_item_sorted_insert()
19781 * @ingroup Slideshow
19783 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
19786 * Insert a new item into the given slideshow widget, using the @p func
19787 * function to sort items (by item handles).
19789 * @param obj The slideshow object
19790 * @param itc The item class for the item
19791 * @param data The item's data
19792 * @param func The comparing function to be used to sort slideshow
19793 * items <b>by #Elm_Slideshow_Item item handles</b>
19794 * @return Returns The slideshow item handle, on success, or
19795 * @c NULL, on errors
19797 * Add a new item to @p obj's internal list of items, in a position
19798 * determined by the @p func comparing function. The item's class
19799 * must contain the function really fetching the image object to
19800 * show for this item, which could be an Evas image object or an
19801 * Elementary photo, for example. The @p data parameter is going to
19802 * be passed to both class functions of the item.
19804 * @see #Elm_Slideshow_Item_Class
19805 * @see elm_slideshow_item_add()
19807 * @ingroup Slideshow
19809 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);
19812 * Display a given slideshow widget's item, programmatically.
19814 * @param obj The slideshow object
19815 * @param item The item to display on @p obj's viewport
19817 * The change between the current item and @p item will use the
19818 * transition @p obj is set to use (@see
19819 * elm_slideshow_transition_set()).
19821 * @ingroup Slideshow
19823 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
19826 * Slide to the @b next item, in a given slideshow widget
19828 * @param obj The slideshow object
19830 * The sliding animation @p obj is set to use will be the
19831 * transition effect used, after this call is issued.
19833 * @note If the end of the slideshow's internal list of items is
19834 * reached, it'll wrap around to the list's beginning, again.
19836 * @ingroup Slideshow
19838 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
19841 * Slide to the @b previous item, in a given slideshow widget
19843 * @param obj The slideshow object
19845 * The sliding animation @p obj is set to use will be the
19846 * transition effect used, after this call is issued.
19848 * @note If the beginning of the slideshow's internal list of items
19849 * is reached, it'll wrap around to the list's end, again.
19851 * @ingroup Slideshow
19853 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
19856 * Returns the list of sliding transition/effect names available, for a
19857 * given slideshow widget.
19859 * @param obj The slideshow object
19860 * @return The list of transitions (list of @b stringshared strings
19863 * The transitions, which come from @p obj's theme, must be an EDC
19864 * data item named @c "transitions" on the theme file, with (prefix)
19865 * names of EDC programs actually implementing them.
19867 * The available transitions for slideshows on the default theme are:
19868 * - @c "fade" - the current item fades out, while the new one
19869 * fades in to the slideshow's viewport.
19870 * - @c "black_fade" - the current item fades to black, and just
19871 * then, the new item will fade in.
19872 * - @c "horizontal" - the current item slides horizontally, until
19873 * it gets out of the slideshow's viewport, while the new item
19874 * comes from the left to take its place.
19875 * - @c "vertical" - the current item slides vertically, until it
19876 * gets out of the slideshow's viewport, while the new item comes
19877 * from the bottom to take its place.
19878 * - @c "square" - the new item starts to appear from the middle of
19879 * the current one, but with a tiny size, growing until its
19880 * target (full) size and covering the old one.
19882 * @warning The stringshared strings get no new references
19883 * exclusive to the user grabbing the list, here, so if you'd like
19884 * to use them out of this call's context, you'd better @c
19885 * eina_stringshare_ref() them.
19887 * @see elm_slideshow_transition_set()
19889 * @ingroup Slideshow
19891 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19894 * Set the current slide transition/effect in use for a given
19897 * @param obj The slideshow object
19898 * @param transition The new transition's name string
19900 * If @p transition is implemented in @p obj's theme (i.e., is
19901 * contained in the list returned by
19902 * elm_slideshow_transitions_get()), this new sliding effect will
19903 * be used on the widget.
19905 * @see elm_slideshow_transitions_get() for more details
19907 * @ingroup Slideshow
19909 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
19912 * Get the current slide transition/effect in use for a given
19915 * @param obj The slideshow object
19916 * @return The current transition's name
19918 * @see elm_slideshow_transition_set() for more details
19920 * @ingroup Slideshow
19922 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19925 * Set the interval between each image transition on a given
19926 * slideshow widget, <b>and start the slideshow, itself</b>
19928 * @param obj The slideshow object
19929 * @param timeout The new displaying timeout for images
19931 * After this call, the slideshow widget will start cycling its
19932 * view, sequentially and automatically, with the images of the
19933 * items it has. The time between each new image displayed is going
19934 * to be @p timeout, in @b seconds. If a different timeout was set
19935 * previously and an slideshow was in progress, it will continue
19936 * with the new time between transitions, after this call.
19938 * @note A value less than or equal to 0 on @p timeout will disable
19939 * the widget's internal timer, thus halting any slideshow which
19940 * could be happening on @p obj.
19942 * @see elm_slideshow_timeout_get()
19944 * @ingroup Slideshow
19946 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
19949 * Get the interval set for image transitions on a given slideshow
19952 * @param obj The slideshow object
19953 * @return Returns the timeout set on it
19955 * @see elm_slideshow_timeout_set() for more details
19957 * @ingroup Slideshow
19959 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19962 * Set if, after a slideshow is started, for a given slideshow
19963 * widget, its items should be displayed cyclically or not.
19965 * @param obj The slideshow object
19966 * @param loop Use @c EINA_TRUE to make it cycle through items or
19967 * @c EINA_FALSE for it to stop at the end of @p obj's internal
19970 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
19971 * ignore what is set by this functions, i.e., they'll @b always
19972 * cycle through items. This affects only the "automatic"
19973 * slideshow, as set by elm_slideshow_timeout_set().
19975 * @see elm_slideshow_loop_get()
19977 * @ingroup Slideshow
19979 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
19982 * Get if, after a slideshow is started, for a given slideshow
19983 * widget, its items are to be displayed cyclically or not.
19985 * @param obj The slideshow object
19986 * @return @c EINA_TRUE, if the items in @p obj will be cycled
19987 * through or @c EINA_FALSE, otherwise
19989 * @see elm_slideshow_loop_set() for more details
19991 * @ingroup Slideshow
19993 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19996 * Remove all items from a given slideshow widget
19998 * @param obj The slideshow object
20000 * This removes (and deletes) all items in @p obj, leaving it
20003 * @see elm_slideshow_item_del(), to remove just one item.
20005 * @ingroup Slideshow
20007 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20010 * Get the internal list of items in a given slideshow widget.
20012 * @param obj The slideshow object
20013 * @return The list of items (#Elm_Slideshow_Item as data) or
20014 * @c NULL on errors.
20016 * This list is @b not to be modified in any way and must not be
20017 * freed. Use the list members with functions like
20018 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
20020 * @warning This list is only valid until @p obj object's internal
20021 * items list is changed. It should be fetched again with another
20022 * call to this function when changes happen.
20024 * @ingroup Slideshow
20026 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20029 * Delete a given item from a slideshow widget.
20031 * @param item The slideshow item
20033 * @ingroup Slideshow
20035 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20038 * Return the data associated with a given slideshow item
20040 * @param item The slideshow item
20041 * @return Returns the data associated to this item
20043 * @ingroup Slideshow
20045 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20048 * Returns the currently displayed item, in a given slideshow widget
20050 * @param obj The slideshow object
20051 * @return A handle to the item being displayed in @p obj or
20052 * @c NULL, if none is (and on errors)
20054 * @ingroup Slideshow
20056 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20059 * Get the real Evas object created to implement the view of a
20060 * given slideshow item
20062 * @param item The slideshow item.
20063 * @return the Evas object implementing this item's view.
20065 * This returns the actual Evas object used to implement the
20066 * specified slideshow item's view. This may be @c NULL, as it may
20067 * not have been created or may have been deleted, at any time, by
20068 * the slideshow. <b>Do not modify this object</b> (move, resize,
20069 * show, hide, etc.), as the slideshow is controlling it. This
20070 * function is for querying, emitting custom signals or hooking
20071 * lower level callbacks for events on that object. Do not delete
20072 * this object under any circumstances.
20074 * @see elm_slideshow_item_data_get()
20076 * @ingroup Slideshow
20078 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
20081 * Get the the item, in a given slideshow widget, placed at
20082 * position @p nth, in its internal items list
20084 * @param obj The slideshow object
20085 * @param nth The number of the item to grab a handle to (0 being
20087 * @return The item stored in @p obj at position @p nth or @c NULL,
20088 * if there's no item with that index (and on errors)
20090 * @ingroup Slideshow
20092 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
20095 * Set the current slide layout in use for a given slideshow widget
20097 * @param obj The slideshow object
20098 * @param layout The new layout's name string
20100 * If @p layout is implemented in @p obj's theme (i.e., is contained
20101 * in the list returned by elm_slideshow_layouts_get()), this new
20102 * images layout will be used on the widget.
20104 * @see elm_slideshow_layouts_get() for more details
20106 * @ingroup Slideshow
20108 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
20111 * Get the current slide layout in use for a given slideshow widget
20113 * @param obj The slideshow object
20114 * @return The current layout's name
20116 * @see elm_slideshow_layout_set() for more details
20118 * @ingroup Slideshow
20120 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20123 * Returns the list of @b layout names available, for a given
20124 * slideshow widget.
20126 * @param obj The slideshow object
20127 * @return The list of layouts (list of @b stringshared strings
20130 * Slideshow layouts will change how the widget is to dispose each
20131 * image item in its viewport, with regard to cropping, scaling,
20134 * The layouts, which come from @p obj's theme, must be an EDC
20135 * data item name @c "layouts" on the theme file, with (prefix)
20136 * names of EDC programs actually implementing them.
20138 * The available layouts for slideshows on the default theme are:
20139 * - @c "fullscreen" - item images with original aspect, scaled to
20140 * touch top and down slideshow borders or, if the image's heigh
20141 * is not enough, left and right slideshow borders.
20142 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
20143 * one, but always leaving 10% of the slideshow's dimensions of
20144 * distance between the item image's borders and the slideshow
20145 * borders, for each axis.
20147 * @warning The stringshared strings get no new references
20148 * exclusive to the user grabbing the list, here, so if you'd like
20149 * to use them out of this call's context, you'd better @c
20150 * eina_stringshare_ref() them.
20152 * @see elm_slideshow_layout_set()
20154 * @ingroup Slideshow
20156 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20159 * Set the number of items to cache, on a given slideshow widget,
20160 * <b>before the current item</b>
20162 * @param obj The slideshow object
20163 * @param count Number of items to cache before the current one
20165 * The default value for this property is @c 2. See
20166 * @ref Slideshow_Caching "slideshow caching" for more details.
20168 * @see elm_slideshow_cache_before_get()
20170 * @ingroup Slideshow
20172 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20175 * Retrieve the number of items to cache, on a given slideshow widget,
20176 * <b>before the current item</b>
20178 * @param obj The slideshow object
20179 * @return The number of items set to be cached before the current one
20181 * @see elm_slideshow_cache_before_set() for more details
20183 * @ingroup Slideshow
20185 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20188 * Set the number of items to cache, on a given slideshow widget,
20189 * <b>after the current item</b>
20191 * @param obj The slideshow object
20192 * @param count Number of items to cache after the current one
20194 * The default value for this property is @c 2. See
20195 * @ref Slideshow_Caching "slideshow caching" for more details.
20197 * @see elm_slideshow_cache_after_get()
20199 * @ingroup Slideshow
20201 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20204 * Retrieve the number of items to cache, on a given slideshow widget,
20205 * <b>after the current item</b>
20207 * @param obj The slideshow object
20208 * @return The number of items set to be cached after the current one
20210 * @see elm_slideshow_cache_after_set() for more details
20212 * @ingroup Slideshow
20214 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20217 * Get the number of items stored in a given slideshow widget
20219 * @param obj The slideshow object
20220 * @return The number of items on @p obj, at the moment of this call
20222 * @ingroup Slideshow
20224 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20231 * @defgroup Fileselector File Selector
20233 * @image html img/widget/fileselector/preview-00.png
20234 * @image latex img/widget/fileselector/preview-00.eps
20236 * A file selector is a widget that allows a user to navigate
20237 * through a file system, reporting file selections back via its
20240 * It contains shortcut buttons for home directory (@c ~) and to
20241 * jump one directory upwards (..), as well as cancel/ok buttons to
20242 * confirm/cancel a given selection. After either one of those two
20243 * former actions, the file selector will issue its @c "done" smart
20246 * There's a text entry on it, too, showing the name of the current
20247 * selection. There's the possibility of making it editable, so it
20248 * is useful on file saving dialogs on applications, where one
20249 * gives a file name to save contents to, in a given directory in
20250 * the system. This custom file name will be reported on the @c
20251 * "done" smart callback (explained in sequence).
20253 * Finally, it has a view to display file system items into in two
20258 * If Elementary is built with support of the Ethumb thumbnailing
20259 * library, the second form of view will display preview thumbnails
20260 * of files which it supports.
20262 * Smart callbacks one can register to:
20264 * - @c "selected" - the user has clicked on a file (when not in
20265 * folders-only mode) or directory (when in folders-only mode)
20266 * - @c "directory,open" - the list has been populated with new
20267 * content (@c event_info is a pointer to the directory's
20268 * path, a @b stringshared string)
20269 * - @c "done" - the user has clicked on the "ok" or "cancel"
20270 * buttons (@c event_info is a pointer to the selection's
20271 * path, a @b stringshared string)
20273 * Here is an example on its usage:
20274 * @li @ref fileselector_example
20278 * @addtogroup Fileselector
20283 * Defines how a file selector widget is to layout its contents
20284 * (file system entries).
20286 typedef enum _Elm_Fileselector_Mode
20288 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
20289 ELM_FILESELECTOR_GRID, /**< layout as a grid */
20290 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
20291 } Elm_Fileselector_Mode;
20294 * Add a new file selector widget to the given parent Elementary
20295 * (container) object
20297 * @param parent The parent object
20298 * @return a new file selector widget handle or @c NULL, on errors
20300 * This function inserts a new file selector widget on the canvas.
20302 * @ingroup Fileselector
20304 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20307 * Enable/disable the file name entry box where the user can type
20308 * in a name for a file, in a given file selector widget
20310 * @param obj The file selector object
20311 * @param is_save @c EINA_TRUE to make the file selector a "saving
20312 * dialog", @c EINA_FALSE otherwise
20314 * Having the entry editable is useful on file saving dialogs on
20315 * applications, where one gives a file name to save contents to,
20316 * in a given directory in the system. This custom file name will
20317 * be reported on the @c "done" smart callback.
20319 * @see elm_fileselector_is_save_get()
20321 * @ingroup Fileselector
20323 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
20326 * Get whether the given file selector is in "saving dialog" mode
20328 * @param obj The file selector object
20329 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
20330 * mode, @c EINA_FALSE otherwise (and on errors)
20332 * @see elm_fileselector_is_save_set() for more details
20334 * @ingroup Fileselector
20336 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20339 * Enable/disable folder-only view for a given file selector widget
20341 * @param obj The file selector object
20342 * @param only @c EINA_TRUE to make @p obj only display
20343 * directories, @c EINA_FALSE to make files to be displayed in it
20346 * If enabled, the widget's view will only display folder items,
20349 * @see elm_fileselector_folder_only_get()
20351 * @ingroup Fileselector
20353 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
20356 * Get whether folder-only view is set for a given file selector
20359 * @param obj The file selector object
20360 * @return only @c EINA_TRUE if @p obj is only displaying
20361 * directories, @c EINA_FALSE if files are being displayed in it
20362 * too (and on errors)
20364 * @see elm_fileselector_folder_only_get()
20366 * @ingroup Fileselector
20368 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20371 * Enable/disable the "ok" and "cancel" buttons on a given file
20374 * @param obj The file selector object
20375 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
20377 * @note A file selector without those buttons will never emit the
20378 * @c "done" smart event, and is only usable if one is just hooking
20379 * to the other two events.
20381 * @see elm_fileselector_buttons_ok_cancel_get()
20383 * @ingroup Fileselector
20385 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
20388 * Get whether the "ok" and "cancel" buttons on a given file
20389 * selector widget are being shown.
20391 * @param obj The file selector object
20392 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
20393 * otherwise (and on errors)
20395 * @see elm_fileselector_buttons_ok_cancel_set() for more details
20397 * @ingroup Fileselector
20399 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20402 * Enable/disable a tree view in the given file selector widget,
20403 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
20405 * @param obj The file selector object
20406 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
20409 * In a tree view, arrows are created on the sides of directories,
20410 * allowing them to expand in place.
20412 * @note If it's in other mode, the changes made by this function
20413 * will only be visible when one switches back to "list" mode.
20415 * @see elm_fileselector_expandable_get()
20417 * @ingroup Fileselector
20419 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
20422 * Get whether tree view is enabled for the given file selector
20425 * @param obj The file selector object
20426 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
20427 * otherwise (and or errors)
20429 * @see elm_fileselector_expandable_set() for more details
20431 * @ingroup Fileselector
20433 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20436 * Set, programmatically, the @b directory that a given file
20437 * selector widget will display contents from
20439 * @param obj The file selector object
20440 * @param path The path to display in @p obj
20442 * This will change the @b directory that @p obj is displaying. It
20443 * will also clear the text entry area on the @p obj object, which
20444 * displays select files' names.
20446 * @see elm_fileselector_path_get()
20448 * @ingroup Fileselector
20450 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
20453 * Get the parent directory's path that a given file selector
20454 * widget is displaying
20456 * @param obj The file selector object
20457 * @return The (full) path of the directory the file selector is
20458 * displaying, a @b stringshared string
20460 * @see elm_fileselector_path_set()
20462 * @ingroup Fileselector
20464 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20467 * Set, programmatically, the currently selected file/directory in
20468 * the given file selector widget
20470 * @param obj The file selector object
20471 * @param path The (full) path to a file or directory
20472 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
20473 * latter case occurs if the directory or file pointed to do not
20476 * @see elm_fileselector_selected_get()
20478 * @ingroup Fileselector
20480 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
20483 * Get the currently selected item's (full) path, in the given file
20486 * @param obj The file selector object
20487 * @return The absolute path of the selected item, a @b
20488 * stringshared string
20490 * @note Custom editions on @p obj object's text entry, if made,
20491 * will appear on the return string of this function, naturally.
20493 * @see elm_fileselector_selected_set() for more details
20495 * @ingroup Fileselector
20497 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20500 * Set the mode in which a given file selector widget will display
20501 * (layout) file system entries in its view
20503 * @param obj The file selector object
20504 * @param mode The mode of the fileselector, being it one of
20505 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
20506 * first one, naturally, will display the files in a list. The
20507 * latter will make the widget to display its entries in a grid
20510 * @note By using elm_fileselector_expandable_set(), the user may
20511 * trigger a tree view for that list.
20513 * @note If Elementary is built with support of the Ethumb
20514 * thumbnailing library, the second form of view will display
20515 * preview thumbnails of files which it supports. You must have
20516 * elm_need_ethumb() called in your Elementary for thumbnailing to
20519 * @see elm_fileselector_expandable_set().
20520 * @see elm_fileselector_mode_get().
20522 * @ingroup Fileselector
20524 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
20527 * Get the mode in which a given file selector widget is displaying
20528 * (layouting) file system entries in its view
20530 * @param obj The fileselector object
20531 * @return The mode in which the fileselector is at
20533 * @see elm_fileselector_mode_set() for more details
20535 * @ingroup Fileselector
20537 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20544 * @defgroup Progressbar Progress bar
20546 * The progress bar is a widget for visually representing the
20547 * progress status of a given job/task.
20549 * A progress bar may be horizontal or vertical. It may display an
20550 * icon besides it, as well as primary and @b units labels. The
20551 * former is meant to label the widget as a whole, while the
20552 * latter, which is formatted with floating point values (and thus
20553 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
20554 * units"</c>), is meant to label the widget's <b>progress
20555 * value</b>. Label, icon and unit strings/objects are @b optional
20556 * for progress bars.
20558 * A progress bar may be @b inverted, in which state it gets its
20559 * values inverted, with high values being on the left or top and
20560 * low values on the right or bottom, as opposed to normally have
20561 * the low values on the former and high values on the latter,
20562 * respectively, for horizontal and vertical modes.
20564 * The @b span of the progress, as set by
20565 * elm_progressbar_span_size_set(), is its length (horizontally or
20566 * vertically), unless one puts size hints on the widget to expand
20567 * on desired directions, by any container. That length will be
20568 * scaled by the object or applications scaling factor. At any
20569 * point code can query the progress bar for its value with
20570 * elm_progressbar_value_get().
20572 * Available widget styles for progress bars:
20574 * - @c "wheel" (simple style, no text, no progression, only
20575 * "pulse" effect is available)
20577 * Default contents parts of the progressbar widget that you can use for are:
20578 * @li "elm.swallow.content" - A icon of the progressbar
20580 * Here is an example on its usage:
20581 * @li @ref progressbar_example
20585 * Add a new progress bar widget to the given parent Elementary
20586 * (container) object
20588 * @param parent The parent object
20589 * @return a new progress bar widget handle or @c NULL, on errors
20591 * This function inserts a new progress bar widget on the canvas.
20593 * @ingroup Progressbar
20595 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20598 * Set whether a given progress bar widget is at "pulsing mode" or
20601 * @param obj The progress bar object
20602 * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
20603 * @c EINA_FALSE to put it back to its default one
20605 * By default, progress bars will display values from the low to
20606 * high value boundaries. There are, though, contexts in which the
20607 * state of progression of a given task is @b unknown. For those,
20608 * one can set a progress bar widget to a "pulsing state", to give
20609 * the user an idea that some computation is being held, but
20610 * without exact progress values. In the default theme it will
20611 * animate its bar with the contents filling in constantly and back
20612 * to non-filled, in a loop. To start and stop this pulsing
20613 * animation, one has to explicitly call elm_progressbar_pulse().
20615 * @see elm_progressbar_pulse_get()
20616 * @see elm_progressbar_pulse()
20618 * @ingroup Progressbar
20620 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
20623 * Get whether a given progress bar widget is at "pulsing mode" or
20626 * @param obj The progress bar object
20627 * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
20628 * if it's in the default one (and on errors)
20630 * @ingroup Progressbar
20632 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20635 * Start/stop a given progress bar "pulsing" animation, if its
20638 * @param obj The progress bar object
20639 * @param state @c EINA_TRUE, to @b start the pulsing animation,
20640 * @c EINA_FALSE to @b stop it
20642 * @note This call won't do anything if @p obj is not under "pulsing mode".
20644 * @see elm_progressbar_pulse_set() for more details.
20646 * @ingroup Progressbar
20648 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
20651 * Set the progress value (in percentage) on a given progress bar
20654 * @param obj The progress bar object
20655 * @param val The progress value (@b must be between @c 0.0 and @c
20658 * Use this call to set progress bar levels.
20660 * @note If you passes a value out of the specified range for @p
20661 * val, it will be interpreted as the @b closest of the @b boundary
20662 * values in the range.
20664 * @ingroup Progressbar
20666 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
20669 * Get the progress value (in percentage) on a given progress bar
20672 * @param obj The progress bar object
20673 * @return The value of the progressbar
20675 * @see elm_progressbar_value_set() for more details
20677 * @ingroup Progressbar
20679 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20682 * Set the label of a given progress bar widget
20684 * @param obj The progress bar object
20685 * @param label The text label string, in UTF-8
20687 * @ingroup Progressbar
20688 * @deprecated use elm_object_text_set() instead.
20690 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
20693 * Get the label of a given progress bar widget
20695 * @param obj The progressbar object
20696 * @return The text label string, in UTF-8
20698 * @ingroup Progressbar
20699 * @deprecated use elm_object_text_set() instead.
20701 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20704 * Set the icon object of a given progress bar widget
20706 * @param obj The progress bar object
20707 * @param icon The icon object
20709 * Use this call to decorate @p obj with an icon next to it.
20711 * @note Once the icon object is set, a previously set one will be
20712 * deleted. If you want to keep that old content object, use the
20713 * elm_progressbar_icon_unset() function.
20715 * @see elm_progressbar_icon_get()
20716 * @deprecated use elm_object_content_set() instead.
20718 * @ingroup Progressbar
20720 EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
20723 * Retrieve the icon object set for a given progress bar widget
20725 * @param obj The progress bar object
20726 * @return The icon object's handle, if @p obj had one set, or @c NULL,
20727 * otherwise (and on errors)
20729 * @see elm_progressbar_icon_set() for more details
20730 * @deprecated use elm_object_content_set() instead.
20732 * @ingroup Progressbar
20734 EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20737 * Unset an icon set on a given progress bar widget
20739 * @param obj The progress bar object
20740 * @return The icon object that was being used, if any was set, or
20741 * @c NULL, otherwise (and on errors)
20743 * This call will unparent and return the icon object which was set
20744 * for this widget, previously, on success.
20746 * @see elm_progressbar_icon_set() for more details
20747 * @deprecated use elm_object_content_unset() instead.
20749 * @ingroup Progressbar
20751 EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20754 * Set the (exact) length of the bar region of a given progress bar
20757 * @param obj The progress bar object
20758 * @param size The length of the progress bar's bar region
20760 * This sets the minimum width (when in horizontal mode) or height
20761 * (when in vertical mode) of the actual bar area of the progress
20762 * bar @p obj. This in turn affects the object's minimum size. Use
20763 * this when you're not setting other size hints expanding on the
20764 * given direction (like weight and alignment hints) and you would
20765 * like it to have a specific size.
20767 * @note Icon, label and unit text around @p obj will require their
20768 * own space, which will make @p obj to require more the @p size,
20771 * @see elm_progressbar_span_size_get()
20773 * @ingroup Progressbar
20775 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
20778 * Get the length set for the bar region of a given progress bar
20781 * @param obj The progress bar object
20782 * @return The length of the progress bar's bar region
20784 * If that size was not set previously, with
20785 * elm_progressbar_span_size_set(), this call will return @c 0.
20787 * @ingroup Progressbar
20789 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20792 * Set the format string for a given progress bar widget's units
20795 * @param obj The progress bar object
20796 * @param format The format string for @p obj's units label
20798 * If @c NULL is passed on @p format, it will make @p obj's units
20799 * area to be hidden completely. If not, it'll set the <b>format
20800 * string</b> for the units label's @b text. The units label is
20801 * provided a floating point value, so the units text is up display
20802 * at most one floating point falue. Note that the units label is
20803 * optional. Use a format string such as "%1.2f meters" for
20806 * @note The default format string for a progress bar is an integer
20807 * percentage, as in @c "%.0f %%".
20809 * @see elm_progressbar_unit_format_get()
20811 * @ingroup Progressbar
20813 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
20816 * Retrieve the format string set for a given progress bar widget's
20819 * @param obj The progress bar object
20820 * @return The format set string for @p obj's units label or
20821 * @c NULL, if none was set (and on errors)
20823 * @see elm_progressbar_unit_format_set() for more details
20825 * @ingroup Progressbar
20827 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20830 * Set the orientation of a given progress bar widget
20832 * @param obj The progress bar object
20833 * @param horizontal Use @c EINA_TRUE to make @p obj to be
20834 * @b horizontal, @c EINA_FALSE to make it @b vertical
20836 * Use this function to change how your progress bar is to be
20837 * disposed: vertically or horizontally.
20839 * @see elm_progressbar_horizontal_get()
20841 * @ingroup Progressbar
20843 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
20846 * Retrieve the orientation of a given progress bar widget
20848 * @param obj The progress bar object
20849 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
20850 * @c EINA_FALSE if it's @b vertical (and on errors)
20852 * @see elm_progressbar_horizontal_set() for more details
20854 * @ingroup Progressbar
20856 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20859 * Invert a given progress bar widget's displaying values order
20861 * @param obj The progress bar object
20862 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
20863 * @c EINA_FALSE to bring it back to default, non-inverted values.
20865 * A progress bar may be @b inverted, in which state it gets its
20866 * values inverted, with high values being on the left or top and
20867 * low values on the right or bottom, as opposed to normally have
20868 * the low values on the former and high values on the latter,
20869 * respectively, for horizontal and vertical modes.
20871 * @see elm_progressbar_inverted_get()
20873 * @ingroup Progressbar
20875 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
20878 * Get whether a given progress bar widget's displaying values are
20881 * @param obj The progress bar object
20882 * @return @c EINA_TRUE, if @p obj has inverted values,
20883 * @c EINA_FALSE otherwise (and on errors)
20885 * @see elm_progressbar_inverted_set() for more details
20887 * @ingroup Progressbar
20889 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20892 * @defgroup Separator Separator
20894 * @brief Separator is a very thin object used to separate other objects.
20896 * A separator can be vertical or horizontal.
20898 * @ref tutorial_separator is a good example of how to use a separator.
20902 * @brief Add a separator object to @p parent
20904 * @param parent The parent object
20906 * @return The separator object, or NULL upon failure
20908 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20910 * @brief Set the horizontal mode of a separator object
20912 * @param obj The separator object
20913 * @param horizontal If true, the separator is horizontal
20915 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
20917 * @brief Get the horizontal mode of a separator object
20919 * @param obj The separator object
20920 * @return If true, the separator is horizontal
20922 * @see elm_separator_horizontal_set()
20924 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20930 * @addtogroup Spinner
20935 * Add a new spinner widget to the given parent Elementary
20936 * (container) object.
20938 * @param parent The parent object.
20939 * @return a new spinner widget handle or @c NULL, on errors.
20941 * This function inserts a new spinner widget on the canvas.
20946 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20949 * Set the format string of the displayed label.
20951 * @param obj The spinner object.
20952 * @param fmt The format string for the label display.
20954 * If @c NULL, this sets the format to "%.0f". If not it sets the format
20955 * string for the label text. The label text is provided a floating point
20956 * value, so the label text can display up to 1 floating point value.
20957 * Note that this is optional.
20959 * Use a format string such as "%1.2f meters" for example, and it will
20960 * display values like: "3.14 meters" for a value equal to 3.14159.
20962 * Default is "%0.f".
20964 * @see elm_spinner_label_format_get()
20968 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
20971 * Get the label format of the spinner.
20973 * @param obj The spinner object.
20974 * @return The text label format string in UTF-8.
20976 * @see elm_spinner_label_format_set() for details.
20980 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20983 * Set the minimum and maximum values for the spinner.
20985 * @param obj The spinner object.
20986 * @param min The minimum value.
20987 * @param max The maximum value.
20989 * Define the allowed range of values to be selected by the user.
20991 * If actual value is less than @p min, it will be updated to @p min. If it
20992 * is bigger then @p max, will be updated to @p max. Actual value can be
20993 * get with elm_spinner_value_get().
20995 * By default, min is equal to 0, and max is equal to 100.
20997 * @warning Maximum must be greater than minimum.
20999 * @see elm_spinner_min_max_get()
21003 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
21006 * Get the minimum and maximum values of the spinner.
21008 * @param obj The spinner object.
21009 * @param min Pointer where to store the minimum value.
21010 * @param max Pointer where to store the maximum value.
21012 * @note If only one value is needed, the other pointer can be passed
21015 * @see elm_spinner_min_max_set() for details.
21019 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
21022 * Set the step used to increment or decrement the spinner value.
21024 * @param obj The spinner object.
21025 * @param step The step value.
21027 * This value will be incremented or decremented to the displayed value.
21028 * It will be incremented while the user keep right or top arrow pressed,
21029 * and will be decremented while the user keep left or bottom arrow pressed.
21031 * The interval to increment / decrement can be set with
21032 * elm_spinner_interval_set().
21034 * By default step value is equal to 1.
21036 * @see elm_spinner_step_get()
21040 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
21043 * Get the step used to increment or decrement the spinner value.
21045 * @param obj The spinner object.
21046 * @return The step value.
21048 * @see elm_spinner_step_get() for more details.
21052 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21055 * Set the value the spinner displays.
21057 * @param obj The spinner object.
21058 * @param val The value to be displayed.
21060 * Value will be presented on the label following format specified with
21061 * elm_spinner_format_set().
21063 * @warning The value must to be between min and max values. This values
21064 * are set by elm_spinner_min_max_set().
21066 * @see elm_spinner_value_get().
21067 * @see elm_spinner_format_set().
21068 * @see elm_spinner_min_max_set().
21072 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21075 * Get the value displayed by the spinner.
21077 * @param obj The spinner object.
21078 * @return The value displayed.
21080 * @see elm_spinner_value_set() for details.
21084 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21087 * Set whether the spinner should wrap when it reaches its
21088 * minimum or maximum value.
21090 * @param obj The spinner object.
21091 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
21094 * Disabled by default. If disabled, when the user tries to increment the
21096 * but displayed value plus step value is bigger than maximum value,
21098 * won't allow it. The same happens when the user tries to decrement it,
21099 * but the value less step is less than minimum value.
21101 * When wrap is enabled, in such situations it will allow these changes,
21102 * but will get the value that would be less than minimum and subtracts
21103 * from maximum. Or add the value that would be more than maximum to
21107 * @li min value = 10
21108 * @li max value = 50
21109 * @li step value = 20
21110 * @li displayed value = 20
21112 * When the user decrement value (using left or bottom arrow), it will
21113 * displays @c 40, because max - (min - (displayed - step)) is
21114 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
21116 * @see elm_spinner_wrap_get().
21120 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
21123 * Get whether the spinner should wrap when it reaches its
21124 * minimum or maximum value.
21126 * @param obj The spinner object
21127 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
21128 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21130 * @see elm_spinner_wrap_set() for details.
21134 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21137 * Set whether the spinner can be directly edited by the user or not.
21139 * @param obj The spinner object.
21140 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
21141 * don't allow users to edit it directly.
21143 * Spinner objects can have edition @b disabled, in which state they will
21144 * be changed only by arrows.
21145 * Useful for contexts
21146 * where you don't want your users to interact with it writting the value.
21148 * when using special values, the user can see real value instead
21149 * of special label on edition.
21151 * It's enabled by default.
21153 * @see elm_spinner_editable_get()
21157 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
21160 * Get whether the spinner can be directly edited by the user or not.
21162 * @param obj The spinner object.
21163 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
21164 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21166 * @see elm_spinner_editable_set() for details.
21170 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21173 * Set a special string to display in the place of the numerical value.
21175 * @param obj The spinner object.
21176 * @param value The value to be replaced.
21177 * @param label The label to be used.
21179 * It's useful for cases when a user should select an item that is
21180 * better indicated by a label than a value. For example, weekdays or months.
21184 * sp = elm_spinner_add(win);
21185 * elm_spinner_min_max_set(sp, 1, 3);
21186 * elm_spinner_special_value_add(sp, 1, "January");
21187 * elm_spinner_special_value_add(sp, 2, "February");
21188 * elm_spinner_special_value_add(sp, 3, "March");
21189 * evas_object_show(sp);
21194 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
21197 * Set the interval on time updates for an user mouse button hold
21198 * on spinner widgets' arrows.
21200 * @param obj The spinner object.
21201 * @param interval The (first) interval value in seconds.
21203 * This interval value is @b decreased while the user holds the
21204 * mouse pointer either incrementing or decrementing spinner's value.
21206 * This helps the user to get to a given value distant from the
21207 * current one easier/faster, as it will start to change quicker and
21208 * quicker on mouse button holds.
21210 * The calculation for the next change interval value, starting from
21211 * the one set with this call, is the previous interval divided by
21212 * @c 1.05, so it decreases a little bit.
21214 * The default starting interval value for automatic changes is
21217 * @see elm_spinner_interval_get()
21221 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21224 * Get the interval on time updates for an user mouse button hold
21225 * on spinner widgets' arrows.
21227 * @param obj The spinner object.
21228 * @return The (first) interval value, in seconds, set on it.
21230 * @see elm_spinner_interval_set() for more details.
21234 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21241 * @defgroup Index Index
21243 * @image html img/widget/index/preview-00.png
21244 * @image latex img/widget/index/preview-00.eps
21246 * An index widget gives you an index for fast access to whichever
21247 * group of other UI items one might have. It's a list of text
21248 * items (usually letters, for alphabetically ordered access).
21250 * Index widgets are by default hidden and just appear when the
21251 * user clicks over it's reserved area in the canvas. In its
21252 * default theme, it's an area one @ref Fingers "finger" wide on
21253 * the right side of the index widget's container.
21255 * When items on the index are selected, smart callbacks get
21256 * called, so that its user can make other container objects to
21257 * show a given area or child object depending on the index item
21258 * selected. You'd probably be using an index together with @ref
21259 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
21262 * Smart events one can add callbacks for are:
21263 * - @c "changed" - When the selected index item changes. @c
21264 * event_info is the selected item's data pointer.
21265 * - @c "delay,changed" - When the selected index item changes, but
21266 * after a small idling period. @c event_info is the selected
21267 * item's data pointer.
21268 * - @c "selected" - When the user releases a mouse button and
21269 * selects an item. @c event_info is the selected item's data
21271 * - @c "level,up" - when the user moves a finger from the first
21272 * level to the second level
21273 * - @c "level,down" - when the user moves a finger from the second
21274 * level to the first level
21276 * The @c "delay,changed" event is so that it'll wait a small time
21277 * before actually reporting those events and, moreover, just the
21278 * last event happening on those time frames will actually be
21281 * Here are some examples on its usage:
21282 * @li @ref index_example_01
21283 * @li @ref index_example_02
21287 * @addtogroup Index
21291 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
21294 * Add a new index widget to the given parent Elementary
21295 * (container) object
21297 * @param parent The parent object
21298 * @return a new index widget handle or @c NULL, on errors
21300 * This function inserts a new index widget on the canvas.
21304 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21307 * Set whether a given index widget is or not visible,
21310 * @param obj The index object
21311 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
21313 * Not to be confused with visible as in @c evas_object_show() --
21314 * visible with regard to the widget's auto hiding feature.
21316 * @see elm_index_active_get()
21320 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
21323 * Get whether a given index widget is currently visible or not.
21325 * @param obj The index object
21326 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
21328 * @see elm_index_active_set() for more details
21332 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21335 * Set the items level for a given index widget.
21337 * @param obj The index object.
21338 * @param level @c 0 or @c 1, the currently implemented levels.
21340 * @see elm_index_item_level_get()
21344 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21347 * Get the items level set for a given index widget.
21349 * @param obj The index object.
21350 * @return @c 0 or @c 1, which are the levels @p obj might be at.
21352 * @see elm_index_item_level_set() for more information
21356 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21359 * Returns the last selected item's data, for a given index widget.
21361 * @param obj The index object.
21362 * @return The item @b data associated to the last selected item on
21363 * @p obj (or @c NULL, on errors).
21365 * @warning The returned value is @b not an #Elm_Index_Item item
21366 * handle, but the data associated to it (see the @c item parameter
21367 * in elm_index_item_append(), as an example).
21371 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21374 * Append a new item on a given index widget.
21376 * @param obj The index object.
21377 * @param letter Letter under which the item should be indexed
21378 * @param item The item data to set for the index's item
21380 * Despite the most common usage of the @p letter argument is for
21381 * single char strings, one could use arbitrary strings as index
21384 * @c item will be the pointer returned back on @c "changed", @c
21385 * "delay,changed" and @c "selected" smart events.
21389 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21392 * Prepend a new item on a given index widget.
21394 * @param obj The index object.
21395 * @param letter Letter under which the item should be indexed
21396 * @param item The item data to set for the index's item
21398 * Despite the most common usage of the @p letter argument is for
21399 * single char strings, one could use arbitrary strings as index
21402 * @c item will be the pointer returned back on @c "changed", @c
21403 * "delay,changed" and @c "selected" smart events.
21407 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21410 * Append a new item, on a given index widget, <b>after the item
21411 * having @p relative as data</b>.
21413 * @param obj The index object.
21414 * @param letter Letter under which the item should be indexed
21415 * @param item The item data to set for the index's item
21416 * @param relative The item data of the index item to be the
21417 * predecessor of this new one
21419 * Despite the most common usage of the @p letter argument is for
21420 * single char strings, one could use arbitrary strings as index
21423 * @c item will be the pointer returned back on @c "changed", @c
21424 * "delay,changed" and @c "selected" smart events.
21426 * @note If @p relative is @c NULL or if it's not found to be data
21427 * set on any previous item on @p obj, this function will behave as
21428 * elm_index_item_append().
21432 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
21435 * Prepend a new item, on a given index widget, <b>after the item
21436 * having @p relative as data</b>.
21438 * @param obj The index object.
21439 * @param letter Letter under which the item should be indexed
21440 * @param item The item data to set for the index's item
21441 * @param relative The item data of the index item to be the
21442 * successor of this new one
21444 * Despite the most common usage of the @p letter argument is for
21445 * single char strings, one could use arbitrary strings as index
21448 * @c item will be the pointer returned back on @c "changed", @c
21449 * "delay,changed" and @c "selected" smart events.
21451 * @note If @p relative is @c NULL or if it's not found to be data
21452 * set on any previous item on @p obj, this function will behave as
21453 * elm_index_item_prepend().
21457 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
21460 * Insert a new item into the given index widget, using @p cmp_func
21461 * function to sort items (by item handles).
21463 * @param obj The index object.
21464 * @param letter Letter under which the item should be indexed
21465 * @param item The item data to set for the index's item
21466 * @param cmp_func The comparing function to be used to sort index
21467 * items <b>by #Elm_Index_Item item handles</b>
21468 * @param cmp_data_func A @b fallback function to be called for the
21469 * sorting of index items <b>by item data</b>). It will be used
21470 * when @p cmp_func returns @c 0 (equality), which means an index
21471 * item with provided item data already exists. To decide which
21472 * data item should be pointed to by the index item in question, @p
21473 * cmp_data_func will be used. If @p cmp_data_func returns a
21474 * non-negative value, the previous index item data will be
21475 * replaced by the given @p item pointer. If the previous data need
21476 * to be freed, it should be done by the @p cmp_data_func function,
21477 * because all references to it will be lost. If this function is
21478 * not provided (@c NULL is given), index items will be @b
21479 * duplicated, if @p cmp_func returns @c 0.
21481 * Despite the most common usage of the @p letter argument is for
21482 * single char strings, one could use arbitrary strings as index
21485 * @c item will be the pointer returned back on @c "changed", @c
21486 * "delay,changed" and @c "selected" smart events.
21490 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);
21493 * Remove an item from a given index widget, <b>to be referenced by
21494 * it's data value</b>.
21496 * @param obj The index object
21497 * @param item The item's data pointer for the item to be removed
21500 * If a deletion callback is set, via elm_index_item_del_cb_set(),
21501 * that callback function will be called by this one.
21503 * @warning The item to be removed from @p obj will be found via
21504 * its item data pointer, and not by an #Elm_Index_Item handle.
21508 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
21511 * Find a given index widget's item, <b>using item data</b>.
21513 * @param obj The index object
21514 * @param item The item data pointed to by the desired index item
21515 * @return The index item handle, if found, or @c NULL otherwise
21519 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
21522 * Removes @b all items from a given index widget.
21524 * @param obj The index object.
21526 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
21527 * that callback function will be called for each item in @p obj.
21531 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
21534 * Go to a given items level on a index widget
21536 * @param obj The index object
21537 * @param level The index level (one of @c 0 or @c 1)
21541 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21544 * Return the data associated with a given index widget item
21546 * @param it The index widget item handle
21547 * @return The data associated with @p it
21549 * @see elm_index_item_data_set()
21553 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
21556 * Set the data associated with a given index widget item
21558 * @param it The index widget item handle
21559 * @param data The new data pointer to set to @p it
21561 * This sets new item data on @p it.
21563 * @warning The old data pointer won't be touched by this function, so
21564 * the user had better to free that old data himself/herself.
21568 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
21571 * Set the function to be called when a given index widget item is freed.
21573 * @param it The item to set the callback on
21574 * @param func The function to call on the item's deletion
21576 * When called, @p func will have both @c data and @c event_info
21577 * arguments with the @p it item's data value and, naturally, the
21578 * @c obj argument with a handle to the parent index widget.
21582 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
21585 * Get the letter (string) set on a given index widget item.
21587 * @param it The index item handle
21588 * @return The letter string set on @p it
21592 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
21596 EAPI void elm_index_button_image_invisible_set(Evas_Object *obj, Eina_Bool invisible) EINA_ARG_NONNULL(1);
21603 * @defgroup Photocam Photocam
21605 * @image html img/widget/photocam/preview-00.png
21606 * @image latex img/widget/photocam/preview-00.eps
21608 * This is a widget specifically for displaying high-resolution digital
21609 * camera photos giving speedy feedback (fast load), low memory footprint
21610 * and zooming and panning as well as fitting logic. It is entirely focused
21611 * on jpeg images, and takes advantage of properties of the jpeg format (via
21612 * evas loader features in the jpeg loader).
21614 * Signals that you can add callbacks for are:
21615 * @li "clicked" - This is called when a user has clicked the photo without
21617 * @li "press" - This is called when a user has pressed down on the photo.
21618 * @li "longpressed" - This is called when a user has pressed down on the
21619 * photo for a long time without dragging around.
21620 * @li "clicked,double" - This is called when a user has double-clicked the
21622 * @li "load" - Photo load begins.
21623 * @li "loaded" - This is called when the image file load is complete for the
21624 * first view (low resolution blurry version).
21625 * @li "load,detail" - Photo detailed data load begins.
21626 * @li "loaded,detail" - This is called when the image file load is complete
21627 * for the detailed image data (full resolution needed).
21628 * @li "zoom,start" - Zoom animation started.
21629 * @li "zoom,stop" - Zoom animation stopped.
21630 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
21631 * @li "scroll" - the content has been scrolled (moved)
21632 * @li "scroll,anim,start" - scrolling animation has started
21633 * @li "scroll,anim,stop" - scrolling animation has stopped
21634 * @li "scroll,drag,start" - dragging the contents around has started
21635 * @li "scroll,drag,stop" - dragging the contents around has stopped
21637 * @ref tutorial_photocam shows the API in action.
21641 * @brief Types of zoom available.
21643 typedef enum _Elm_Photocam_Zoom_Mode
21645 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
21646 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
21647 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
21648 ELM_PHOTOCAM_ZOOM_MODE_LAST
21649 } Elm_Photocam_Zoom_Mode;
21651 * @brief Add a new Photocam object
21653 * @param parent The parent object
21654 * @return The new object or NULL if it cannot be created
21656 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21658 * @brief Set the photo file to be shown
21660 * @param obj The photocam object
21661 * @param file The photo file
21662 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
21664 * This sets (and shows) the specified file (with a relative or absolute
21665 * path) and will return a load error (same error that
21666 * evas_object_image_load_error_get() will return). The image will change and
21667 * adjust its size at this point and begin a background load process for this
21668 * photo that at some time in the future will be displayed at the full
21671 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
21673 * @brief Returns the path of the current image file
21675 * @param obj The photocam object
21676 * @return Returns the path
21678 * @see elm_photocam_file_set()
21680 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21682 * @brief Set the zoom level of the photo
21684 * @param obj The photocam object
21685 * @param zoom The zoom level to set
21687 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
21688 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
21689 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
21690 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
21693 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
21695 * @brief Get the zoom level of the photo
21697 * @param obj The photocam object
21698 * @return The current zoom level
21700 * This returns the current zoom level of the photocam object. Note that if
21701 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
21702 * (which is the default), the zoom level may be changed at any time by the
21703 * photocam object itself to account for photo size and photocam viewpoer
21706 * @see elm_photocam_zoom_set()
21707 * @see elm_photocam_zoom_mode_set()
21709 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21711 * @brief Set the zoom mode
21713 * @param obj The photocam object
21714 * @param mode The desired mode
21716 * This sets the zoom mode to manual or one of several automatic levels.
21717 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
21718 * elm_photocam_zoom_set() and will stay at that level until changed by code
21719 * or until zoom mode is changed. This is the default mode. The Automatic
21720 * modes will allow the photocam object to automatically adjust zoom mode
21721 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
21722 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
21723 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
21724 * pixels within the frame are left unfilled.
21726 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
21728 * @brief Get the zoom mode
21730 * @param obj The photocam object
21731 * @return The current zoom mode
21733 * This gets the current zoom mode of the photocam object.
21735 * @see elm_photocam_zoom_mode_set()
21737 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21739 * @brief Get the current image pixel width and height
21741 * @param obj The photocam object
21742 * @param w A pointer to the width return
21743 * @param h A pointer to the height return
21745 * This gets the current photo pixel width and height (for the original).
21746 * The size will be returned in the integers @p w and @p h that are pointed
21749 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
21751 * @brief Get the area of the image that is currently shown
21754 * @param x A pointer to the X-coordinate of region
21755 * @param y A pointer to the Y-coordinate of region
21756 * @param w A pointer to the width
21757 * @param h A pointer to the height
21759 * @see elm_photocam_image_region_show()
21760 * @see elm_photocam_image_region_bring_in()
21762 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
21764 * @brief Set the viewed portion of the image
21766 * @param obj The photocam object
21767 * @param x X-coordinate of region in image original pixels
21768 * @param y Y-coordinate of region in image original pixels
21769 * @param w Width of region in image original pixels
21770 * @param h Height of region in image original pixels
21772 * This shows the region of the image without using animation.
21774 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
21776 * @brief Bring in the viewed portion of the image
21778 * @param obj The photocam object
21779 * @param x X-coordinate of region in image original pixels
21780 * @param y Y-coordinate of region in image original pixels
21781 * @param w Width of region in image original pixels
21782 * @param h Height of region in image original pixels
21784 * This shows the region of the image using animation.
21786 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
21788 * @brief Set the paused state for photocam
21790 * @param obj The photocam object
21791 * @param paused The pause state to set
21793 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
21794 * photocam. The default is off. This will stop zooming using animation on
21795 * zoom levels changes and change instantly. This will stop any existing
21796 * animations that are running.
21798 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
21800 * @brief Get the paused state for photocam
21802 * @param obj The photocam object
21803 * @return The current paused state
21805 * This gets the current paused state for the photocam object.
21807 * @see elm_photocam_paused_set()
21809 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21811 * @brief Get the internal low-res image used for photocam
21813 * @param obj The photocam object
21814 * @return The internal image object handle, or NULL if none exists
21816 * This gets the internal image object inside photocam. Do not modify it. It
21817 * is for inspection only, and hooking callbacks to. Nothing else. It may be
21818 * deleted at any time as well.
21820 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21822 * @brief Set the photocam scrolling bouncing.
21824 * @param obj The photocam object
21825 * @param h_bounce bouncing for horizontal
21826 * @param v_bounce bouncing for vertical
21828 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
21830 * @brief Get the photocam scrolling bouncing.
21832 * @param obj The photocam object
21833 * @param h_bounce bouncing for horizontal
21834 * @param v_bounce bouncing for vertical
21836 * @see elm_photocam_bounce_set()
21838 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
21844 * @defgroup Map Map
21845 * @ingroup Elementary
21847 * @image html img/widget/map/preview-00.png
21848 * @image latex img/widget/map/preview-00.eps
21850 * This is a widget specifically for displaying a map. It uses basically
21851 * OpenStreetMap provider http://www.openstreetmap.org/,
21852 * but custom providers can be added.
21854 * It supports some basic but yet nice features:
21855 * @li zoom and scroll
21856 * @li markers with content to be displayed when user clicks over it
21857 * @li group of markers
21860 * Smart callbacks one can listen to:
21862 * - "clicked" - This is called when a user has clicked the map without
21864 * - "press" - This is called when a user has pressed down on the map.
21865 * - "longpressed" - This is called when a user has pressed down on the map
21866 * for a long time without dragging around.
21867 * - "clicked,double" - This is called when a user has double-clicked
21869 * - "load,detail" - Map detailed data load begins.
21870 * - "loaded,detail" - This is called when all currently visible parts of
21871 * the map are loaded.
21872 * - "zoom,start" - Zoom animation started.
21873 * - "zoom,stop" - Zoom animation stopped.
21874 * - "zoom,change" - Zoom changed when using an auto zoom mode.
21875 * - "scroll" - the content has been scrolled (moved).
21876 * - "scroll,anim,start" - scrolling animation has started.
21877 * - "scroll,anim,stop" - scrolling animation has stopped.
21878 * - "scroll,drag,start" - dragging the contents around has started.
21879 * - "scroll,drag,stop" - dragging the contents around has stopped.
21880 * - "downloaded" - This is called when all currently required map images
21882 * - "route,load" - This is called when route request begins.
21883 * - "route,loaded" - This is called when route request ends.
21884 * - "name,load" - This is called when name request begins.
21885 * - "name,loaded- This is called when name request ends.
21887 * Available style for map widget:
21890 * Available style for markers:
21895 * Available style for marker bubble:
21898 * List of examples:
21899 * @li @ref map_example_01
21900 * @li @ref map_example_02
21901 * @li @ref map_example_03
21910 * @enum _Elm_Map_Zoom_Mode
21911 * @typedef Elm_Map_Zoom_Mode
21913 * Set map's zoom behavior. It can be set to manual or automatic.
21915 * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
21917 * Values <b> don't </b> work as bitmask, only one can be choosen.
21919 * @note Valid sizes are 2^zoom, consequently the map may be smaller
21920 * than the scroller view.
21922 * @see elm_map_zoom_mode_set()
21923 * @see elm_map_zoom_mode_get()
21927 typedef enum _Elm_Map_Zoom_Mode
21929 ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
21930 ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
21931 ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
21932 ELM_MAP_ZOOM_MODE_LAST
21933 } Elm_Map_Zoom_Mode;
21936 * @enum _Elm_Map_Route_Sources
21937 * @typedef Elm_Map_Route_Sources
21939 * Set route service to be used. By default used source is
21940 * #ELM_MAP_ROUTE_SOURCE_YOURS.
21942 * @see elm_map_route_source_set()
21943 * @see elm_map_route_source_get()
21947 typedef enum _Elm_Map_Route_Sources
21949 ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
21950 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. */
21951 ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
21952 ELM_MAP_ROUTE_SOURCE_LAST
21953 } Elm_Map_Route_Sources;
21955 typedef enum _Elm_Map_Name_Sources
21957 ELM_MAP_NAME_SOURCE_NOMINATIM,
21958 ELM_MAP_NAME_SOURCE_LAST
21959 } Elm_Map_Name_Sources;
21962 * @enum _Elm_Map_Route_Type
21963 * @typedef Elm_Map_Route_Type
21965 * Set type of transport used on route.
21967 * @see elm_map_route_add()
21971 typedef enum _Elm_Map_Route_Type
21973 ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
21974 ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
21975 ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
21976 ELM_MAP_ROUTE_TYPE_LAST
21977 } Elm_Map_Route_Type;
21980 * @enum _Elm_Map_Route_Method
21981 * @typedef Elm_Map_Route_Method
21983 * Set the routing method, what should be priorized, time or distance.
21985 * @see elm_map_route_add()
21989 typedef enum _Elm_Map_Route_Method
21991 ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
21992 ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
21993 ELM_MAP_ROUTE_METHOD_LAST
21994 } Elm_Map_Route_Method;
21996 typedef enum _Elm_Map_Name_Method
21998 ELM_MAP_NAME_METHOD_SEARCH,
21999 ELM_MAP_NAME_METHOD_REVERSE,
22000 ELM_MAP_NAME_METHOD_LAST
22001 } Elm_Map_Name_Method;
22003 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(). */
22004 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(). */
22005 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(). */
22006 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(). */
22007 typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
22008 typedef struct _Elm_Map_Track Elm_Map_Track;
22010 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. */
22011 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
22012 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
22013 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
22015 typedef char *(*ElmMapModuleSourceFunc) (void);
22016 typedef int (*ElmMapModuleZoomMinFunc) (void);
22017 typedef int (*ElmMapModuleZoomMaxFunc) (void);
22018 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
22019 typedef int (*ElmMapModuleRouteSourceFunc) (void);
22020 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
22021 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
22022 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
22023 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
22026 * Add a new map widget to the given parent Elementary (container) object.
22028 * @param parent The parent object.
22029 * @return a new map widget handle or @c NULL, on errors.
22031 * This function inserts a new map widget on the canvas.
22035 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22038 * Set the zoom level of the map.
22040 * @param obj The map object.
22041 * @param zoom The zoom level to set.
22043 * This sets the zoom level.
22045 * It will respect limits defined by elm_map_source_zoom_min_set() and
22046 * elm_map_source_zoom_max_set().
22048 * By default these values are 0 (world map) and 18 (maximum zoom).
22050 * This function should be used when zoom mode is set to
22051 * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
22052 * with elm_map_zoom_mode_set().
22054 * @see elm_map_zoom_mode_set().
22055 * @see elm_map_zoom_get().
22059 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22062 * Get the zoom level of the map.
22064 * @param obj The map object.
22065 * @return The current zoom level.
22067 * This returns the current zoom level of the map object.
22069 * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
22070 * (which is the default), the zoom level may be changed at any time by the
22071 * map object itself to account for map size and map viewport size.
22073 * @see elm_map_zoom_set() for details.
22077 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22080 * Set the zoom mode used by the map object.
22082 * @param obj The map object.
22083 * @param mode The zoom mode of the map, being it one of
22084 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22085 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22087 * This sets the zoom mode to manual or one of the automatic levels.
22088 * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
22089 * elm_map_zoom_set() and will stay at that level until changed by code
22090 * or until zoom mode is changed. This is the default mode.
22092 * The Automatic modes will allow the map object to automatically
22093 * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
22094 * adjust zoom so the map fits inside the scroll frame with no pixels
22095 * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
22096 * ensure no pixels within the frame are left unfilled. Do not forget that
22097 * the valid sizes are 2^zoom, consequently the map may be smaller than
22098 * the scroller view.
22100 * @see elm_map_zoom_set()
22104 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22107 * Get the zoom mode used by the map object.
22109 * @param obj The map object.
22110 * @return The zoom mode of the map, being it one of
22111 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22112 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22114 * This function returns the current zoom mode used by the map object.
22116 * @see elm_map_zoom_mode_set() for more details.
22120 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22123 * Get the current coordinates of the map.
22125 * @param obj The map object.
22126 * @param lon Pointer where to store longitude.
22127 * @param lat Pointer where to store latitude.
22129 * This gets the current center coordinates of the map object. It can be
22130 * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
22132 * @see elm_map_geo_region_bring_in()
22133 * @see elm_map_geo_region_show()
22137 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
22140 * Animatedly bring in given coordinates to the center of the map.
22142 * @param obj The map object.
22143 * @param lon Longitude to center at.
22144 * @param lat Latitude to center at.
22146 * This causes map to jump to the given @p lat and @p lon coordinates
22147 * and show it (by scrolling) in the center of the viewport, if it is not
22148 * already centered. This will use animation to do so and take a period
22149 * of time to complete.
22151 * @see elm_map_geo_region_show() for a function to avoid animation.
22152 * @see elm_map_geo_region_get()
22156 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22159 * Show the given coordinates at the center of the map, @b immediately.
22161 * @param obj The map object.
22162 * @param lon Longitude to center at.
22163 * @param lat Latitude to center at.
22165 * This causes map to @b redraw its viewport's contents to the
22166 * region contining the given @p lat and @p lon, that will be moved to the
22167 * center of the map.
22169 * @see elm_map_geo_region_bring_in() for a function to move with animation.
22170 * @see elm_map_geo_region_get()
22174 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22177 * Pause or unpause the map.
22179 * @param obj The map object.
22180 * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
22183 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22186 * The default is off.
22188 * This will stop zooming using animation, changing zoom levels will
22189 * change instantly. This will stop any existing animations that are running.
22191 * @see elm_map_paused_get()
22195 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22198 * Get a value whether map is paused or not.
22200 * @param obj The map object.
22201 * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
22202 * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
22204 * This gets the current paused state for the map object.
22206 * @see elm_map_paused_set() for details.
22210 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22213 * Set to show markers during zoom level changes or not.
22215 * @param obj The map object.
22216 * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
22219 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22222 * The default is off.
22224 * This will stop zooming using animation, changing zoom levels will
22225 * change instantly. This will stop any existing animations that are running.
22227 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22230 * The default is off.
22232 * Enabling it will force the map to stop displaying the markers during
22233 * zoom level changes. Set to on if you have a large number of markers.
22235 * @see elm_map_paused_markers_get()
22239 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22242 * Get a value whether markers will be displayed on zoom level changes or not
22244 * @param obj The map object.
22245 * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
22246 * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
22248 * This gets the current markers paused state for the map object.
22250 * @see elm_map_paused_markers_set() for details.
22254 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22257 * Get the information of downloading status.
22259 * @param obj The map object.
22260 * @param try_num Pointer where to store number of tiles being downloaded.
22261 * @param finish_num Pointer where to store number of tiles successfully
22264 * This gets the current downloading status for the map object, the number
22265 * of tiles being downloaded and the number of tiles already downloaded.
22269 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
22272 * Convert a pixel coordinate (x,y) into a geographic coordinate
22273 * (longitude, latitude).
22275 * @param obj The map object.
22276 * @param x the coordinate.
22277 * @param y the coordinate.
22278 * @param size the size in pixels of the map.
22279 * The map is a square and generally his size is : pow(2.0, zoom)*256.
22280 * @param lon Pointer where to store the longitude that correspond to x.
22281 * @param lat Pointer where to store the latitude that correspond to y.
22283 * @note Origin pixel point is the top left corner of the viewport.
22284 * Map zoom and size are taken on account.
22286 * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
22290 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);
22293 * Convert a geographic coordinate (longitude, latitude) into a pixel
22294 * coordinate (x, y).
22296 * @param obj The map object.
22297 * @param lon the longitude.
22298 * @param lat the latitude.
22299 * @param size the size in pixels of the map. The map is a square
22300 * and generally his size is : pow(2.0, zoom)*256.
22301 * @param x Pointer where to store the horizontal pixel coordinate that
22302 * correspond to the longitude.
22303 * @param y Pointer where to store the vertical pixel coordinate that
22304 * correspond to the latitude.
22306 * @note Origin pixel point is the top left corner of the viewport.
22307 * Map zoom and size are taken on account.
22309 * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
22313 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);
22316 * Convert a geographic coordinate (longitude, latitude) into a name
22319 * @param obj The map object.
22320 * @param lon the longitude.
22321 * @param lat the latitude.
22322 * @return name A #Elm_Map_Name handle for this coordinate.
22324 * To get the string for this address, elm_map_name_address_get()
22327 * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
22331 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22334 * Convert a name (address) into a geographic coordinate
22335 * (longitude, latitude).
22337 * @param obj The map object.
22338 * @param name The address.
22339 * @return name A #Elm_Map_Name handle for this address.
22341 * To get the longitude and latitude, elm_map_name_region_get()
22344 * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
22348 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
22351 * Convert a pixel coordinate into a rotated pixel coordinate.
22353 * @param obj The map object.
22354 * @param x horizontal coordinate of the point to rotate.
22355 * @param y vertical coordinate of the point to rotate.
22356 * @param cx rotation's center horizontal position.
22357 * @param cy rotation's center vertical position.
22358 * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
22359 * @param xx Pointer where to store rotated x.
22360 * @param yy Pointer where to store rotated y.
22364 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);
22367 * Add a new marker to the map object.
22369 * @param obj The map object.
22370 * @param lon The longitude of the marker.
22371 * @param lat The latitude of the marker.
22372 * @param clas The class, to use when marker @b isn't grouped to others.
22373 * @param clas_group The class group, to use when marker is grouped to others
22374 * @param data The data passed to the callbacks.
22376 * @return The created marker or @c NULL upon failure.
22378 * A marker will be created and shown in a specific point of the map, defined
22379 * by @p lon and @p lat.
22381 * It will be displayed using style defined by @p class when this marker
22382 * is displayed alone (not grouped). A new class can be created with
22383 * elm_map_marker_class_new().
22385 * If the marker is grouped to other markers, it will be displayed with
22386 * style defined by @p class_group. Markers with the same group are grouped
22387 * if they are close. A new group class can be created with
22388 * elm_map_marker_group_class_new().
22390 * Markers created with this method can be deleted with
22391 * elm_map_marker_remove().
22393 * A marker can have associated content to be displayed by a bubble,
22394 * when a user click over it, as well as an icon. These objects will
22395 * be fetch using class' callback functions.
22397 * @see elm_map_marker_class_new()
22398 * @see elm_map_marker_group_class_new()
22399 * @see elm_map_marker_remove()
22403 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);
22406 * Set the maximum numbers of markers' content to be displayed in a group.
22408 * @param obj The map object.
22409 * @param max The maximum numbers of items displayed in a bubble.
22411 * A bubble will be displayed when the user clicks over the group,
22412 * and will place the content of markers that belong to this group
22415 * A group can have a long list of markers, consequently the creation
22416 * of the content of the bubble can be very slow.
22418 * In order to avoid this, a maximum number of items is displayed
22421 * By default this number is 30.
22423 * Marker with the same group class are grouped if they are close.
22425 * @see elm_map_marker_add()
22429 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
22432 * Remove a marker from the map.
22434 * @param marker The marker to remove.
22436 * @see elm_map_marker_add()
22440 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22443 * Get the current coordinates of the marker.
22445 * @param marker marker.
22446 * @param lat Pointer where to store the marker's latitude.
22447 * @param lon Pointer where to store the marker's longitude.
22449 * These values are set when adding markers, with function
22450 * elm_map_marker_add().
22452 * @see elm_map_marker_add()
22456 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
22459 * Animatedly bring in given marker to the center of the map.
22461 * @param marker The marker to center at.
22463 * This causes map to jump to the given @p marker's coordinates
22464 * and show it (by scrolling) in the center of the viewport, if it is not
22465 * already centered. This will use animation to do so and take a period
22466 * of time to complete.
22468 * @see elm_map_marker_show() for a function to avoid animation.
22469 * @see elm_map_marker_region_get()
22473 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22476 * Show the given marker at the center of the map, @b immediately.
22478 * @param marker The marker to center at.
22480 * This causes map to @b redraw its viewport's contents to the
22481 * region contining the given @p marker's coordinates, that will be
22482 * moved to the center of the map.
22484 * @see elm_map_marker_bring_in() for a function to move with animation.
22485 * @see elm_map_markers_list_show() if more than one marker need to be
22487 * @see elm_map_marker_region_get()
22491 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22494 * Move and zoom the map to display a list of markers.
22496 * @param markers A list of #Elm_Map_Marker handles.
22498 * The map will be centered on the center point of the markers in the list.
22499 * Then the map will be zoomed in order to fit the markers using the maximum
22500 * zoom which allows display of all the markers.
22502 * @warning All the markers should belong to the same map object.
22504 * @see elm_map_marker_show() to show a single marker.
22505 * @see elm_map_marker_bring_in()
22509 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
22512 * Get the Evas object returned by the ElmMapMarkerGetFunc callback
22514 * @param marker The marker wich content should be returned.
22515 * @return Return the evas object if it exists, else @c NULL.
22517 * To set callback function #ElmMapMarkerGetFunc for the marker class,
22518 * elm_map_marker_class_get_cb_set() should be used.
22520 * This content is what will be inside the bubble that will be displayed
22521 * when an user clicks over the marker.
22523 * This returns the actual Evas object used to be placed inside
22524 * the bubble. This may be @c NULL, as it may
22525 * not have been created or may have been deleted, at any time, by
22526 * the map. <b>Do not modify this object</b> (move, resize,
22527 * show, hide, etc.), as the map is controlling it. This
22528 * function is for querying, emitting custom signals or hooking
22529 * lower level callbacks for events on that object. Do not delete
22530 * this object under any circumstances.
22534 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22537 * Update the marker
22539 * @param marker The marker to be updated.
22541 * If a content is set to this marker, it will call function to delete it,
22542 * #ElmMapMarkerDelFunc, and then will fetch the content again with
22543 * #ElmMapMarkerGetFunc.
22545 * These functions are set for the marker class with
22546 * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
22550 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22553 * Close all the bubbles opened by the user.
22555 * @param obj The map object.
22557 * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
22558 * when the user clicks on a marker.
22560 * This functions is set for the marker class with
22561 * elm_map_marker_class_get_cb_set().
22565 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
22568 * Create a new group class.
22570 * @param obj The map object.
22571 * @return Returns the new group class.
22573 * Each marker must be associated to a group class. Markers in the same
22574 * group are grouped if they are close.
22576 * The group class defines the style of the marker when a marker is grouped
22577 * to others markers. When it is alone, another class will be used.
22579 * A group class will need to be provided when creating a marker with
22580 * elm_map_marker_add().
22582 * Some properties and functions can be set by class, as:
22583 * - style, with elm_map_group_class_style_set()
22584 * - data - to be associated to the group class. It can be set using
22585 * elm_map_group_class_data_set().
22586 * - min zoom to display markers, set with
22587 * elm_map_group_class_zoom_displayed_set().
22588 * - max zoom to group markers, set using
22589 * elm_map_group_class_zoom_grouped_set().
22590 * - visibility - set if markers will be visible or not, set with
22591 * elm_map_group_class_hide_set().
22592 * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
22593 * It can be set using elm_map_group_class_icon_cb_set().
22595 * @see elm_map_marker_add()
22596 * @see elm_map_group_class_style_set()
22597 * @see elm_map_group_class_data_set()
22598 * @see elm_map_group_class_zoom_displayed_set()
22599 * @see elm_map_group_class_zoom_grouped_set()
22600 * @see elm_map_group_class_hide_set()
22601 * @see elm_map_group_class_icon_cb_set()
22605 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
22608 * Set the marker's style of a group class.
22610 * @param clas The group class.
22611 * @param style The style to be used by markers.
22613 * Each marker must be associated to a group class, and will use the style
22614 * defined by such class when grouped to other markers.
22616 * The following styles are provided by default theme:
22617 * @li @c radio - blue circle
22618 * @li @c radio2 - green circle
22621 * @see elm_map_group_class_new() for more details.
22622 * @see elm_map_marker_add()
22626 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
22629 * Set the icon callback function of a group class.
22631 * @param clas The group class.
22632 * @param icon_get The callback function that will return the icon.
22634 * Each marker must be associated to a group class, and it can display a
22635 * custom icon. The function @p icon_get must return this icon.
22637 * @see elm_map_group_class_new() for more details.
22638 * @see elm_map_marker_add()
22642 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
22645 * Set the data associated to the group class.
22647 * @param clas The group class.
22648 * @param data The new user data.
22650 * This data will be passed for callback functions, like icon get callback,
22651 * that can be set with elm_map_group_class_icon_cb_set().
22653 * If a data was previously set, the object will lose the pointer for it,
22654 * so if needs to be freed, you must do it yourself.
22656 * @see elm_map_group_class_new() for more details.
22657 * @see elm_map_group_class_icon_cb_set()
22658 * @see elm_map_marker_add()
22662 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
22665 * Set the minimum zoom from where the markers are displayed.
22667 * @param clas The group class.
22668 * @param zoom The minimum zoom.
22670 * Markers only will be displayed when the map is displayed at @p zoom
22673 * @see elm_map_group_class_new() for more details.
22674 * @see elm_map_marker_add()
22678 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
22681 * Set the zoom from where the markers are no more grouped.
22683 * @param clas The group class.
22684 * @param zoom The maximum zoom.
22686 * Markers only will be grouped when the map is displayed at
22687 * less than @p zoom.
22689 * @see elm_map_group_class_new() for more details.
22690 * @see elm_map_marker_add()
22694 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
22697 * Set if the markers associated to the group class @clas are hidden or not.
22699 * @param clas The group class.
22700 * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
22703 * If @p hide is @c EINA_TRUE the markers will be hidden, but default
22708 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
22711 * Create a new marker class.
22713 * @param obj The map object.
22714 * @return Returns the new group class.
22716 * Each marker must be associated to a class.
22718 * The marker class defines the style of the marker when a marker is
22719 * displayed alone, i.e., not grouped to to others markers. When grouped
22720 * it will use group class style.
22722 * A marker class will need to be provided when creating a marker with
22723 * elm_map_marker_add().
22725 * Some properties and functions can be set by class, as:
22726 * - style, with elm_map_marker_class_style_set()
22727 * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
22728 * It can be set using elm_map_marker_class_icon_cb_set().
22729 * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
22730 * Set using elm_map_marker_class_get_cb_set().
22731 * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
22732 * Set using elm_map_marker_class_del_cb_set().
22734 * @see elm_map_marker_add()
22735 * @see elm_map_marker_class_style_set()
22736 * @see elm_map_marker_class_icon_cb_set()
22737 * @see elm_map_marker_class_get_cb_set()
22738 * @see elm_map_marker_class_del_cb_set()
22742 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
22745 * Set the marker's style of a marker class.
22747 * @param clas The marker class.
22748 * @param style The style to be used by markers.
22750 * Each marker must be associated to a marker class, and will use the style
22751 * defined by such class when alone, i.e., @b not grouped to other markers.
22753 * The following styles are provided by default theme:
22758 * @see elm_map_marker_class_new() for more details.
22759 * @see elm_map_marker_add()
22763 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
22766 * Set the icon callback function of a marker class.
22768 * @param clas The marker class.
22769 * @param icon_get The callback function that will return the icon.
22771 * Each marker must be associated to a marker class, and it can display a
22772 * custom icon. The function @p icon_get must return this icon.
22774 * @see elm_map_marker_class_new() for more details.
22775 * @see elm_map_marker_add()
22779 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
22782 * Set the bubble content callback function of a marker class.
22784 * @param clas The marker class.
22785 * @param get The callback function that will return the content.
22787 * Each marker must be associated to a marker class, and it can display a
22788 * a content on a bubble that opens when the user click over the marker.
22789 * The function @p get must return this content object.
22791 * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
22794 * @see elm_map_marker_class_new() for more details.
22795 * @see elm_map_marker_class_del_cb_set()
22796 * @see elm_map_marker_add()
22800 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
22803 * Set the callback function used to delete bubble content of a marker class.
22805 * @param clas The marker class.
22806 * @param del The callback function that will delete the content.
22808 * Each marker must be associated to a marker class, and it can display a
22809 * a content on a bubble that opens when the user click over the marker.
22810 * The function to return such content can be set with
22811 * elm_map_marker_class_get_cb_set().
22813 * If this content must be freed, a callback function need to be
22814 * set for that task with this function.
22816 * If this callback is defined it will have to delete (or not) the
22817 * object inside, but if the callback is not defined the object will be
22818 * destroyed with evas_object_del().
22820 * @see elm_map_marker_class_new() for more details.
22821 * @see elm_map_marker_class_get_cb_set()
22822 * @see elm_map_marker_add()
22826 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
22829 * Get the list of available sources.
22831 * @param obj The map object.
22832 * @return The source names list.
22834 * It will provide a list with all available sources, that can be set as
22835 * current source with elm_map_source_name_set(), or get with
22836 * elm_map_source_name_get().
22838 * Available sources:
22844 * @see elm_map_source_name_set() for more details.
22845 * @see elm_map_source_name_get()
22849 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22852 * Set the source of the map.
22854 * @param obj The map object.
22855 * @param source The source to be used.
22857 * Map widget retrieves images that composes the map from a web service.
22858 * This web service can be set with this method.
22860 * A different service can return a different maps with different
22861 * information and it can use different zoom values.
22863 * The @p source_name need to match one of the names provided by
22864 * elm_map_source_names_get().
22866 * The current source can be get using elm_map_source_name_get().
22868 * @see elm_map_source_names_get()
22869 * @see elm_map_source_name_get()
22874 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
22877 * Get the name of currently used source.
22879 * @param obj The map object.
22880 * @return Returns the name of the source in use.
22882 * @see elm_map_source_name_set() for more details.
22886 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22889 * Set the source of the route service to be used by the map.
22891 * @param obj The map object.
22892 * @param source The route service to be used, being it one of
22893 * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
22894 * and #ELM_MAP_ROUTE_SOURCE_ORS.
22896 * Each one has its own algorithm, so the route retrieved may
22897 * differ depending on the source route. Now, only the default is working.
22899 * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
22900 * http://www.yournavigation.org/.
22902 * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
22903 * assumptions. Its routing core is based on Contraction Hierarchies.
22905 * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
22907 * @see elm_map_route_source_get().
22911 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
22914 * Get the current route source.
22916 * @param obj The map object.
22917 * @return The source of the route service used by the map.
22919 * @see elm_map_route_source_set() for details.
22923 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22926 * Set the minimum zoom of the source.
22928 * @param obj The map object.
22929 * @param zoom New minimum zoom value to be used.
22931 * By default, it's 0.
22935 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22938 * Get the minimum zoom of the source.
22940 * @param obj The map object.
22941 * @return Returns the minimum zoom of the source.
22943 * @see elm_map_source_zoom_min_set() for details.
22947 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22950 * Set the maximum zoom of the source.
22952 * @param obj The map object.
22953 * @param zoom New maximum zoom value to be used.
22955 * By default, it's 18.
22959 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22962 * Get the maximum zoom of the source.
22964 * @param obj The map object.
22965 * @return Returns the maximum zoom of the source.
22967 * @see elm_map_source_zoom_min_set() for details.
22971 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22974 * Set the user agent used by the map object to access routing services.
22976 * @param obj The map object.
22977 * @param user_agent The user agent to be used by the map.
22979 * User agent is a client application implementing a network protocol used
22980 * in communications within a client–server distributed computing system
22982 * The @p user_agent identification string will transmitted in a header
22983 * field @c User-Agent.
22985 * @see elm_map_user_agent_get()
22989 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
22992 * Get the user agent used by the map object.
22994 * @param obj The map object.
22995 * @return The user agent identification string used by the map.
22997 * @see elm_map_user_agent_set() for details.
23001 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23004 * Add a new route to the map object.
23006 * @param obj The map object.
23007 * @param type The type of transport to be considered when tracing a route.
23008 * @param method The routing method, what should be priorized.
23009 * @param flon The start longitude.
23010 * @param flat The start latitude.
23011 * @param tlon The destination longitude.
23012 * @param tlat The destination latitude.
23014 * @return The created route or @c NULL upon failure.
23016 * A route will be traced by point on coordinates (@p flat, @p flon)
23017 * to point on coordinates (@p tlat, @p tlon), using the route service
23018 * set with elm_map_route_source_set().
23020 * It will take @p type on consideration to define the route,
23021 * depending if the user will be walking or driving, the route may vary.
23022 * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
23023 * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
23025 * Another parameter is what the route should priorize, the minor distance
23026 * or the less time to be spend on the route. So @p method should be one
23027 * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
23029 * Routes created with this method can be deleted with
23030 * elm_map_route_remove(), colored with elm_map_route_color_set(),
23031 * and distance can be get with elm_map_route_distance_get().
23033 * @see elm_map_route_remove()
23034 * @see elm_map_route_color_set()
23035 * @see elm_map_route_distance_get()
23036 * @see elm_map_route_source_set()
23040 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);
23043 * Remove a route from the map.
23045 * @param route The route to remove.
23047 * @see elm_map_route_add()
23051 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23054 * Set the route color.
23056 * @param route The route object.
23057 * @param r Red channel value, from 0 to 255.
23058 * @param g Green channel value, from 0 to 255.
23059 * @param b Blue channel value, from 0 to 255.
23060 * @param a Alpha channel value, from 0 to 255.
23062 * It uses an additive color model, so each color channel represents
23063 * how much of each primary colors must to be used. 0 represents
23064 * ausence of this color, so if all of the three are set to 0,
23065 * the color will be black.
23067 * These component values should be integers in the range 0 to 255,
23068 * (single 8-bit byte).
23070 * This sets the color used for the route. By default, it is set to
23071 * solid red (r = 255, g = 0, b = 0, a = 255).
23073 * For alpha channel, 0 represents completely transparent, and 255, opaque.
23075 * @see elm_map_route_color_get()
23079 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
23082 * Get the route color.
23084 * @param route The route object.
23085 * @param r Pointer where to store the red channel value.
23086 * @param g Pointer where to store the green channel value.
23087 * @param b Pointer where to store the blue channel value.
23088 * @param a Pointer where to store the alpha channel value.
23090 * @see elm_map_route_color_set() for details.
23094 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
23097 * Get the route distance in kilometers.
23099 * @param route The route object.
23100 * @return The distance of route (unit : km).
23104 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23107 * Get the information of route nodes.
23109 * @param route The route object.
23110 * @return Returns a string with the nodes of route.
23114 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23117 * Get the information of route waypoint.
23119 * @param route the route object.
23120 * @return Returns a string with information about waypoint of route.
23124 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23127 * Get the address of the name.
23129 * @param name The name handle.
23130 * @return Returns the address string of @p name.
23132 * This gets the coordinates of the @p name, created with one of the
23133 * conversion functions.
23135 * @see elm_map_utils_convert_name_into_coord()
23136 * @see elm_map_utils_convert_coord_into_name()
23140 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23143 * Get the current coordinates of the name.
23145 * @param name The name handle.
23146 * @param lat Pointer where to store the latitude.
23147 * @param lon Pointer where to store The longitude.
23149 * This gets the coordinates of the @p name, created with one of the
23150 * conversion functions.
23152 * @see elm_map_utils_convert_name_into_coord()
23153 * @see elm_map_utils_convert_coord_into_name()
23157 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
23160 * Remove a name from the map.
23162 * @param name The name to remove.
23164 * Basically the struct handled by @p name will be freed, so convertions
23165 * between address and coordinates will be lost.
23167 * @see elm_map_utils_convert_name_into_coord()
23168 * @see elm_map_utils_convert_coord_into_name()
23172 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23177 * @param obj The map object.
23178 * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
23179 * @param cx Rotation's center horizontal position.
23180 * @param cy Rotation's center vertical position.
23182 * @see elm_map_rotate_get()
23186 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
23189 * Get the rotate degree of the map
23191 * @param obj The map object
23192 * @param degree Pointer where to store degrees from 0.0 to 360.0
23193 * to rotate arount Z axis.
23194 * @param cx Pointer where to store rotation's center horizontal position.
23195 * @param cy Pointer where to store rotation's center vertical position.
23197 * @see elm_map_rotate_set() to set map rotation.
23201 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);
23204 * Enable or disable mouse wheel to be used to zoom in / out the map.
23206 * @param obj The map object.
23207 * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
23210 * Mouse wheel can be used for the user to zoom in or zoom out the map.
23212 * It's disabled by default.
23214 * @see elm_map_wheel_disabled_get()
23218 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
23221 * Get a value whether mouse wheel is enabled or not.
23223 * @param obj The map object.
23224 * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
23225 * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23227 * Mouse wheel can be used for the user to zoom in or zoom out the map.
23229 * @see elm_map_wheel_disabled_set() for details.
23233 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23237 * Add a track on the map
23239 * @param obj The map object.
23240 * @param emap The emap route object.
23241 * @return The route object. This is an elm object of type Route.
23243 * @see elm_route_add() for details.
23247 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
23251 * Remove a track from the map
23253 * @param obj The map object.
23254 * @param route The track to remove.
23258 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
23265 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
23267 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
23269 EAPI double elm_route_lon_min_get(Evas_Object *obj);
23270 EAPI double elm_route_lat_min_get(Evas_Object *obj);
23271 EAPI double elm_route_lon_max_get(Evas_Object *obj);
23272 EAPI double elm_route_lat_max_get(Evas_Object *obj);
23275 * @defgroup Panel Panel
23277 * @image html img/widget/panel/preview-00.png
23278 * @image latex img/widget/panel/preview-00.eps
23280 * @brief A panel is a type of animated container that contains subobjects.
23281 * It can be expanded or contracted by clicking the button on it's edge.
23283 * Orientations are as follows:
23284 * @li ELM_PANEL_ORIENT_TOP
23285 * @li ELM_PANEL_ORIENT_LEFT
23286 * @li ELM_PANEL_ORIENT_RIGHT
23288 * To set/get/unset the content of the panel, you can use
23289 * elm_object_content_set/get/unset APIs.
23290 * Once the content object is set, a previously set one will be deleted.
23291 * If you want to keep that old content object, use the
23292 * elm_object_content_unset() function
23294 * @ref tutorial_panel shows one way to use this widget.
23297 typedef enum _Elm_Panel_Orient
23299 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
23300 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
23301 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
23302 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
23303 } Elm_Panel_Orient;
23305 * @brief Adds a panel object
23307 * @param parent The parent object
23309 * @return The panel object, or NULL on failure
23311 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23313 * @brief Sets the orientation of the panel
23315 * @param parent The parent object
23316 * @param orient The panel orientation. Can be one of the following:
23317 * @li ELM_PANEL_ORIENT_TOP
23318 * @li ELM_PANEL_ORIENT_LEFT
23319 * @li ELM_PANEL_ORIENT_RIGHT
23321 * Sets from where the panel will (dis)appear.
23323 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
23325 * @brief Get the orientation of the panel.
23327 * @param obj The panel object
23328 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
23330 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23332 * @brief Set the content of the panel.
23334 * @param obj The panel object
23335 * @param content The panel content
23337 * Once the content object is set, a previously set one will be deleted.
23338 * If you want to keep that old content object, use the
23339 * elm_panel_content_unset() function.
23341 EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23343 * @brief Get the content of the panel.
23345 * @param obj The panel object
23346 * @return The content that is being used
23348 * Return the content object which is set for this widget.
23350 * @see elm_panel_content_set()
23352 EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23354 * @brief Unset the content of the panel.
23356 * @param obj The panel object
23357 * @return The content that was being used
23359 * Unparent and return the content object which was set for this widget.
23361 * @see elm_panel_content_set()
23363 EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23365 * @brief Set the state of the panel.
23367 * @param obj The panel object
23368 * @param hidden If true, the panel will run the animation to contract
23370 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
23372 * @brief Get the state of the panel.
23374 * @param obj The panel object
23375 * @param hidden If true, the panel is in the "hide" state
23377 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23379 * @brief Toggle the hidden state of the panel from code
23381 * @param obj The panel object
23383 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
23389 * @defgroup Panes Panes
23390 * @ingroup Elementary
23392 * @image html img/widget/panes/preview-00.png
23393 * @image latex img/widget/panes/preview-00.eps width=\textwidth
23395 * @image html img/panes.png
23396 * @image latex img/panes.eps width=\textwidth
23398 * The panes adds a dragable bar between two contents. When dragged
23399 * this bar will resize contents size.
23401 * Panes can be displayed vertically or horizontally, and contents
23402 * size proportion can be customized (homogeneous by default).
23404 * Smart callbacks one can listen to:
23405 * - "press" - The panes has been pressed (button wasn't released yet).
23406 * - "unpressed" - The panes was released after being pressed.
23407 * - "clicked" - The panes has been clicked>
23408 * - "clicked,double" - The panes has been double clicked
23410 * Available styles for it:
23413 * Default contents parts of the panes widget that you can use for are:
23414 * @li "elm.swallow.left" - A leftside content of the panes
23415 * @li "elm.swallow.right" - A rightside content of the panes
23417 * If panes is displayed vertically, left content will be displayed at
23420 * Here is an example on its usage:
23421 * @li @ref panes_example
23424 #define ELM_PANES_CONTENT_LEFT "elm.swallow.left"
23425 #define ELM_PANES_CONTENT_RIGHT "elm.swallow.right"
23428 * @addtogroup Panes
23433 * Add a new panes widget to the given parent Elementary
23434 * (container) object.
23436 * @param parent The parent object.
23437 * @return a new panes widget handle or @c NULL, on errors.
23439 * This function inserts a new panes widget on the canvas.
23443 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23446 * Set the left content of the panes widget.
23448 * @param obj The panes object.
23449 * @param content The new left content object.
23451 * Once the content object is set, a previously set one will be deleted.
23452 * If you want to keep that old content object, use the
23453 * elm_panes_content_left_unset() function.
23455 * If panes is displayed vertically, left content will be displayed at
23458 * @see elm_panes_content_left_get()
23459 * @see elm_panes_content_right_set() to set content on the other side.
23463 EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23466 * Set the right content of the panes widget.
23468 * @param obj The panes object.
23469 * @param content The new right content object.
23471 * Once the content object is set, a previously set one will be deleted.
23472 * If you want to keep that old content object, use the
23473 * elm_panes_content_right_unset() function.
23475 * If panes is displayed vertically, left content will be displayed at
23478 * @see elm_panes_content_right_get()
23479 * @see elm_panes_content_left_set() to set content on the other side.
23483 EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23486 * Get the left content of the panes.
23488 * @param obj The panes object.
23489 * @return The left content object that is being used.
23491 * Return the left content object which is set for this widget.
23493 * @see elm_panes_content_left_set() for details.
23497 EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23500 * Get the right content of the panes.
23502 * @param obj The panes object
23503 * @return The right content object that is being used
23505 * Return the right content object which is set for this widget.
23507 * @see elm_panes_content_right_set() for details.
23511 EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23514 * Unset the left content used for the panes.
23516 * @param obj The panes object.
23517 * @return The left content object that was being used.
23519 * Unparent and return the left content object which was set for this widget.
23521 * @see elm_panes_content_left_set() for details.
23522 * @see elm_panes_content_left_get().
23526 EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23529 * Unset the right content used for the panes.
23531 * @param obj The panes object.
23532 * @return The right content object that was being used.
23534 * Unparent and return the right content object which was set for this
23537 * @see elm_panes_content_right_set() for details.
23538 * @see elm_panes_content_right_get().
23542 EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23545 * Get the size proportion of panes widget's left side.
23547 * @param obj The panes object.
23548 * @return float value between 0.0 and 1.0 representing size proportion
23551 * @see elm_panes_content_left_size_set() for more details.
23555 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23558 * Set the size proportion of panes widget's left side.
23560 * @param obj The panes object.
23561 * @param size Value between 0.0 and 1.0 representing size proportion
23564 * By default it's homogeneous, i.e., both sides have the same size.
23566 * If something different is required, it can be set with this function.
23567 * For example, if the left content should be displayed over
23568 * 75% of the panes size, @p size should be passed as @c 0.75.
23569 * This way, right content will be resized to 25% of panes size.
23571 * If displayed vertically, left content is displayed at top, and
23572 * right content at bottom.
23574 * @note This proportion will change when user drags the panes bar.
23576 * @see elm_panes_content_left_size_get()
23580 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
23583 * Set the orientation of a given panes widget.
23585 * @param obj The panes object.
23586 * @param horizontal Use @c EINA_TRUE to make @p obj to be
23587 * @b horizontal, @c EINA_FALSE to make it @b vertical.
23589 * Use this function to change how your panes is to be
23590 * disposed: vertically or horizontally.
23592 * By default it's displayed horizontally.
23594 * @see elm_panes_horizontal_get()
23598 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
23601 * Retrieve the orientation of a given panes widget.
23603 * @param obj The panes object.
23604 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
23605 * @c EINA_FALSE if it's @b vertical (and on errors).
23607 * @see elm_panes_horizontal_set() for more details.
23611 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23612 EAPI void elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
23613 EAPI Eina_Bool elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23620 * @defgroup Flip Flip
23622 * @image html img/widget/flip/preview-00.png
23623 * @image latex img/widget/flip/preview-00.eps
23625 * This widget holds 2 content objects(Evas_Object): one on the front and one
23626 * on the back. It allows you to flip from front to back and vice-versa using
23627 * various animations.
23629 * If either the front or back contents are not set the flip will treat that
23630 * as transparent. So if you wore to set the front content but not the back,
23631 * and then call elm_flip_go() you would see whatever is below the flip.
23633 * For a list of supported animations see elm_flip_go().
23635 * Signals that you can add callbacks for are:
23636 * "animate,begin" - when a flip animation was started
23637 * "animate,done" - when a flip animation is finished
23639 * @ref tutorial_flip show how to use most of the API.
23643 typedef enum _Elm_Flip_Mode
23645 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
23646 ELM_FLIP_ROTATE_X_CENTER_AXIS,
23647 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
23648 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
23649 ELM_FLIP_CUBE_LEFT,
23650 ELM_FLIP_CUBE_RIGHT,
23652 ELM_FLIP_CUBE_DOWN,
23653 ELM_FLIP_PAGE_LEFT,
23654 ELM_FLIP_PAGE_RIGHT,
23658 typedef enum _Elm_Flip_Interaction
23660 ELM_FLIP_INTERACTION_NONE,
23661 ELM_FLIP_INTERACTION_ROTATE,
23662 ELM_FLIP_INTERACTION_CUBE,
23663 ELM_FLIP_INTERACTION_PAGE
23664 } Elm_Flip_Interaction;
23665 typedef enum _Elm_Flip_Direction
23667 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
23668 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
23669 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
23670 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
23671 } Elm_Flip_Direction;
23673 * @brief Add a new flip to the parent
23675 * @param parent The parent object
23676 * @return The new object or NULL if it cannot be created
23678 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23680 * @brief Set the front content of the flip widget.
23682 * @param obj The flip object
23683 * @param content The new front content object
23685 * Once the content object is set, a previously set one will be deleted.
23686 * If you want to keep that old content object, use the
23687 * elm_flip_content_front_unset() function.
23689 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23691 * @brief Set the back content of the flip widget.
23693 * @param obj The flip object
23694 * @param content The new back content object
23696 * Once the content object is set, a previously set one will be deleted.
23697 * If you want to keep that old content object, use the
23698 * elm_flip_content_back_unset() function.
23700 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23702 * @brief Get the front content used for the flip
23704 * @param obj The flip object
23705 * @return The front content object that is being used
23707 * Return the front content object which is set for this widget.
23709 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23711 * @brief Get the back content used for the flip
23713 * @param obj The flip object
23714 * @return The back content object that is being used
23716 * Return the back content object which is set for this widget.
23718 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23720 * @brief Unset the front content used for the flip
23722 * @param obj The flip object
23723 * @return The front content object that was being used
23725 * Unparent and return the front content object which was set for this widget.
23727 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23729 * @brief Unset the back content used for the flip
23731 * @param obj The flip object
23732 * @return The back content object that was being used
23734 * Unparent and return the back content object which was set for this widget.
23736 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23738 * @brief Get flip front visibility state
23740 * @param obj The flip objct
23741 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
23744 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23746 * @brief Set flip perspective
23748 * @param obj The flip object
23749 * @param foc The coordinate to set the focus on
23750 * @param x The X coordinate
23751 * @param y The Y coordinate
23753 * @warning This function currently does nothing.
23755 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
23757 * @brief Runs the flip animation
23759 * @param obj The flip object
23760 * @param mode The mode type
23762 * Flips the front and back contents using the @p mode animation. This
23763 * efectively hides the currently visible content and shows the hidden one.
23765 * There a number of possible animations to use for the flipping:
23766 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
23767 * around a horizontal axis in the middle of its height, the other content
23768 * is shown as the other side of the flip.
23769 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
23770 * around a vertical axis in the middle of its width, the other content is
23771 * shown as the other side of the flip.
23772 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
23773 * around a diagonal axis in the middle of its width, the other content is
23774 * shown as the other side of the flip.
23775 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
23776 * around a diagonal axis in the middle of its height, the other content is
23777 * shown as the other side of the flip.
23778 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
23779 * as if the flip was a cube, the other content is show as the right face of
23781 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
23782 * right as if the flip was a cube, the other content is show as the left
23783 * face of the cube.
23784 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
23785 * flip was a cube, the other content is show as the bottom face of the cube.
23786 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
23787 * the flip was a cube, the other content is show as the upper face of the
23789 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
23790 * if the flip was a book, the other content is shown as the page below that.
23791 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
23792 * as if the flip was a book, the other content is shown as the page below
23794 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
23795 * flip was a book, the other content is shown as the page below that.
23796 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
23797 * flip was a book, the other content is shown as the page below that.
23799 * @image html elm_flip.png
23800 * @image latex elm_flip.eps width=\textwidth
23802 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
23804 * @brief Set the interactive flip mode
23806 * @param obj The flip object
23807 * @param mode The interactive flip mode to use
23809 * This sets if the flip should be interactive (allow user to click and
23810 * drag a side of the flip to reveal the back page and cause it to flip).
23811 * By default a flip is not interactive. You may also need to set which
23812 * sides of the flip are "active" for flipping and how much space they use
23813 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
23814 * and elm_flip_interacton_direction_hitsize_set()
23816 * The four avilable mode of interaction are:
23817 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
23818 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
23819 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
23820 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
23822 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
23823 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
23824 * happen, those can only be acheived with elm_flip_go();
23826 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
23828 * @brief Get the interactive flip mode
23830 * @param obj The flip object
23831 * @return The interactive flip mode
23833 * Returns the interactive flip mode set by elm_flip_interaction_set()
23835 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
23837 * @brief Set which directions of the flip respond to interactive flip
23839 * @param obj The flip object
23840 * @param dir The direction to change
23841 * @param enabled If that direction is enabled or not
23843 * By default all directions are disabled, so you may want to enable the
23844 * desired directions for flipping if you need interactive flipping. You must
23845 * call this function once for each direction that should be enabled.
23847 * @see elm_flip_interaction_set()
23849 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
23851 * @brief Get the enabled state of that flip direction
23853 * @param obj The flip object
23854 * @param dir The direction to check
23855 * @return If that direction is enabled or not
23857 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
23859 * @see elm_flip_interaction_set()
23861 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
23863 * @brief Set the amount of the flip that is sensitive to interactive flip
23865 * @param obj The flip object
23866 * @param dir The direction to modify
23867 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
23869 * Set the amount of the flip that is sensitive to interactive flip, with 0
23870 * representing no area in the flip and 1 representing the entire flip. There
23871 * is however a consideration to be made in that the area will never be
23872 * smaller than the finger size set(as set in your Elementary configuration).
23874 * @see elm_flip_interaction_set()
23876 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
23878 * @brief Get the amount of the flip that is sensitive to interactive flip
23880 * @param obj The flip object
23881 * @param dir The direction to check
23882 * @return The size set for that direction
23884 * Returns the amount os sensitive area set by
23885 * elm_flip_interacton_direction_hitsize_set().
23887 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
23892 /* scrolledentry */
23893 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23894 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
23895 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23896 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
23897 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23898 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
23899 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23900 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
23901 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23902 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23903 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
23904 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
23905 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
23906 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23907 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
23908 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
23909 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
23910 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
23911 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
23912 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
23913 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
23914 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
23915 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
23916 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
23917 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
23918 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
23919 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23920 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23921 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23922 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23923 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23924 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
23925 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
23926 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
23927 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
23928 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);
23929 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
23930 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23931 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);
23932 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
23933 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);
23934 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
23935 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23936 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23937 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
23938 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
23939 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23940 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23941 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
23942 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);
23943 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);
23944 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);
23945 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);
23946 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);
23947 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);
23948 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
23949 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
23950 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
23951 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
23952 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23953 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
23954 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
23955 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
23956 EINA_DEPRECATED EAPI void elm_scrolled_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled);
23957 EINA_DEPRECATED EAPI void elm_scrolled_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout);
23958 EINA_DEPRECATED EAPI Ecore_IMF_Context *elm_scrolled_entry_imf_context_get(Evas_Object *obj);
23959 EINA_DEPRECATED EAPI void elm_scrolled_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
23960 EINA_DEPRECATED EAPI void elm_scrolled_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
23963 * @defgroup Conformant Conformant
23964 * @ingroup Elementary
23966 * @image html img/widget/conformant/preview-00.png
23967 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
23969 * @image html img/conformant.png
23970 * @image latex img/conformant.eps width=\textwidth
23972 * The aim is to provide a widget that can be used in elementary apps to
23973 * account for space taken up by the indicator, virtual keypad & softkey
23974 * windows when running the illume2 module of E17.
23976 * So conformant content will be sized and positioned considering the
23977 * space required for such stuff, and when they popup, as a keyboard
23978 * shows when an entry is selected, conformant content won't change.
23980 * Available styles for it:
23983 * Default contents parts of the conformant widget that you can use for are:
23984 * @li "elm.swallow.content" - A content of the conformant
23986 * See how to use this widget in this example:
23987 * @ref conformant_example
23991 * @addtogroup Conformant
23996 * Add a new conformant widget to the given parent Elementary
23997 * (container) object.
23999 * @param parent The parent object.
24000 * @return A new conformant widget handle or @c NULL, on errors.
24002 * This function inserts a new conformant widget on the canvas.
24004 * @ingroup Conformant
24006 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24009 * Set the content of the conformant widget.
24011 * @param obj The conformant object.
24012 * @param content The content to be displayed by the conformant.
24014 * Content will be sized and positioned considering the space required
24015 * to display a virtual keyboard. So it won't fill all the conformant
24016 * size. This way is possible to be sure that content won't resize
24017 * or be re-positioned after the keyboard is displayed.
24019 * Once the content object is set, a previously set one will be deleted.
24020 * If you want to keep that old content object, use the
24021 * elm_object_content_unset() function.
24023 * @see elm_object_content_unset()
24024 * @see elm_object_content_get()
24026 * @ingroup Conformant
24028 EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24031 * Get the content of the conformant widget.
24033 * @param obj The conformant object.
24034 * @return The content that is being used.
24036 * Return the content object which is set for this widget.
24037 * It won't be unparent from conformant. For that, use
24038 * elm_object_content_unset().
24040 * @see elm_object_content_set().
24041 * @see elm_object_content_unset()
24043 * @ingroup Conformant
24045 EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24048 * Unset the content of the conformant widget.
24050 * @param obj The conformant object.
24051 * @return The content that was being used.
24053 * Unparent and return the content object which was set for this widget.
24055 * @see elm_object_content_set().
24057 * @ingroup Conformant
24059 EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24062 * Returns the Evas_Object that represents the content area.
24064 * @param obj The conformant object.
24065 * @return The content area of the widget.
24067 * @ingroup Conformant
24069 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24076 * @defgroup Mapbuf Mapbuf
24077 * @ingroup Elementary
24079 * @image html img/widget/mapbuf/preview-00.png
24080 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
24082 * This holds one content object and uses an Evas Map of transformation
24083 * points to be later used with this content. So the content will be
24084 * moved, resized, etc as a single image. So it will improve performance
24085 * when you have a complex interafce, with a lot of elements, and will
24086 * need to resize or move it frequently (the content object and its
24089 * To set/get/unset the content of the mapbuf, you can use
24090 * elm_object_content_set/get/unset APIs.
24091 * Once the content object is set, a previously set one will be deleted.
24092 * If you want to keep that old content object, use the
24093 * elm_object_content_unset() function.
24095 * To enable map, elm_mapbuf_enabled_set() should be used.
24097 * See how to use this widget in this example:
24098 * @ref mapbuf_example
24102 * @addtogroup Mapbuf
24107 * Add a new mapbuf widget to the given parent Elementary
24108 * (container) object.
24110 * @param parent The parent object.
24111 * @return A new mapbuf widget handle or @c NULL, on errors.
24113 * This function inserts a new mapbuf widget on the canvas.
24117 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24120 * Set the content of the mapbuf.
24122 * @param obj The mapbuf object.
24123 * @param content The content that will be filled in this mapbuf object.
24125 * Once the content object is set, a previously set one will be deleted.
24126 * If you want to keep that old content object, use the
24127 * elm_mapbuf_content_unset() function.
24129 * To enable map, elm_mapbuf_enabled_set() should be used.
24133 EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24136 * Get the content of the mapbuf.
24138 * @param obj The mapbuf object.
24139 * @return The content that is being used.
24141 * Return the content object which is set for this widget.
24143 * @see elm_mapbuf_content_set() for details.
24147 EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24150 * Unset the content of the mapbuf.
24152 * @param obj The mapbuf object.
24153 * @return The content that was being used.
24155 * Unparent and return the content object which was set for this widget.
24157 * @see elm_mapbuf_content_set() for details.
24161 EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24164 * Enable or disable the map.
24166 * @param obj The mapbuf object.
24167 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
24169 * This enables the map that is set or disables it. On enable, the object
24170 * geometry will be saved, and the new geometry will change (position and
24171 * size) to reflect the map geometry set.
24173 * Also, when enabled, alpha and smooth states will be used, so if the
24174 * content isn't solid, alpha should be enabled, for example, otherwise
24175 * a black retangle will fill the content.
24177 * When disabled, the stored map will be freed and geometry prior to
24178 * enabling the map will be restored.
24180 * It's disabled by default.
24182 * @see elm_mapbuf_alpha_set()
24183 * @see elm_mapbuf_smooth_set()
24187 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
24190 * Get a value whether map is enabled or not.
24192 * @param obj The mapbuf object.
24193 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
24194 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24196 * @see elm_mapbuf_enabled_set() for details.
24200 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24203 * Enable or disable smooth map rendering.
24205 * @param obj The mapbuf object.
24206 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
24209 * This sets smoothing for map rendering. If the object is a type that has
24210 * its own smoothing settings, then both the smooth settings for this object
24211 * and the map must be turned off.
24213 * By default smooth maps are enabled.
24217 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
24220 * Get a value whether smooth map rendering is enabled or not.
24222 * @param obj The mapbuf object.
24223 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
24224 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24226 * @see elm_mapbuf_smooth_set() for details.
24230 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24233 * Set or unset alpha flag for map rendering.
24235 * @param obj The mapbuf object.
24236 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
24239 * This sets alpha flag for map rendering. If the object is a type that has
24240 * its own alpha settings, then this will take precedence. Only image objects
24241 * have this currently. It stops alpha blending of the map area, and is
24242 * useful if you know the object and/or all sub-objects is 100% solid.
24244 * Alpha is enabled by default.
24248 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
24251 * Get a value whether alpha blending is enabled or not.
24253 * @param obj The mapbuf object.
24254 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
24255 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24257 * @see elm_mapbuf_alpha_set() for details.
24261 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24268 * @defgroup Flipselector Flip Selector
24270 * A flip selector is a widget to show a set of @b text items, one
24271 * at a time, with the same sheet switching style as the @ref Clock
24272 * "clock" widget, when one changes the current displaying sheet
24273 * (thus, the "flip" in the name).
24275 * User clicks to flip sheets which are @b held for some time will
24276 * make the flip selector to flip continuosly and automatically for
24277 * the user. The interval between flips will keep growing in time,
24278 * so that it helps the user to reach an item which is distant from
24279 * the current selection.
24281 * Smart callbacks one can register to:
24282 * - @c "selected" - when the widget's selected text item is changed
24283 * - @c "overflowed" - when the widget's current selection is changed
24284 * from the first item in its list to the last
24285 * - @c "underflowed" - when the widget's current selection is changed
24286 * from the last item in its list to the first
24288 * Available styles for it:
24291 * Here is an example on its usage:
24292 * @li @ref flipselector_example
24296 * @addtogroup Flipselector
24300 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
24303 * Add a new flip selector widget to the given parent Elementary
24304 * (container) widget
24306 * @param parent The parent object
24307 * @return a new flip selector widget handle or @c NULL, on errors
24309 * This function inserts a new flip selector widget on the canvas.
24311 * @ingroup Flipselector
24313 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24316 * Programmatically select the next item of a flip selector widget
24318 * @param obj The flipselector object
24320 * @note The selection will be animated. Also, if it reaches the
24321 * end of its list of member items, it will continue with the first
24324 * @ingroup Flipselector
24326 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24329 * Programmatically select the previous item of a flip selector
24332 * @param obj The flipselector object
24334 * @note The selection will be animated. Also, if it reaches the
24335 * beginning of its list of member items, it will continue with the
24336 * last one backwards.
24338 * @ingroup Flipselector
24340 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24343 * Append a (text) item to a flip selector widget
24345 * @param obj The flipselector object
24346 * @param label The (text) label of the new item
24347 * @param func Convenience callback function to take place when
24349 * @param data Data passed to @p func, above
24350 * @return A handle to the item added or @c NULL, on errors
24352 * The widget's list of labels to show will be appended with the
24353 * given value. If the user wishes so, a callback function pointer
24354 * can be passed, which will get called when this same item is
24357 * @note The current selection @b won't be modified by appending an
24358 * element to the list.
24360 * @note The maximum length of the text label is going to be
24361 * determined <b>by the widget's theme</b>. Strings larger than
24362 * that value are going to be @b truncated.
24364 * @ingroup Flipselector
24366 EAPI Elm_Flipselector_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24369 * Prepend a (text) item to a flip selector widget
24371 * @param obj The flipselector object
24372 * @param label The (text) label of the new item
24373 * @param func Convenience callback function to take place when
24375 * @param data Data passed to @p func, above
24376 * @return A handle to the item added or @c NULL, on errors
24378 * The widget's list of labels to show will be prepended with the
24379 * given value. If the user wishes so, a callback function pointer
24380 * can be passed, which will get called when this same item is
24383 * @note The current selection @b won't be modified by prepending
24384 * an element to the list.
24386 * @note The maximum length of the text label is going to be
24387 * determined <b>by the widget's theme</b>. Strings larger than
24388 * that value are going to be @b truncated.
24390 * @ingroup Flipselector
24392 EAPI Elm_Flipselector_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24395 * Get the internal list of items in a given flip selector widget.
24397 * @param obj The flipselector object
24398 * @return The list of items (#Elm_Flipselector_Item as data) or @c
24401 * This list is @b not to be modified in any way and must not be
24402 * freed. Use the list members with functions like
24403 * elm_flipselector_item_label_set(),
24404 * elm_flipselector_item_label_get(), elm_flipselector_item_del(),
24405 * elm_flipselector_item_del(),
24406 * elm_flipselector_item_selected_get(),
24407 * elm_flipselector_item_selected_set().
24409 * @warning This list is only valid until @p obj object's internal
24410 * items list is changed. It should be fetched again with another
24411 * call to this function when changes happen.
24413 * @ingroup Flipselector
24415 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24418 * Get the first item in the given flip selector widget's list of
24421 * @param obj The flipselector object
24422 * @return The first item or @c NULL, if it has no items (and on
24425 * @see elm_flipselector_item_append()
24426 * @see elm_flipselector_last_item_get()
24428 * @ingroup Flipselector
24430 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24433 * Get the last item in the given flip selector widget's list of
24436 * @param obj The flipselector object
24437 * @return The last item or @c NULL, if it has no items (and on
24440 * @see elm_flipselector_item_prepend()
24441 * @see elm_flipselector_first_item_get()
24443 * @ingroup Flipselector
24445 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24448 * Get the currently selected item in a flip selector widget.
24450 * @param obj The flipselector object
24451 * @return The selected item or @c NULL, if the widget has no items
24454 * @ingroup Flipselector
24456 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24459 * Set whether a given flip selector widget's item should be the
24460 * currently selected one.
24462 * @param item The flip selector item
24463 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
24465 * This sets whether @p item is or not the selected (thus, under
24466 * display) one. If @p item is different than one under display,
24467 * the latter will be unselected. If the @p item is set to be
24468 * unselected, on the other hand, the @b first item in the widget's
24469 * internal members list will be the new selected one.
24471 * @see elm_flipselector_item_selected_get()
24473 * @ingroup Flipselector
24475 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
24478 * Get whether a given flip selector widget's item is the currently
24481 * @param item The flip selector item
24482 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
24485 * @see elm_flipselector_item_selected_set()
24487 * @ingroup Flipselector
24489 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24492 * Delete a given item from a flip selector widget.
24494 * @param item The item to delete
24496 * @ingroup Flipselector
24498 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24501 * Get the label of a given flip selector widget's item.
24503 * @param item The item to get label from
24504 * @return The text label of @p item or @c NULL, on errors
24506 * @see elm_flipselector_item_label_set()
24508 * @ingroup Flipselector
24510 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24513 * Set the label of a given flip selector widget's item.
24515 * @param item The item to set label on
24516 * @param label The text label string, in UTF-8 encoding
24518 * @see elm_flipselector_item_label_get()
24520 * @ingroup Flipselector
24522 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
24525 * Gets the item before @p item in a flip selector widget's
24526 * internal list of items.
24528 * @param item The item to fetch previous from
24529 * @return The item before the @p item, in its parent's list. If
24530 * there is no previous item for @p item or there's an
24531 * error, @c NULL is returned.
24533 * @see elm_flipselector_item_next_get()
24535 * @ingroup Flipselector
24537 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24540 * Gets the item after @p item in a flip selector widget's
24541 * internal list of items.
24543 * @param item The item to fetch next from
24544 * @return The item after the @p item, in its parent's list. If
24545 * there is no next item for @p item or there's an
24546 * error, @c NULL is returned.
24548 * @see elm_flipselector_item_next_get()
24550 * @ingroup Flipselector
24552 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24555 * Set the interval on time updates for an user mouse button hold
24556 * on a flip selector widget.
24558 * @param obj The flip selector object
24559 * @param interval The (first) interval value in seconds
24561 * This interval value is @b decreased while the user holds the
24562 * mouse pointer either flipping up or flipping doww a given flip
24565 * This helps the user to get to a given item distant from the
24566 * current one easier/faster, as it will start to flip quicker and
24567 * quicker on mouse button holds.
24569 * The calculation for the next flip interval value, starting from
24570 * the one set with this call, is the previous interval divided by
24571 * 1.05, so it decreases a little bit.
24573 * The default starting interval value for automatic flips is
24576 * @see elm_flipselector_interval_get()
24578 * @ingroup Flipselector
24580 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
24583 * Get the interval on time updates for an user mouse button hold
24584 * on a flip selector widget.
24586 * @param obj The flip selector object
24587 * @return The (first) interval value, in seconds, set on it
24589 * @see elm_flipselector_interval_set() for more details
24591 * @ingroup Flipselector
24593 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24600 * @addtogroup Animator Animator
24601 * @ingroup Elementary
24603 * @brief Functions to ease creation of animations.
24605 * elm_animator is designed to provide an easy way to create animations.
24606 * Creating an animation with elm_animator is as simple as setting a
24607 * duration, an operating callback and telling it to run the animation.
24608 * However that is not the full extent of elm_animator's ability, animations
24609 * can be paused and resumed, reversed and the animation need not be linear.
24611 * To run an animation you must specify at least a duration and operation
24612 * callback, not setting any other properties will create a linear animation
24613 * that runs once and is not reversed.
24615 * @ref elm_animator_example_page_01 "This" example should make all of that
24618 * @warning elm_animator is @b not a widget.
24622 * @brief Type of curve desired for animation.
24624 * The speed in which an animation happens doesn't have to be linear, some
24625 * animations will look better if they're accelerating or decelerating, so
24626 * elm_animator provides four options in this regard:
24627 * @image html elm_animator_curve_style.png
24628 * @image latex elm_animator_curve_style.eps width=\textwidth
24629 * As can be seen in the image the speed of the animation will be:
24630 * @li ELM_ANIMATOR_CURVE_LINEAR constant
24631 * @li ELM_ANIMATOR_CURVE_IN_OUT start slow, speed up and then slow down
24632 * @li ELM_ANIMATOR_CURVE_IN start slow and then speed up
24633 * @li ELM_ANIMATOR_CURVE_OUT start fast and then slow down
24637 ELM_ANIMATOR_CURVE_LINEAR,
24638 ELM_ANIMATOR_CURVE_IN_OUT,
24639 ELM_ANIMATOR_CURVE_IN,
24640 ELM_ANIMATOR_CURVE_OUT
24641 } Elm_Animator_Curve_Style;
24642 typedef struct _Elm_Animator Elm_Animator;
24644 * Called back per loop of an elementary animators cycle
24645 * @param data user-data given to elm_animator_operation_callback_set()
24646 * @param animator the animator being run
24647 * @param double the position in the animation
24649 typedef void (*Elm_Animator_Operation_Cb) (void *data, Elm_Animator *animator, double frame);
24651 * Called back when an elementary animator finishes
24652 * @param data user-data given to elm_animator_completion_callback_set()
24654 typedef void (*Elm_Animator_Completion_Cb) (void *data);
24657 * @brief Create a new animator.
24659 * @param[in] parent Parent object
24661 * The @a parent argument can be set to NULL for no parent. If a parent is set
24662 * there is no need to call elm_animator_del(), when the parent is deleted it
24663 * will delete the animator.
24664 * @deprecated Use @ref Transit instead.
24667 EINA_DEPRECATED EAPI Elm_Animator* elm_animator_add(Evas_Object *parent);
24669 * Deletes the animator freeing any resources it used. If the animator was
24670 * created with a NULL parent this must be called, otherwise it will be
24671 * automatically called when the parent is deleted.
24673 * @param[in] animator Animator object
24674 * @deprecated Use @ref Transit instead.
24676 EINA_DEPRECATED EAPI void elm_animator_del(Elm_Animator *animator) EINA_ARG_NONNULL(1);
24678 * Set the duration of the animation.
24680 * @param[in] animator Animator object
24681 * @param[in] duration Duration in second
24682 * @deprecated Use @ref Transit instead.
24684 EINA_DEPRECATED EAPI void elm_animator_duration_set(Elm_Animator *animator, double duration) EINA_ARG_NONNULL(1);
24686 * @brief Set the callback function for animator operation.
24688 * @param[in] animator Animator object
24689 * @param[in] func @ref Elm_Animator_Operation_Cb "Callback" function pointer
24690 * @param[in] data Callback function user argument
24692 * The @p func callback will be called with a frame value in range [0, 1] which
24693 * indicates how far along the animation should be. It is the job of @p func to
24694 * actually change the state of any object(or objects) that are being animated.
24695 * @deprecated Use @ref Transit instead.
24697 EINA_DEPRECATED EAPI void elm_animator_operation_callback_set(Elm_Animator *animator, Elm_Animator_Operation_Cb func, void *data) EINA_ARG_NONNULL(1);
24699 * Set the callback function for the when the animation ends.
24701 * @param[in] animator Animator object
24702 * @param[in] func Callback function pointe
24703 * @param[in] data Callback function user argument
24705 * @warning @a func will not be executed if elm_animator_stop() is called.
24706 * @deprecated Use @ref Transit instead.
24708 EINA_DEPRECATED EAPI void elm_animator_completion_callback_set(Elm_Animator *animator, Elm_Animator_Completion_Cb func, void *data) EINA_ARG_NONNULL(1);
24710 * @brief Stop animator.
24712 * @param[in] animator Animator object
24714 * If called before elm_animator_animate() it does nothing. If there is an
24715 * animation in progress the animation will be stopped(the operation callback
24716 * will not be executed again) and it can't be restarted using
24717 * elm_animator_resume().
24718 * @deprecated Use @ref Transit instead.
24720 EINA_DEPRECATED EAPI void elm_animator_stop(Elm_Animator *animator) EINA_ARG_NONNULL(1);
24722 * Set the animator repeat count.
24724 * @param[in] animator Animator object
24725 * @param[in] repeat_cnt Repeat count
24726 * @deprecated Use @ref Transit instead.
24728 EINA_DEPRECATED EAPI void elm_animator_repeat_set(Elm_Animator *animator, unsigned int repeat_cnt) EINA_ARG_NONNULL(1);
24730 * @brief Start animation.
24732 * @param[in] animator Animator object
24734 * This function starts the animation if the nescessary properties(duration
24735 * and operation callback) have been set. Once started the animation will
24736 * run until complete or elm_animator_stop() is called.
24737 * @deprecated Use @ref Transit instead.
24739 EINA_DEPRECATED EAPI void elm_animator_animate(Elm_Animator *animator) EINA_ARG_NONNULL(1);
24741 * Sets the animation @ref Elm_Animator_Curve_Style "acceleration style".
24743 * @param[in] animator Animator object
24744 * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
24745 * @deprecated Use @ref Transit instead.
24747 EINA_DEPRECATED EAPI void elm_animator_curve_style_set(Elm_Animator *animator, Elm_Animator_Curve_Style cs) EINA_ARG_NONNULL(1);
24749 * Gets the animation @ref Elm_Animator_Curve_Style "acceleration style".
24751 * @param[in] animator Animator object
24752 * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
24753 * @deprecated Use @ref Transit instead.
24755 EINA_DEPRECATED EAPI Elm_Animator_Curve_Style elm_animator_curve_style_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
24757 * @brief Sets wether the animation should be automatically reversed.
24759 * @param[in] animator Animator object
24760 * @param[in] reverse Reverse or not
24762 * This controls wether the animation will be run on reverse imediately after
24763 * running forward. When this is set together with repetition the animation
24764 * will run in reverse once for each time it ran forward.@n
24765 * Runnin an animation in reverse is accomplished by calling the operation
24766 * callback with a frame value starting at 1 and diminshing until 0.
24767 * @deprecated Use @ref Transit instead.
24769 EINA_DEPRECATED EAPI void elm_animator_auto_reverse_set(Elm_Animator *animator, Eina_Bool reverse) EINA_ARG_NONNULL(1);
24771 * Gets wether the animation will automatically reversed
24773 * @param[in] animator Animator object
24774 * @deprecated Use @ref Transit instead.
24776 EINA_DEPRECATED EAPI Eina_Bool elm_animator_auto_reverse_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
24778 * Gets the status for the animator operation. The status of the animator @b
24779 * doesn't take in to account elm_animator_pause() or elm_animator_resume(), it
24780 * only informs if the animation was started and has not ended(either normally
24781 * or through elm_animator_stop()).
24783 * @param[in] animator Animator object
24784 * @deprecated Use @ref Transit instead.
24786 EINA_DEPRECATED EAPI Eina_Bool elm_animator_operating_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
24788 * Gets how many times the animation will be repeated
24790 * @param[in] animator Animator object
24791 * @deprecated Use @ref Transit instead.
24793 EINA_DEPRECATED EAPI unsigned int elm_animator_repeat_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
24795 * Pause the animator.
24797 * @param[in] animator Animator object
24799 * This causes the animation to be temporarily stopped(the operation callback
24800 * will not be called). If the animation is not yet running this is a no-op.
24801 * Once an animation has been paused with this function it can be resumed
24802 * using elm_animator_resume().
24803 * @deprecated Use @ref Transit instead.
24805 EINA_DEPRECATED EAPI void elm_animator_pause(Elm_Animator *animator) EINA_ARG_NONNULL(1);
24807 * @brief Resumes the animator.
24809 * @param[in] animator Animator object
24811 * Resumes an animation that was paused using elm_animator_pause(), after
24812 * calling this function calls to the operation callback will happen
24813 * normally. If an animation is stopped by means of elm_animator_stop it
24814 * @b can't be restarted with this function.@n
24816 * @warning When an animation is resumed it doesn't start from where it was paused, it
24817 * will go to where it would have been if it had not been paused. If an
24818 * animation with a duration of 3 seconds is paused after 1 second for 1 second
24819 * it will resume as if it had ben animating for 2 seconds, the operating
24820 * callback will be called with a frame value of aproximately 2/3.
24821 * @deprecated Use @ref Transit instead.
24823 EINA_DEPRECATED EAPI void elm_animator_resume(Elm_Animator *animator) EINA_ARG_NONNULL(1);
24829 * @addtogroup Calendar
24834 * @enum _Elm_Calendar_Mark_Repeat
24835 * @typedef Elm_Calendar_Mark_Repeat
24837 * Event periodicity, used to define if a mark should be repeated
24838 * @b beyond event's day. It's set when a mark is added.
24840 * So, for a mark added to 13th May with periodicity set to WEEKLY,
24841 * there will be marks every week after this date. Marks will be displayed
24842 * at 13th, 20th, 27th, 3rd June ...
24844 * Values don't work as bitmask, only one can be choosen.
24846 * @see elm_calendar_mark_add()
24848 * @ingroup Calendar
24850 typedef enum _Elm_Calendar_Mark_Repeat
24852 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
24853 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
24854 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
24855 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*/
24856 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. */
24857 } Elm_Calendar_Mark_Repeat;
24859 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(). */
24862 * Add a new calendar widget to the given parent Elementary
24863 * (container) object.
24865 * @param parent The parent object.
24866 * @return a new calendar widget handle or @c NULL, on errors.
24868 * This function inserts a new calendar widget on the canvas.
24870 * @ref calendar_example_01
24872 * @ingroup Calendar
24874 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24877 * Get weekdays names displayed by the calendar.
24879 * @param obj The calendar object.
24880 * @return Array of seven strings to be used as weekday names.
24882 * By default, weekdays abbreviations get from system are displayed:
24883 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
24884 * The first string is related to Sunday, the second to Monday...
24886 * @see elm_calendar_weekdays_name_set()
24888 * @ref calendar_example_05
24890 * @ingroup Calendar
24892 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24895 * Set weekdays names to be displayed by the calendar.
24897 * @param obj The calendar object.
24898 * @param weekdays Array of seven strings to be used as weekday names.
24899 * @warning It must have 7 elements, or it will access invalid memory.
24900 * @warning The strings must be NULL terminated ('@\0').
24902 * By default, weekdays abbreviations get from system are displayed:
24903 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
24905 * The first string should be related to Sunday, the second to Monday...
24907 * The usage should be like this:
24909 * const char *weekdays[] =
24911 * "Sunday", "Monday", "Tuesday", "Wednesday",
24912 * "Thursday", "Friday", "Saturday"
24914 * elm_calendar_weekdays_names_set(calendar, weekdays);
24917 * @see elm_calendar_weekdays_name_get()
24919 * @ref calendar_example_02
24921 * @ingroup Calendar
24923 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
24926 * Set the minimum and maximum values for the year
24928 * @param obj The calendar object
24929 * @param min The minimum year, greater than 1901;
24930 * @param max The maximum year;
24932 * Maximum must be greater than minimum, except if you don't wan't to set
24934 * Default values are 1902 and -1.
24936 * If the maximum year is a negative value, it will be limited depending
24937 * on the platform architecture (year 2037 for 32 bits);
24939 * @see elm_calendar_min_max_year_get()
24941 * @ref calendar_example_03
24943 * @ingroup Calendar
24945 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
24948 * Get the minimum and maximum values for the year
24950 * @param obj The calendar object.
24951 * @param min The minimum year.
24952 * @param max The maximum year.
24954 * Default values are 1902 and -1.
24956 * @see elm_calendar_min_max_year_get() for more details.
24958 * @ref calendar_example_05
24960 * @ingroup Calendar
24962 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
24965 * Enable or disable day selection
24967 * @param obj The calendar object.
24968 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
24971 * Enabled by default. If disabled, the user still can select months,
24972 * but not days. Selected days are highlighted on calendar.
24973 * It should be used if you won't need such selection for the widget usage.
24975 * When a day is selected, or month is changed, smart callbacks for
24976 * signal "changed" will be called.
24978 * @see elm_calendar_day_selection_enable_get()
24980 * @ref calendar_example_04
24982 * @ingroup Calendar
24984 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
24987 * Get a value whether day selection is enabled or not.
24989 * @see elm_calendar_day_selection_enable_set() for details.
24991 * @param obj The calendar object.
24992 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
24993 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
24995 * @ref calendar_example_05
24997 * @ingroup Calendar
24999 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25003 * Set selected date to be highlighted on calendar.
25005 * @param obj The calendar object.
25006 * @param selected_time A @b tm struct to represent the selected date.
25008 * Set the selected date, changing the displayed month if needed.
25009 * Selected date changes when the user goes to next/previous month or
25010 * select a day pressing over it on calendar.
25012 * @see elm_calendar_selected_time_get()
25014 * @ref calendar_example_04
25016 * @ingroup Calendar
25018 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
25021 * Get selected date.
25023 * @param obj The calendar object
25024 * @param selected_time A @b tm struct to point to selected date
25025 * @return EINA_FALSE means an error ocurred and returned time shouldn't
25028 * Get date selected by the user or set by function
25029 * elm_calendar_selected_time_set().
25030 * Selected date changes when the user goes to next/previous month or
25031 * select a day pressing over it on calendar.
25033 * @see elm_calendar_selected_time_get()
25035 * @ref calendar_example_05
25037 * @ingroup Calendar
25039 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
25042 * Set a function to format the string that will be used to display
25045 * @param obj The calendar object
25046 * @param format_function Function to set the month-year string given
25047 * the selected date
25049 * By default it uses strftime with "%B %Y" format string.
25050 * It should allocate the memory that will be used by the string,
25051 * that will be freed by the widget after usage.
25052 * A pointer to the string and a pointer to the time struct will be provided.
25057 * _format_month_year(struct tm *selected_time)
25060 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
25061 * return strdup(buf);
25064 * elm_calendar_format_function_set(calendar, _format_month_year);
25067 * @ref calendar_example_02
25069 * @ingroup Calendar
25071 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
25074 * Add a new mark to the calendar
25076 * @param obj The calendar object
25077 * @param mark_type A string used to define the type of mark. It will be
25078 * emitted to the theme, that should display a related modification on these
25079 * days representation.
25080 * @param mark_time A time struct to represent the date of inclusion of the
25081 * mark. For marks that repeats it will just be displayed after the inclusion
25082 * date in the calendar.
25083 * @param repeat Repeat the event following this periodicity. Can be a unique
25084 * mark (that don't repeat), daily, weekly, monthly or annually.
25085 * @return The created mark or @p NULL upon failure.
25087 * Add a mark that will be drawn in the calendar respecting the insertion
25088 * time and periodicity. It will emit the type as signal to the widget theme.
25089 * Default theme supports "holiday" and "checked", but it can be extended.
25091 * It won't immediately update the calendar, drawing the marks.
25092 * For this, call elm_calendar_marks_draw(). However, when user selects
25093 * next or previous month calendar forces marks drawn.
25095 * Marks created with this method can be deleted with
25096 * elm_calendar_mark_del().
25100 * struct tm selected_time;
25101 * time_t current_time;
25103 * current_time = time(NULL) + 5 * 84600;
25104 * localtime_r(¤t_time, &selected_time);
25105 * elm_calendar_mark_add(cal, "holiday", selected_time,
25106 * ELM_CALENDAR_ANNUALLY);
25108 * current_time = time(NULL) + 1 * 84600;
25109 * localtime_r(¤t_time, &selected_time);
25110 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
25112 * elm_calendar_marks_draw(cal);
25115 * @see elm_calendar_marks_draw()
25116 * @see elm_calendar_mark_del()
25118 * @ref calendar_example_06
25120 * @ingroup Calendar
25122 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);
25125 * Delete mark from the calendar.
25127 * @param mark The mark to be deleted.
25129 * If deleting all calendar marks is required, elm_calendar_marks_clear()
25130 * should be used instead of getting marks list and deleting each one.
25132 * @see elm_calendar_mark_add()
25134 * @ref calendar_example_06
25136 * @ingroup Calendar
25138 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
25141 * Remove all calendar's marks
25143 * @param obj The calendar object.
25145 * @see elm_calendar_mark_add()
25146 * @see elm_calendar_mark_del()
25148 * @ingroup Calendar
25150 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25154 * Get a list of all the calendar marks.
25156 * @param obj The calendar object.
25157 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
25159 * @see elm_calendar_mark_add()
25160 * @see elm_calendar_mark_del()
25161 * @see elm_calendar_marks_clear()
25163 * @ingroup Calendar
25165 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25168 * Draw calendar marks.
25170 * @param obj The calendar object.
25172 * Should be used after adding, removing or clearing marks.
25173 * It will go through the entire marks list updating the calendar.
25174 * If lots of marks will be added, add all the marks and then call
25177 * When the month is changed, i.e. user selects next or previous month,
25178 * marks will be drawed.
25180 * @see elm_calendar_mark_add()
25181 * @see elm_calendar_mark_del()
25182 * @see elm_calendar_marks_clear()
25184 * @ref calendar_example_06
25186 * @ingroup Calendar
25188 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
25189 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25190 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25191 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25194 * Set a day text color to the same that represents Saturdays.
25196 * @param obj The calendar object.
25197 * @param pos The text position. Position is the cell counter, from left
25198 * to right, up to down. It starts on 0 and ends on 41.
25200 * @deprecated use elm_calendar_mark_add() instead like:
25203 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
25204 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25207 * @see elm_calendar_mark_add()
25209 * @ingroup Calendar
25211 EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25214 * Set a day text color to the same that represents Sundays.
25216 * @param obj The calendar object.
25217 * @param pos The text position. Position is the cell counter, from left
25218 * to right, up to down. It starts on 0 and ends on 41.
25220 * @deprecated use elm_calendar_mark_add() instead like:
25223 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
25224 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25227 * @see elm_calendar_mark_add()
25229 * @ingroup Calendar
25231 EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25234 * Set a day text color to the same that represents Weekdays.
25236 * @param obj The calendar object
25237 * @param pos The text position. Position is the cell counter, from left
25238 * to right, up to down. It starts on 0 and ends on 41.
25240 * @deprecated use elm_calendar_mark_add() instead like:
25243 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
25245 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
25246 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25247 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
25248 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25249 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
25250 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25251 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
25252 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25253 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
25256 * @see elm_calendar_mark_add()
25258 * @ingroup Calendar
25260 EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25263 * Set the interval on time updates for an user mouse button hold
25264 * on calendar widgets' month selection.
25266 * @param obj The calendar object
25267 * @param interval The (first) interval value in seconds
25269 * This interval value is @b decreased while the user holds the
25270 * mouse pointer either selecting next or previous month.
25272 * This helps the user to get to a given month distant from the
25273 * current one easier/faster, as it will start to change quicker and
25274 * quicker on mouse button holds.
25276 * The calculation for the next change interval value, starting from
25277 * the one set with this call, is the previous interval divided by
25278 * 1.05, so it decreases a little bit.
25280 * The default starting interval value for automatic changes is
25283 * @see elm_calendar_interval_get()
25285 * @ingroup Calendar
25287 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25290 * Get the interval on time updates for an user mouse button hold
25291 * on calendar widgets' month selection.
25293 * @param obj The calendar object
25294 * @return The (first) interval value, in seconds, set on it
25296 * @see elm_calendar_interval_set() for more details
25298 * @ingroup Calendar
25300 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25307 * @defgroup Diskselector Diskselector
25308 * @ingroup Elementary
25310 * @image html img/widget/diskselector/preview-00.png
25311 * @image latex img/widget/diskselector/preview-00.eps
25313 * A diskselector is a kind of list widget. It scrolls horizontally,
25314 * and can contain label and icon objects. Three items are displayed
25315 * with the selected one in the middle.
25317 * It can act like a circular list with round mode and labels can be
25318 * reduced for a defined length for side items.
25320 * Smart callbacks one can listen to:
25321 * - "selected" - when item is selected, i.e. scroller stops.
25323 * Available styles for it:
25326 * List of examples:
25327 * @li @ref diskselector_example_01
25328 * @li @ref diskselector_example_02
25332 * @addtogroup Diskselector
25336 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(). */
25339 * Add a new diskselector widget to the given parent Elementary
25340 * (container) object.
25342 * @param parent The parent object.
25343 * @return a new diskselector widget handle or @c NULL, on errors.
25345 * This function inserts a new diskselector widget on the canvas.
25347 * @ingroup Diskselector
25349 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25352 * Enable or disable round mode.
25354 * @param obj The diskselector object.
25355 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
25358 * Disabled by default. If round mode is enabled the items list will
25359 * work like a circle list, so when the user reaches the last item,
25360 * the first one will popup.
25362 * @see elm_diskselector_round_get()
25364 * @ingroup Diskselector
25366 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
25369 * Get a value whether round mode is enabled or not.
25371 * @see elm_diskselector_round_set() for details.
25373 * @param obj The diskselector object.
25374 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
25375 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25377 * @ingroup Diskselector
25379 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25382 * Get the side labels max length.
25384 * @deprecated use elm_diskselector_side_label_length_get() instead:
25386 * @param obj The diskselector object.
25387 * @return The max length defined for side labels, or 0 if not a valid
25390 * @ingroup Diskselector
25392 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25395 * Set the side labels max length.
25397 * @deprecated use elm_diskselector_side_label_length_set() instead:
25399 * @param obj The diskselector object.
25400 * @param len The max length defined for side labels.
25402 * @ingroup Diskselector
25404 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25407 * Get the side labels max length.
25409 * @see elm_diskselector_side_label_length_set() for details.
25411 * @param obj The diskselector object.
25412 * @return The max length defined for side labels, or 0 if not a valid
25415 * @ingroup Diskselector
25417 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25420 * Set the side labels max length.
25422 * @param obj The diskselector object.
25423 * @param len The max length defined for side labels.
25425 * Length is the number of characters of items' label that will be
25426 * visible when it's set on side positions. It will just crop
25427 * the string after defined size. E.g.:
25429 * An item with label "January" would be displayed on side position as
25430 * "Jan" if max length is set to 3, or "Janu", if this property
25433 * When it's selected, the entire label will be displayed, except for
25434 * width restrictions. In this case label will be cropped and "..."
25435 * will be concatenated.
25437 * Default side label max length is 3.
25439 * This property will be applyed over all items, included before or
25440 * later this function call.
25442 * @ingroup Diskselector
25444 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25447 * Set the number of items to be displayed.
25449 * @param obj The diskselector object.
25450 * @param num The number of items the diskselector will display.
25452 * Default value is 3, and also it's the minimun. If @p num is less
25453 * than 3, it will be set to 3.
25455 * Also, it can be set on theme, using data item @c display_item_num
25456 * on group "elm/diskselector/item/X", where X is style set.
25459 * group { name: "elm/diskselector/item/X";
25461 * item: "display_item_num" "5";
25464 * @ingroup Diskselector
25466 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
25469 * Get the number of items in the diskselector object.
25471 * @param obj The diskselector object.
25473 * @ingroup Diskselector
25475 EAPI int elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25478 * Set bouncing behaviour when the scrolled content reaches an edge.
25480 * Tell the internal scroller object whether it should bounce or not
25481 * when it reaches the respective edges for each axis.
25483 * @param obj The diskselector object.
25484 * @param h_bounce Whether to bounce or not in the horizontal axis.
25485 * @param v_bounce Whether to bounce or not in the vertical axis.
25487 * @see elm_scroller_bounce_set()
25489 * @ingroup Diskselector
25491 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
25494 * Get the bouncing behaviour of the internal scroller.
25496 * Get whether the internal scroller should bounce when the edge of each
25497 * axis is reached scrolling.
25499 * @param obj The diskselector object.
25500 * @param h_bounce Pointer where to store the bounce state of the horizontal
25502 * @param v_bounce Pointer where to store the bounce state of the vertical
25505 * @see elm_scroller_bounce_get()
25506 * @see elm_diskselector_bounce_set()
25508 * @ingroup Diskselector
25510 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
25513 * Get the scrollbar policy.
25515 * @see elm_diskselector_scroller_policy_get() for details.
25517 * @param obj The diskselector object.
25518 * @param policy_h Pointer where to store horizontal scrollbar policy.
25519 * @param policy_v Pointer where to store vertical scrollbar policy.
25521 * @ingroup Diskselector
25523 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);
25526 * Set the scrollbar policy.
25528 * @param obj The diskselector object.
25529 * @param policy_h Horizontal scrollbar policy.
25530 * @param policy_v Vertical scrollbar policy.
25532 * This sets the scrollbar visibility policy for the given scroller.
25533 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
25534 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
25535 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
25536 * This applies respectively for the horizontal and vertical scrollbars.
25538 * The both are disabled by default, i.e., are set to
25539 * #ELM_SCROLLER_POLICY_OFF.
25541 * @ingroup Diskselector
25543 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
25546 * Remove all diskselector's items.
25548 * @param obj The diskselector object.
25550 * @see elm_diskselector_item_del()
25551 * @see elm_diskselector_item_append()
25553 * @ingroup Diskselector
25555 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25558 * Get a list of all the diskselector items.
25560 * @param obj The diskselector object.
25561 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
25562 * or @c NULL on failure.
25564 * @see elm_diskselector_item_append()
25565 * @see elm_diskselector_item_del()
25566 * @see elm_diskselector_clear()
25568 * @ingroup Diskselector
25570 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25573 * Appends a new item to the diskselector object.
25575 * @param obj The diskselector object.
25576 * @param label The label of the diskselector item.
25577 * @param icon The icon object to use at left side of the item. An
25578 * icon can be any Evas object, but usually it is an icon created
25579 * with elm_icon_add().
25580 * @param func The function to call when the item is selected.
25581 * @param data The data to associate with the item for related callbacks.
25583 * @return The created item or @c NULL upon failure.
25585 * A new item will be created and appended to the diskselector, i.e., will
25586 * be set as last item. Also, if there is no selected item, it will
25587 * be selected. This will always happens for the first appended item.
25589 * If no icon is set, label will be centered on item position, otherwise
25590 * the icon will be placed at left of the label, that will be shifted
25593 * Items created with this method can be deleted with
25594 * elm_diskselector_item_del().
25596 * Associated @p data can be properly freed when item is deleted if a
25597 * callback function is set with elm_diskselector_item_del_cb_set().
25599 * If a function is passed as argument, it will be called everytime this item
25600 * is selected, i.e., the user stops the diskselector with this
25601 * item on center position. If such function isn't needed, just passing
25602 * @c NULL as @p func is enough. The same should be done for @p data.
25604 * Simple example (with no function callback or data associated):
25606 * disk = elm_diskselector_add(win);
25607 * ic = elm_icon_add(win);
25608 * elm_icon_file_set(ic, "path/to/image", NULL);
25609 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
25610 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
25613 * @see elm_diskselector_item_del()
25614 * @see elm_diskselector_item_del_cb_set()
25615 * @see elm_diskselector_clear()
25616 * @see elm_icon_add()
25618 * @ingroup Diskselector
25620 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);
25624 * Delete them item from the diskselector.
25626 * @param it The item of diskselector to be deleted.
25628 * If deleting all diskselector items is required, elm_diskselector_clear()
25629 * should be used instead of getting items list and deleting each one.
25631 * @see elm_diskselector_clear()
25632 * @see elm_diskselector_item_append()
25633 * @see elm_diskselector_item_del_cb_set()
25635 * @ingroup Diskselector
25637 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25640 * Set the function called when a diskselector item is freed.
25642 * @param it The item to set the callback on
25643 * @param func The function called
25645 * If there is a @p func, then it will be called prior item's memory release.
25646 * That will be called with the following arguments:
25648 * @li item's Evas object;
25651 * This way, a data associated to a diskselector item could be properly
25654 * @ingroup Diskselector
25656 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
25659 * Get the data associated to the item.
25661 * @param it The diskselector item
25662 * @return The data associated to @p it
25664 * The return value is a pointer to data associated to @p item when it was
25665 * created, with function elm_diskselector_item_append(). If no data
25666 * was passed as argument, it will return @c NULL.
25668 * @see elm_diskselector_item_append()
25670 * @ingroup Diskselector
25672 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25675 * Set the icon associated to the item.
25677 * @param it The diskselector item
25678 * @param icon The icon object to associate with @p it
25680 * The icon object to use at left side of the item. An
25681 * icon can be any Evas object, but usually it is an icon created
25682 * with elm_icon_add().
25684 * Once the icon object is set, a previously set one will be deleted.
25685 * @warning Setting the same icon for two items will cause the icon to
25686 * dissapear from the first item.
25688 * If an icon was passed as argument on item creation, with function
25689 * elm_diskselector_item_append(), it will be already
25690 * associated to the item.
25692 * @see elm_diskselector_item_append()
25693 * @see elm_diskselector_item_icon_get()
25695 * @ingroup Diskselector
25697 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
25700 * Get the icon associated to the item.
25702 * @param it The diskselector item
25703 * @return The icon associated to @p it
25705 * The return value is a pointer to the icon associated to @p item when it was
25706 * created, with function elm_diskselector_item_append(), or later
25707 * with function elm_diskselector_item_icon_set. If no icon
25708 * was passed as argument, it will return @c NULL.
25710 * @see elm_diskselector_item_append()
25711 * @see elm_diskselector_item_icon_set()
25713 * @ingroup Diskselector
25715 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25718 * Set the label of item.
25720 * @param it The item of diskselector.
25721 * @param label The label of item.
25723 * The label to be displayed by the item.
25725 * If no icon is set, label will be centered on item position, otherwise
25726 * the icon will be placed at left of the label, that will be shifted
25729 * An item with label "January" would be displayed on side position as
25730 * "Jan" if max length is set to 3 with function
25731 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
25734 * When this @p item is selected, the entire label will be displayed,
25735 * except for width restrictions.
25736 * In this case label will be cropped and "..." will be concatenated,
25737 * but only for display purposes. It will keep the entire string, so
25738 * if diskselector is resized the remaining characters will be displayed.
25740 * If a label was passed as argument on item creation, with function
25741 * elm_diskselector_item_append(), it will be already
25742 * displayed by the item.
25744 * @see elm_diskselector_side_label_lenght_set()
25745 * @see elm_diskselector_item_label_get()
25746 * @see elm_diskselector_item_append()
25748 * @ingroup Diskselector
25750 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
25753 * Get the label of item.
25755 * @param it The item of diskselector.
25756 * @return The label of item.
25758 * The return value is a pointer to the label associated to @p item when it was
25759 * created, with function elm_diskselector_item_append(), or later
25760 * with function elm_diskselector_item_label_set. If no label
25761 * was passed as argument, it will return @c NULL.
25763 * @see elm_diskselector_item_label_set() for more details.
25764 * @see elm_diskselector_item_append()
25766 * @ingroup Diskselector
25768 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25771 * Get the selected item.
25773 * @param obj The diskselector object.
25774 * @return The selected diskselector item.
25776 * The selected item can be unselected with function
25777 * elm_diskselector_item_selected_set(), and the first item of
25778 * diskselector will be selected.
25780 * The selected item always will be centered on diskselector, with
25781 * full label displayed, i.e., max lenght set to side labels won't
25782 * apply on the selected item. More details on
25783 * elm_diskselector_side_label_length_set().
25785 * @ingroup Diskselector
25787 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25790 * Set the selected state of an item.
25792 * @param it The diskselector item
25793 * @param selected The selected state
25795 * This sets the selected state of the given item @p it.
25796 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
25798 * If a new item is selected the previosly selected will be unselected.
25799 * Previoulsy selected item can be get with function
25800 * elm_diskselector_selected_item_get().
25802 * If the item @p it is unselected, the first item of diskselector will
25805 * Selected items will be visible on center position of diskselector.
25806 * So if it was on another position before selected, or was invisible,
25807 * diskselector will animate items until the selected item reaches center
25810 * @see elm_diskselector_item_selected_get()
25811 * @see elm_diskselector_selected_item_get()
25813 * @ingroup Diskselector
25815 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
25818 * Get whether the @p item is selected or not.
25820 * @param it The diskselector item.
25821 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
25822 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
25824 * @see elm_diskselector_selected_item_set() for details.
25825 * @see elm_diskselector_item_selected_get()
25827 * @ingroup Diskselector
25829 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25832 * Get the first item of the diskselector.
25834 * @param obj The diskselector object.
25835 * @return The first item, or @c NULL if none.
25837 * The list of items follows append order. So it will return the first
25838 * item appended to the widget that wasn't deleted.
25840 * @see elm_diskselector_item_append()
25841 * @see elm_diskselector_items_get()
25843 * @ingroup Diskselector
25845 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25848 * Get the last item of the diskselector.
25850 * @param obj The diskselector object.
25851 * @return The last item, or @c NULL if none.
25853 * The list of items follows append order. So it will return last first
25854 * item appended to the widget that wasn't deleted.
25856 * @see elm_diskselector_item_append()
25857 * @see elm_diskselector_items_get()
25859 * @ingroup Diskselector
25861 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25864 * Get the item before @p item in diskselector.
25866 * @param it The diskselector item.
25867 * @return The item before @p item, or @c NULL if none or on failure.
25869 * The list of items follows append order. So it will return item appended
25870 * just before @p item and that wasn't deleted.
25872 * If it is the first item, @c NULL will be returned.
25873 * First item can be get by elm_diskselector_first_item_get().
25875 * @see elm_diskselector_item_append()
25876 * @see elm_diskselector_items_get()
25878 * @ingroup Diskselector
25880 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25883 * Get the item after @p item in diskselector.
25885 * @param it The diskselector item.
25886 * @return The item after @p item, or @c NULL if none or on failure.
25888 * The list of items follows append order. So it will return item appended
25889 * just after @p item and that wasn't deleted.
25891 * If it is the last item, @c NULL will be returned.
25892 * Last item can be get by elm_diskselector_last_item_get().
25894 * @see elm_diskselector_item_append()
25895 * @see elm_diskselector_items_get()
25897 * @ingroup Diskselector
25899 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25902 * Set the text to be shown in the diskselector item.
25904 * @param item Target item
25905 * @param text The text to set in the content
25907 * Setup the text as tooltip to object. The item can have only one tooltip,
25908 * so any previous tooltip data is removed.
25910 * @see elm_object_tooltip_text_set() for more details.
25912 * @ingroup Diskselector
25914 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
25917 * Set the content to be shown in the tooltip item.
25919 * Setup the tooltip to item. The item can have only one tooltip,
25920 * so any previous tooltip data is removed. @p func(with @p data) will
25921 * be called every time that need show the tooltip and it should
25922 * return a valid Evas_Object. This object is then managed fully by
25923 * tooltip system and is deleted when the tooltip is gone.
25925 * @param item the diskselector item being attached a tooltip.
25926 * @param func the function used to create the tooltip contents.
25927 * @param data what to provide to @a func as callback data/context.
25928 * @param del_cb called when data is not needed anymore, either when
25929 * another callback replaces @p func, the tooltip is unset with
25930 * elm_diskselector_item_tooltip_unset() or the owner @a item
25931 * dies. This callback receives as the first parameter the
25932 * given @a data, and @c event_info is the item.
25934 * @see elm_object_tooltip_content_cb_set() for more details.
25936 * @ingroup Diskselector
25938 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);
25941 * Unset tooltip from item.
25943 * @param item diskselector item to remove previously set tooltip.
25945 * Remove tooltip from item. The callback provided as del_cb to
25946 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
25947 * it is not used anymore.
25949 * @see elm_object_tooltip_unset() for more details.
25950 * @see elm_diskselector_item_tooltip_content_cb_set()
25952 * @ingroup Diskselector
25954 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25958 * Sets a different style for this item tooltip.
25960 * @note before you set a style you should define a tooltip with
25961 * elm_diskselector_item_tooltip_content_cb_set() or
25962 * elm_diskselector_item_tooltip_text_set()
25964 * @param item diskselector item with tooltip already set.
25965 * @param style the theme style to use (default, transparent, ...)
25967 * @see elm_object_tooltip_style_set() for more details.
25969 * @ingroup Diskselector
25971 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
25974 * Get the style for this item tooltip.
25976 * @param item diskselector item with tooltip already set.
25977 * @return style the theme style in use, defaults to "default". If the
25978 * object does not have a tooltip set, then NULL is returned.
25980 * @see elm_object_tooltip_style_get() for more details.
25981 * @see elm_diskselector_item_tooltip_style_set()
25983 * @ingroup Diskselector
25985 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25988 * Set the cursor to be shown when mouse is over the diskselector item
25990 * @param item Target item
25991 * @param cursor the cursor name to be used.
25993 * @see elm_object_cursor_set() for more details.
25995 * @ingroup Diskselector
25997 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
26000 * Get the cursor to be shown when mouse is over the diskselector item
26002 * @param item diskselector item with cursor already set.
26003 * @return the cursor name.
26005 * @see elm_object_cursor_get() for more details.
26006 * @see elm_diskselector_cursor_set()
26008 * @ingroup Diskselector
26010 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26014 * Unset the cursor to be shown when mouse is over the diskselector item
26016 * @param item Target item
26018 * @see elm_object_cursor_unset() for more details.
26019 * @see elm_diskselector_cursor_set()
26021 * @ingroup Diskselector
26023 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26026 * Sets a different style for this item cursor.
26028 * @note before you set a style you should define a cursor with
26029 * elm_diskselector_item_cursor_set()
26031 * @param item diskselector item with cursor already set.
26032 * @param style the theme style to use (default, transparent, ...)
26034 * @see elm_object_cursor_style_set() for more details.
26036 * @ingroup Diskselector
26038 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26042 * Get the style for this item cursor.
26044 * @param item diskselector item with cursor already set.
26045 * @return style the theme style in use, defaults to "default". If the
26046 * object does not have a cursor set, then @c NULL is returned.
26048 * @see elm_object_cursor_style_get() for more details.
26049 * @see elm_diskselector_item_cursor_style_set()
26051 * @ingroup Diskselector
26053 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26057 * Set if the cursor set should be searched on the theme or should use
26058 * the provided by the engine, only.
26060 * @note before you set if should look on theme you should define a cursor
26061 * with elm_diskselector_item_cursor_set().
26062 * By default it will only look for cursors provided by the engine.
26064 * @param item widget item with cursor already set.
26065 * @param engine_only boolean to define if cursors set with
26066 * elm_diskselector_item_cursor_set() should be searched only
26067 * between cursors provided by the engine or searched on widget's
26070 * @see elm_object_cursor_engine_only_set() for more details.
26072 * @ingroup Diskselector
26074 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
26077 * Get the cursor engine only usage for this item cursor.
26079 * @param item widget item with cursor already set.
26080 * @return engine_only boolean to define it cursors should be looked only
26081 * between the provided by the engine or searched on widget's theme as well.
26082 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
26084 * @see elm_object_cursor_engine_only_get() for more details.
26085 * @see elm_diskselector_item_cursor_engine_only_set()
26087 * @ingroup Diskselector
26089 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26096 * @page tutorial_colorselector Color selector example
26097 * @dontinclude colorselector_example_01.c
26099 * This example shows how to change the color of a rectangle using a color
26100 * selector. We aren't going to explain a lot of the code since it's the
26101 * usual setup code:
26102 * @until show(rect)
26104 * Now that we have a window with background and a rectangle we can create
26105 * our color_selector and set it's initial color to fully opaque blue:
26108 * Next we tell ask to be notified whenever the color changes:
26111 * We follow that we some more run of the mill setup code:
26112 * @until ELM_MAIN()
26114 * And now get to the callback that sets the color of the rectangle:
26117 * This example will look like this:
26118 * @image html screenshots/colorselector_example_01.png
26119 * @image latex screenshots/colorselector_example_01.eps
26121 * @example colorselector_example_01.c
26124 * @defgroup Colorselector Colorselector
26128 * @brief Widget for user to select a color.
26130 * Signals that you can add callbacks for are:
26131 * "changed" - When the color value changes(event_info is NULL).
26133 * See @ref tutorial_colorselector.
26136 * @brief Add a new colorselector to the parent
26138 * @param parent The parent object
26139 * @return The new object or NULL if it cannot be created
26141 * @ingroup Colorselector
26143 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26145 * Set a color for the colorselector
26147 * @param obj Colorselector object
26148 * @param r r-value of color
26149 * @param g g-value of color
26150 * @param b b-value of color
26151 * @param a a-value of color
26153 * @ingroup Colorselector
26155 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
26157 * Get a color from the colorselector
26159 * @param obj Colorselector object
26160 * @param r integer pointer for r-value of color
26161 * @param g integer pointer for g-value of color
26162 * @param b integer pointer for b-value of color
26163 * @param a integer pointer for a-value of color
26165 * @ingroup Colorselector
26167 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
26172 typedef struct _Elm_Ctxpopup_Item Elm_Ctxpopup_Item;
26175 * @defgroup Ctxpopup Ctxpopup
26177 * @image html img/widget/ctxpopup/preview-00.png
26178 * @image latex img/widget/ctxpopup/preview-00.eps
26180 * @brief Context popup widet.
26182 * A ctxpopup is a widget that, when shown, pops up a list of items.
26183 * It automatically chooses an area inside its parent object's view
26184 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
26185 * optimally fit into it. In the default theme, it will also point an
26186 * arrow to it's top left position at the time one shows it. Ctxpopup
26187 * items have a label and/or an icon. It is intended for a small
26188 * number of items (hence the use of list, not genlist).
26190 * @note Ctxpopup is a especialization of @ref Hover.
26192 * Signals that you can add callbacks for are:
26193 * "dismissed" - the ctxpopup was dismissed
26195 * Default contents parts of the ctxpopup widget that you can use for are:
26196 * @li "elm.swallow.content" - A content of the ctxpopup
26198 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
26201 typedef enum _Elm_Ctxpopup_Direction
26203 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
26205 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
26206 the clicked area */
26207 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
26208 the clicked area */
26209 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
26211 ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
26212 } Elm_Ctxpopup_Direction;
26215 * @brief Add a new Ctxpopup object to the parent.
26217 * @param parent Parent object
26218 * @return New object or @c NULL, if it cannot be created
26220 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26222 * @brief Set the Ctxpopup's parent
26224 * @param obj The ctxpopup object
26225 * @param area The parent to use
26227 * Set the parent object.
26229 * @note elm_ctxpopup_add() will automatically call this function
26230 * with its @c parent argument.
26232 * @see elm_ctxpopup_add()
26233 * @see elm_hover_parent_set()
26235 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
26237 * @brief Get the Ctxpopup's parent
26239 * @param obj The ctxpopup object
26241 * @see elm_ctxpopup_hover_parent_set() for more information
26243 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26245 * @brief Clear all items in the given ctxpopup object.
26247 * @param obj Ctxpopup object
26249 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26251 * @brief Change the ctxpopup's orientation to horizontal or vertical.
26253 * @param obj Ctxpopup object
26254 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
26256 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
26258 * @brief Get the value of current ctxpopup object's orientation.
26260 * @param obj Ctxpopup object
26261 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
26263 * @see elm_ctxpopup_horizontal_set()
26265 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26267 * @brief Add a new item to a ctxpopup object.
26269 * @param obj Ctxpopup object
26270 * @param icon Icon to be set on new item
26271 * @param label The Label of the new item
26272 * @param func Convenience function called when item selected
26273 * @param data Data passed to @p func
26274 * @return A handle to the item added or @c NULL, on errors
26276 * @warning Ctxpopup can't hold both an item list and a content at the same
26277 * time. When an item is added, any previous content will be removed.
26279 * @see elm_ctxpopup_content_set()
26281 Elm_Ctxpopup_Item *elm_ctxpopup_item_append(Evas_Object *obj, const char *label, Evas_Object *icon, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
26283 * @brief Delete the given item in a ctxpopup object.
26285 * @param it Ctxpopup item to be deleted
26287 * @see elm_ctxpopup_item_append()
26289 EAPI void elm_ctxpopup_item_del(Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
26291 * @brief Set the ctxpopup item's state as disabled or enabled.
26293 * @param it Ctxpopup item to be enabled/disabled
26294 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
26296 * When disabled the item is greyed out to indicate it's state.
26298 EAPI void elm_ctxpopup_item_disabled_set(Elm_Ctxpopup_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
26300 * @brief Get the ctxpopup item's disabled/enabled state.
26302 * @param it Ctxpopup item to be enabled/disabled
26303 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
26305 * @see elm_ctxpopup_item_disabled_set()
26307 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
26309 * @brief Get the icon object for the given ctxpopup item.
26311 * @param it Ctxpopup item
26312 * @return icon object or @c NULL, if the item does not have icon or an error
26315 * @see elm_ctxpopup_item_append()
26316 * @see elm_ctxpopup_item_icon_set()
26318 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
26320 * @brief Sets the side icon associated with the ctxpopup item
26322 * @param it Ctxpopup item
26323 * @param icon Icon object to be set
26325 * Once the icon object is set, a previously set one will be deleted.
26326 * @warning Setting the same icon for two items will cause the icon to
26327 * dissapear from the first item.
26329 * @see elm_ctxpopup_item_append()
26331 EAPI void elm_ctxpopup_item_icon_set(Elm_Ctxpopup_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
26333 * @brief Get the label for the given ctxpopup item.
26335 * @param it Ctxpopup item
26336 * @return label string or @c NULL, if the item does not have label or an
26339 * @see elm_ctxpopup_item_append()
26340 * @see elm_ctxpopup_item_label_set()
26342 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
26344 * @brief (Re)set the label on the given ctxpopup item.
26346 * @param it Ctxpopup item
26347 * @param label String to set as label
26349 EAPI void elm_ctxpopup_item_label_set(Elm_Ctxpopup_Item *item, const char *label) EINA_ARG_NONNULL(1);
26351 * @brief Set an elm widget as the content of the ctxpopup.
26353 * @param obj Ctxpopup object
26354 * @param content Content to be swallowed
26356 * If the content object is already set, a previous one will bedeleted. If
26357 * you want to keep that old content object, use the
26358 * elm_ctxpopup_content_unset() function.
26360 * @deprecated use elm_object_content_set()
26362 * @warning Ctxpopup can't hold both a item list and a content at the same
26363 * time. When a content is set, any previous items will be removed.
26365 EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
26367 * @brief Unset the ctxpopup content
26369 * @param obj Ctxpopup object
26370 * @return The content that was being used
26372 * Unparent and return the content object which was set for this widget.
26374 * @deprecated use elm_object_content_unset()
26376 * @see elm_ctxpopup_content_set()
26378 EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
26380 * @brief Set the direction priority of a ctxpopup.
26382 * @param obj Ctxpopup object
26383 * @param first 1st priority of direction
26384 * @param second 2nd priority of direction
26385 * @param third 3th priority of direction
26386 * @param fourth 4th priority of direction
26388 * This functions gives a chance to user to set the priority of ctxpopup
26389 * showing direction. This doesn't guarantee the ctxpopup will appear in the
26390 * requested direction.
26392 * @see Elm_Ctxpopup_Direction
26394 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);
26396 * @brief Get the direction priority of a ctxpopup.
26398 * @param obj Ctxpopup object
26399 * @param first 1st priority of direction to be returned
26400 * @param second 2nd priority of direction to be returned
26401 * @param third 3th priority of direction to be returned
26402 * @param fourth 4th priority of direction to be returned
26404 * @see elm_ctxpopup_direction_priority_set() for more information.
26406 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);
26409 * @brief Get the current direction of a ctxpopup.
26411 * @param obj Ctxpopup object
26412 * @return current direction of a ctxpopup
26414 * @warning Once the ctxpopup showed up, the direction would be determined
26416 EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26425 * @defgroup Transit Transit
26426 * @ingroup Elementary
26428 * Transit is designed to apply various animated transition effects to @c
26429 * Evas_Object, such like translation, rotation, etc. For using these
26430 * effects, create an @ref Elm_Transit and add the desired transition effects.
26432 * Once the effects are added into transit, they will be automatically
26433 * managed (their callback will be called until the duration is ended, and
26434 * they will be deleted on completion).
26438 * Elm_Transit *trans = elm_transit_add();
26439 * elm_transit_object_add(trans, obj);
26440 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
26441 * elm_transit_duration_set(transit, 1);
26442 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
26443 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
26444 * elm_transit_repeat_times_set(transit, 3);
26447 * Some transition effects are used to change the properties of objects. They
26449 * @li @ref elm_transit_effect_translation_add
26450 * @li @ref elm_transit_effect_color_add
26451 * @li @ref elm_transit_effect_rotation_add
26452 * @li @ref elm_transit_effect_wipe_add
26453 * @li @ref elm_transit_effect_zoom_add
26454 * @li @ref elm_transit_effect_resizing_add
26456 * Other transition effects are used to make one object disappear and another
26457 * object appear on its old place. These effects are:
26459 * @li @ref elm_transit_effect_flip_add
26460 * @li @ref elm_transit_effect_resizable_flip_add
26461 * @li @ref elm_transit_effect_fade_add
26462 * @li @ref elm_transit_effect_blend_add
26464 * It's also possible to make a transition chain with @ref
26465 * elm_transit_chain_transit_add.
26467 * @warning We strongly recommend to use elm_transit just when edje can not do
26468 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
26469 * animations can be manipulated inside the theme.
26471 * List of examples:
26472 * @li @ref transit_example_01_explained
26473 * @li @ref transit_example_02_explained
26474 * @li @ref transit_example_03_c
26475 * @li @ref transit_example_04_c
26481 * @enum Elm_Transit_Tween_Mode
26483 * The type of acceleration used in the transition.
26487 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
26488 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
26489 over time, then decrease again
26491 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
26493 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
26495 } Elm_Transit_Tween_Mode;
26498 * @enum Elm_Transit_Effect_Flip_Axis
26500 * The axis where flip effect should be applied.
26504 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
26505 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
26506 } Elm_Transit_Effect_Flip_Axis;
26508 * @enum Elm_Transit_Effect_Wipe_Dir
26510 * The direction where the wipe effect should occur.
26514 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
26515 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
26516 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
26517 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
26518 } Elm_Transit_Effect_Wipe_Dir;
26519 /** @enum Elm_Transit_Effect_Wipe_Type
26521 * Whether the wipe effect should show or hide the object.
26525 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
26527 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
26529 } Elm_Transit_Effect_Wipe_Type;
26532 * @typedef Elm_Transit
26534 * The Transit created with elm_transit_add(). This type has the information
26535 * about the objects which the transition will be applied, and the
26536 * transition effects that will be used. It also contains info about
26537 * duration, number of repetitions, auto-reverse, etc.
26539 typedef struct _Elm_Transit Elm_Transit;
26540 typedef void Elm_Transit_Effect;
26542 * @typedef Elm_Transit_Effect_Transition_Cb
26544 * Transition callback called for this effect on each transition iteration.
26546 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
26548 * Elm_Transit_Effect_End_Cb
26550 * Transition callback called for this effect when the transition is over.
26552 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
26555 * Elm_Transit_Del_Cb
26557 * A callback called when the transit is deleted.
26559 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
26564 * @note Is not necessary to delete the transit object, it will be deleted at
26565 * the end of its operation.
26566 * @note The transit will start playing when the program enter in the main loop, is not
26567 * necessary to give a start to the transit.
26569 * @return The transit object.
26573 EAPI Elm_Transit *elm_transit_add(void);
26576 * Stops the animation and delete the @p transit object.
26578 * Call this function if you wants to stop the animation before the duration
26579 * time. Make sure the @p transit object is still alive with
26580 * elm_transit_del_cb_set() function.
26581 * All added effects will be deleted, calling its repective data_free_cb
26582 * functions. The function setted by elm_transit_del_cb_set() will be called.
26584 * @see elm_transit_del_cb_set()
26586 * @param transit The transit object to be deleted.
26589 * @warning Just call this function if you are sure the transit is alive.
26591 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
26594 * Add a new effect to the transit.
26596 * @note The cb function and the data are the key to the effect. If you try to
26597 * add an already added effect, nothing is done.
26598 * @note After the first addition of an effect in @p transit, if its
26599 * effect list become empty again, the @p transit will be killed by
26600 * elm_transit_del(transit) function.
26604 * Elm_Transit *transit = elm_transit_add();
26605 * elm_transit_effect_add(transit,
26606 * elm_transit_effect_blend_op,
26607 * elm_transit_effect_blend_context_new(),
26608 * elm_transit_effect_blend_context_free);
26611 * @param transit The transit object.
26612 * @param transition_cb The operation function. It is called when the
26613 * animation begins, it is the function that actually performs the animation.
26614 * It is called with the @p data, @p transit and the time progression of the
26615 * animation (a double value between 0.0 and 1.0).
26616 * @param effect The context data of the effect.
26617 * @param end_cb The function to free the context data, it will be called
26618 * at the end of the effect, it must finalize the animation and free the
26622 * @warning The transit free the context data at the and of the transition with
26623 * the data_free_cb function, do not use the context data in another transit.
26625 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);
26628 * Delete an added effect.
26630 * This function will remove the effect from the @p transit, calling the
26631 * data_free_cb to free the @p data.
26633 * @see elm_transit_effect_add()
26635 * @note If the effect is not found, nothing is done.
26636 * @note If the effect list become empty, this function will call
26637 * elm_transit_del(transit), that is, it will kill the @p transit.
26639 * @param transit The transit object.
26640 * @param transition_cb The operation function.
26641 * @param effect The context data of the effect.
26645 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);
26648 * Add new object to apply the effects.
26650 * @note After the first addition of an object in @p transit, if its
26651 * object list become empty again, the @p transit will be killed by
26652 * elm_transit_del(transit) function.
26653 * @note If the @p obj belongs to another transit, the @p obj will be
26654 * removed from it and it will only belong to the @p transit. If the old
26655 * transit stays without objects, it will die.
26656 * @note When you add an object into the @p transit, its state from
26657 * evas_object_pass_events_get(obj) is saved, and it is applied when the
26658 * transit ends, if you change this state whith evas_object_pass_events_set()
26659 * after add the object, this state will change again when @p transit stops to
26662 * @param transit The transit object.
26663 * @param obj Object to be animated.
26666 * @warning It is not allowed to add a new object after transit begins to go.
26668 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
26671 * Removes an added object from the transit.
26673 * @note If the @p obj is not in the @p transit, nothing is done.
26674 * @note If the list become empty, this function will call
26675 * elm_transit_del(transit), that is, it will kill the @p transit.
26677 * @param transit The transit object.
26678 * @param obj Object to be removed from @p transit.
26681 * @warning It is not allowed to remove objects after transit begins to go.
26683 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
26686 * Get the objects of the transit.
26688 * @param transit The transit object.
26689 * @return a Eina_List with the objects from the transit.
26693 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26696 * Enable/disable keeping up the objects states.
26697 * If it is not kept, the objects states will be reset when transition ends.
26699 * @note @p transit can not be NULL.
26700 * @note One state includes geometry, color, map data.
26702 * @param transit The transit object.
26703 * @param state_keep Keeping or Non Keeping.
26707 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
26710 * Get a value whether the objects states will be reset or not.
26712 * @note @p transit can not be NULL
26714 * @see elm_transit_objects_final_state_keep_set()
26716 * @param transit The transit object.
26717 * @return EINA_TRUE means the states of the objects will be reset.
26718 * If @p transit is NULL, EINA_FALSE is returned
26722 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26725 * Set the event enabled when transit is operating.
26727 * If @p enabled is EINA_TRUE, the objects of the transit will receives
26728 * events from mouse and keyboard during the animation.
26729 * @note When you add an object with elm_transit_object_add(), its state from
26730 * evas_object_pass_events_get(obj) is saved, and it is applied when the
26731 * transit ends, if you change this state with evas_object_pass_events_set()
26732 * after adding the object, this state will change again when @p transit stops
26735 * @param transit The transit object.
26736 * @param enabled Events are received when enabled is @c EINA_TRUE, and
26737 * ignored otherwise.
26741 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
26744 * Get the value of event enabled status.
26746 * @see elm_transit_event_enabled_set()
26748 * @param transit The Transit object
26749 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
26750 * EINA_FALSE is returned
26754 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26757 * Set the user-callback function when the transit is deleted.
26759 * @note Using this function twice will overwrite the first function setted.
26760 * @note the @p transit object will be deleted after call @p cb function.
26762 * @param transit The transit object.
26763 * @param cb Callback function pointer. This function will be called before
26764 * the deletion of the transit.
26765 * @param data Callback funtion user data. It is the @p op parameter.
26769 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
26772 * Set reverse effect automatically.
26774 * If auto reverse is setted, after running the effects with the progress
26775 * parameter from 0 to 1, it will call the effecs again with the progress
26776 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
26777 * where the duration was setted with the function elm_transit_add and
26778 * the repeat with the function elm_transit_repeat_times_set().
26780 * @param transit The transit object.
26781 * @param reverse EINA_TRUE means the auto_reverse is on.
26785 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
26788 * Get if the auto reverse is on.
26790 * @see elm_transit_auto_reverse_set()
26792 * @param transit The transit object.
26793 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
26794 * EINA_FALSE is returned
26798 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26801 * Set the transit repeat count. Effect will be repeated by repeat count.
26803 * This function sets the number of repetition the transit will run after
26804 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
26805 * If the @p repeat is a negative number, it will repeat infinite times.
26807 * @note If this function is called during the transit execution, the transit
26808 * will run @p repeat times, ignoring the times it already performed.
26810 * @param transit The transit object
26811 * @param repeat Repeat count
26815 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
26818 * Get the transit repeat count.
26820 * @see elm_transit_repeat_times_set()
26822 * @param transit The Transit object.
26823 * @return The repeat count. If @p transit is NULL
26828 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26831 * Set the transit animation acceleration type.
26833 * This function sets the tween mode of the transit that can be:
26834 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
26835 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
26836 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
26837 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
26839 * @param transit The transit object.
26840 * @param tween_mode The tween type.
26844 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
26847 * Get the transit animation acceleration type.
26849 * @note @p transit can not be NULL
26851 * @param transit The transit object.
26852 * @return The tween type. If @p transit is NULL
26853 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
26857 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26860 * Set the transit animation time
26862 * @note @p transit can not be NULL
26864 * @param transit The transit object.
26865 * @param duration The animation time.
26869 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
26872 * Get the transit animation time
26874 * @note @p transit can not be NULL
26876 * @param transit The transit object.
26878 * @return The transit animation time.
26882 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26885 * Starts the transition.
26886 * Once this API is called, the transit begins to measure the time.
26888 * @note @p transit can not be NULL
26890 * @param transit The transit object.
26894 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
26897 * Pause/Resume the transition.
26899 * If you call elm_transit_go again, the transit will be started from the
26900 * beginning, and will be unpaused.
26902 * @note @p transit can not be NULL
26904 * @param transit The transit object.
26905 * @param paused Whether the transition should be paused or not.
26909 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
26912 * Get the value of paused status.
26914 * @see elm_transit_paused_set()
26916 * @note @p transit can not be NULL
26918 * @param transit The transit object.
26919 * @return EINA_TRUE means transition is paused. If @p transit is NULL
26920 * EINA_FALSE is returned
26924 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26927 * Get the time progression of the animation (a double value between 0.0 and 1.0).
26929 * The value returned is a fraction (current time / total time). It
26930 * represents the progression position relative to the total.
26932 * @note @p transit can not be NULL
26934 * @param transit The transit object.
26936 * @return The time progression value. If @p transit is NULL
26941 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26944 * Makes the chain relationship between two transits.
26946 * @note @p transit can not be NULL. Transit would have multiple chain transits.
26947 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
26949 * @param transit The transit object.
26950 * @param chain_transit The chain transit object. This transit will be operated
26951 * after transit is done.
26953 * This function adds @p chain_transit transition to a chain after the @p
26954 * transit, and will be started as soon as @p transit ends. See @ref
26955 * transit_example_02_explained for a full example.
26959 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
26962 * Cut off the chain relationship between two transits.
26964 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
26965 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
26967 * @param transit The transit object.
26968 * @param chain_transit The chain transit object.
26970 * This function remove the @p chain_transit transition from the @p transit.
26974 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
26977 * Get the current chain transit list.
26979 * @note @p transit can not be NULL.
26981 * @param transit The transit object.
26982 * @return chain transit list.
26986 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
26989 * Add the Resizing Effect to Elm_Transit.
26991 * @note This API is one of the facades. It creates resizing effect context
26992 * and add it's required APIs to elm_transit_effect_add.
26994 * @see elm_transit_effect_add()
26996 * @param transit Transit object.
26997 * @param from_w Object width size when effect begins.
26998 * @param from_h Object height size when effect begins.
26999 * @param to_w Object width size when effect ends.
27000 * @param to_h Object height size when effect ends.
27001 * @return Resizing effect context data.
27005 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);
27008 * Add the Translation Effect to Elm_Transit.
27010 * @note This API is one of the facades. It creates translation effect context
27011 * and add it's required APIs to elm_transit_effect_add.
27013 * @see elm_transit_effect_add()
27015 * @param transit Transit object.
27016 * @param from_dx X Position variation when effect begins.
27017 * @param from_dy Y Position variation when effect begins.
27018 * @param to_dx X Position variation when effect ends.
27019 * @param to_dy Y Position variation when effect ends.
27020 * @return Translation effect context data.
27023 * @warning It is highly recommended just create a transit with this effect when
27024 * the window that the objects of the transit belongs has already been created.
27025 * This is because this effect needs the geometry information about the objects,
27026 * and if the window was not created yet, it can get a wrong information.
27028 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);
27031 * Add the Zoom Effect to Elm_Transit.
27033 * @note This API is one of the facades. It creates zoom effect context
27034 * and add it's required APIs to elm_transit_effect_add.
27036 * @see elm_transit_effect_add()
27038 * @param transit Transit object.
27039 * @param from_rate Scale rate when effect begins (1 is current rate).
27040 * @param to_rate Scale rate when effect ends.
27041 * @return Zoom effect context data.
27044 * @warning It is highly recommended just create a transit with this effect when
27045 * the window that the objects of the transit belongs has already been created.
27046 * This is because this effect needs the geometry information about the objects,
27047 * and if the window was not created yet, it can get a wrong information.
27049 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
27052 * Add the Flip Effect to Elm_Transit.
27054 * @note This API is one of the facades. It creates flip effect context
27055 * and add it's required APIs to elm_transit_effect_add.
27056 * @note This effect is applied to each pair of objects in the order they are listed
27057 * in the transit list of objects. The first object in the pair will be the
27058 * "front" object and the second will be the "back" object.
27060 * @see elm_transit_effect_add()
27062 * @param transit Transit object.
27063 * @param axis Flipping Axis(X or Y).
27064 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27065 * @return Flip effect context data.
27068 * @warning It is highly recommended just create a transit with this effect when
27069 * the window that the objects of the transit belongs has already been created.
27070 * This is because this effect needs the geometry information about the objects,
27071 * and if the window was not created yet, it can get a wrong information.
27073 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27076 * Add the Resizable Flip Effect to Elm_Transit.
27078 * @note This API is one of the facades. It creates resizable flip effect context
27079 * and add it's required APIs to elm_transit_effect_add.
27080 * @note This effect is applied to each pair of objects in the order they are listed
27081 * in the transit list of objects. The first object in the pair will be the
27082 * "front" object and the second will be the "back" object.
27084 * @see elm_transit_effect_add()
27086 * @param transit Transit object.
27087 * @param axis Flipping Axis(X or Y).
27088 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27089 * @return Resizable flip effect context data.
27092 * @warning It is highly recommended just create a transit with this effect when
27093 * the window that the objects of the transit belongs has already been created.
27094 * This is because this effect needs the geometry information about the objects,
27095 * and if the window was not created yet, it can get a wrong information.
27097 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27100 * Add the Wipe Effect to Elm_Transit.
27102 * @note This API is one of the facades. It creates wipe effect context
27103 * and add it's required APIs to elm_transit_effect_add.
27105 * @see elm_transit_effect_add()
27107 * @param transit Transit object.
27108 * @param type Wipe type. Hide or show.
27109 * @param dir Wipe Direction.
27110 * @return Wipe effect context data.
27113 * @warning It is highly recommended just create a transit with this effect when
27114 * the window that the objects of the transit belongs has already been created.
27115 * This is because this effect needs the geometry information about the objects,
27116 * and if the window was not created yet, it can get a wrong information.
27118 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
27121 * Add the Color Effect to Elm_Transit.
27123 * @note This API is one of the facades. It creates color effect context
27124 * and add it's required APIs to elm_transit_effect_add.
27126 * @see elm_transit_effect_add()
27128 * @param transit Transit object.
27129 * @param from_r RGB R when effect begins.
27130 * @param from_g RGB G when effect begins.
27131 * @param from_b RGB B when effect begins.
27132 * @param from_a RGB A when effect begins.
27133 * @param to_r RGB R when effect ends.
27134 * @param to_g RGB G when effect ends.
27135 * @param to_b RGB B when effect ends.
27136 * @param to_a RGB A when effect ends.
27137 * @return Color effect context data.
27141 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);
27144 * Add the Fade Effect to Elm_Transit.
27146 * @note This API is one of the facades. It creates fade effect context
27147 * and add it's required APIs to elm_transit_effect_add.
27148 * @note This effect is applied to each pair of objects in the order they are listed
27149 * in the transit list of objects. The first object in the pair will be the
27150 * "before" object and the second will be the "after" object.
27152 * @see elm_transit_effect_add()
27154 * @param transit Transit object.
27155 * @return Fade effect context data.
27158 * @warning It is highly recommended just create a transit with this effect when
27159 * the window that the objects of the transit belongs has already been created.
27160 * This is because this effect needs the color information about the objects,
27161 * and if the window was not created yet, it can get a wrong information.
27163 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
27166 * Add the Blend Effect to Elm_Transit.
27168 * @note This API is one of the facades. It creates blend effect context
27169 * and add it's required APIs to elm_transit_effect_add.
27170 * @note This effect is applied to each pair of objects in the order they are listed
27171 * in the transit list of objects. The first object in the pair will be the
27172 * "before" object and the second will be the "after" object.
27174 * @see elm_transit_effect_add()
27176 * @param transit Transit object.
27177 * @return Blend effect context data.
27180 * @warning It is highly recommended just create a transit with this effect when
27181 * the window that the objects of the transit belongs has already been created.
27182 * This is because this effect needs the color information about the objects,
27183 * and if the window was not created yet, it can get a wrong information.
27185 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
27188 * Add the Rotation Effect to Elm_Transit.
27190 * @note This API is one of the facades. It creates rotation effect context
27191 * and add it's required APIs to elm_transit_effect_add.
27193 * @see elm_transit_effect_add()
27195 * @param transit Transit object.
27196 * @param from_degree Degree when effect begins.
27197 * @param to_degree Degree when effect is ends.
27198 * @return Rotation effect context data.
27201 * @warning It is highly recommended just create a transit with this effect when
27202 * the window that the objects of the transit belongs has already been created.
27203 * This is because this effect needs the geometry information about the objects,
27204 * and if the window was not created yet, it can get a wrong information.
27206 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
27209 * Add the ImageAnimation Effect to Elm_Transit.
27211 * @note This API is one of the facades. It creates image animation effect context
27212 * and add it's required APIs to elm_transit_effect_add.
27213 * The @p images parameter is a list images paths. This list and
27214 * its contents will be deleted at the end of the effect by
27215 * elm_transit_effect_image_animation_context_free() function.
27219 * char buf[PATH_MAX];
27220 * Eina_List *images = NULL;
27221 * Elm_Transit *transi = elm_transit_add();
27223 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
27224 * images = eina_list_append(images, eina_stringshare_add(buf));
27226 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
27227 * images = eina_list_append(images, eina_stringshare_add(buf));
27228 * elm_transit_effect_image_animation_add(transi, images);
27232 * @see elm_transit_effect_add()
27234 * @param transit Transit object.
27235 * @param images Eina_List of images file paths. This list and
27236 * its contents will be deleted at the end of the effect by
27237 * elm_transit_effect_image_animation_context_free() function.
27238 * @return Image Animation effect context data.
27242 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
27248 typedef struct _Elm_Store Elm_Store;
27249 typedef struct _Elm_Store_DBsystem Elm_Store_DBsystem;
27250 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
27251 typedef struct _Elm_Store_Item Elm_Store_Item;
27252 typedef struct _Elm_Store_Item_DBsystem Elm_Store_Item_DBsystem;
27253 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
27254 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
27255 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
27256 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
27257 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
27258 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
27259 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
27260 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
27262 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
27263 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
27264 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
27265 typedef void (*Elm_Store_Item_Select_Cb) (void *data, Elm_Store_Item *sti);
27266 typedef int (*Elm_Store_Item_Sort_Cb) (void *data, Elm_Store_Item_Info *info1, Elm_Store_Item_Info *info2);
27267 typedef void (*Elm_Store_Item_Free_Cb) (void *data, Elm_Store_Item_Info *info);
27268 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
27272 ELM_STORE_ITEM_MAPPING_NONE = 0,
27273 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
27274 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
27275 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
27276 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
27277 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
27278 // can add more here as needed by common apps
27279 ELM_STORE_ITEM_MAPPING_LAST
27280 } Elm_Store_Item_Mapping_Type;
27282 struct _Elm_Store_Item_Mapping_Icon
27284 // FIXME: allow edje file icons
27286 Elm_Icon_Lookup_Order lookup_order;
27287 Eina_Bool standard_name : 1;
27288 Eina_Bool no_scale : 1;
27289 Eina_Bool smooth : 1;
27290 Eina_Bool scale_up : 1;
27291 Eina_Bool scale_down : 1;
27294 struct _Elm_Store_Item_Mapping_Empty
27299 struct _Elm_Store_Item_Mapping_Photo
27304 struct _Elm_Store_Item_Mapping_Custom
27306 Elm_Store_Item_Mapping_Cb func;
27309 struct _Elm_Store_Item_Mapping
27311 Elm_Store_Item_Mapping_Type type;
27316 Elm_Store_Item_Mapping_Empty empty;
27317 Elm_Store_Item_Mapping_Icon icon;
27318 Elm_Store_Item_Mapping_Photo photo;
27319 Elm_Store_Item_Mapping_Custom custom;
27320 // add more types here
27324 struct _Elm_Store_Item_Info
27329 Eina_Bool rec_item;
27330 int pre_group_index;
27332 Elm_Genlist_Item_Class *item_class;
27333 const Elm_Store_Item_Mapping *mapping;
27338 struct _Elm_Store_Item_Info_Filesystem
27340 Elm_Store_Item_Info base;
27344 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
27345 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
27347 EAPI Elm_Store *elm_store_dbsystem_new(void);
27348 EAPI void elm_store_item_count_set(Elm_Store *st, int count) EINA_ARG_NONNULL(1);
27349 EAPI void elm_store_item_select_func_set(Elm_Store *st, Elm_Store_Item_Select_Cb func, const void *data) EINA_ARG_NONNULL(1);
27350 EAPI void elm_store_item_sort_func_set(Elm_Store *st, Elm_Store_Item_Sort_Cb func, const void *data) EINA_ARG_NONNULL(1);
27351 EAPI void elm_store_item_free_func_set(Elm_Store *st, Elm_Store_Item_Free_Cb func, const void *data) EINA_ARG_NONNULL(1);
27352 EAPI int elm_store_item_data_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27353 EAPI void *elm_store_dbsystem_db_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27354 EAPI void elm_store_dbsystem_db_set(Elm_Store *store, void *pDB) EINA_ARG_NONNULL(1);
27355 EAPI int elm_store_item_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27356 EAPI Elm_Store_Item *elm_store_item_add(Elm_Store *st, Elm_Store_Item_Info *info) EINA_ARG_NONNULL(1);
27357 EAPI void elm_store_item_update(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27358 EAPI void elm_store_visible_items_update(Elm_Store *st) EINA_ARG_NONNULL(1);
27359 EAPI void elm_store_item_del(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27360 EAPI void elm_store_free(Elm_Store *st);
27361 EAPI Elm_Store *elm_store_filesystem_new(void);
27362 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
27363 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27364 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27365 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
27366 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
27367 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27368 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27369 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27370 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
27371 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27372 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27373 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
27374 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27375 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
27376 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27377 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27378 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27381 * @defgroup SegmentControl SegmentControl
27382 * @ingroup Elementary
27384 * @image html img/widget/segment_control/preview-00.png
27385 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
27387 * @image html img/segment_control.png
27388 * @image latex img/segment_control.eps width=\textwidth
27390 * Segment control widget is a horizontal control made of multiple segment
27391 * items, each segment item functioning similar to discrete two state button.
27392 * A segment control groups the items together and provides compact
27393 * single button with multiple equal size segments.
27395 * Segment item size is determined by base widget
27396 * size and the number of items added.
27397 * Only one segment item can be at selected state. A segment item can display
27398 * combination of Text and any Evas_Object like Images or other widget.
27400 * Smart callbacks one can listen to:
27401 * - "changed" - When the user clicks on a segment item which is not
27402 * previously selected and get selected. The event_info parameter is the
27403 * segment item pointer.
27405 * Available styles for it:
27408 * Here is an example on its usage:
27409 * @li @ref segment_control_example
27413 * @addtogroup SegmentControl
27417 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
27420 * Add a new segment control widget to the given parent Elementary
27421 * (container) object.
27423 * @param parent The parent object.
27424 * @return a new segment control widget handle or @c NULL, on errors.
27426 * This function inserts a new segment control widget on the canvas.
27428 * @ingroup SegmentControl
27430 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27433 * Append a new item to the segment control object.
27435 * @param obj The segment control object.
27436 * @param icon The icon object to use for the left side of the item. An
27437 * icon can be any Evas object, but usually it is an icon created
27438 * with elm_icon_add().
27439 * @param label The label of the item.
27440 * Note that, NULL is different from empty string "".
27441 * @return The created item or @c NULL upon failure.
27443 * A new item will be created and appended to the segment control, i.e., will
27444 * be set as @b last item.
27446 * If it should be inserted at another position,
27447 * elm_segment_control_item_insert_at() should be used instead.
27449 * Items created with this function can be deleted with function
27450 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27452 * @note @p label set to @c NULL is different from empty string "".
27454 * only has icon, it will be displayed bigger and centered. If it has
27455 * icon and label, even that an empty string, icon will be smaller and
27456 * positioned at left.
27460 * sc = elm_segment_control_add(win);
27461 * ic = elm_icon_add(win);
27462 * elm_icon_file_set(ic, "path/to/image", NULL);
27463 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
27464 * elm_segment_control_item_add(sc, ic, "label");
27465 * evas_object_show(sc);
27468 * @see elm_segment_control_item_insert_at()
27469 * @see elm_segment_control_item_del()
27471 * @ingroup SegmentControl
27473 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
27476 * Insert a new item to the segment control object at specified position.
27478 * @param obj The segment control object.
27479 * @param icon The icon object to use for the left side of the item. An
27480 * icon can be any Evas object, but usually it is an icon created
27481 * with elm_icon_add().
27482 * @param label The label of the item.
27483 * @param index Item position. Value should be between 0 and items count.
27484 * @return The created item or @c NULL upon failure.
27486 * Index values must be between @c 0, when item will be prepended to
27487 * segment control, and items count, that can be get with
27488 * elm_segment_control_item_count_get(), case when item will be appended
27489 * to segment control, just like elm_segment_control_item_add().
27491 * Items created with this function can be deleted with function
27492 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27494 * @note @p label set to @c NULL is different from empty string "".
27496 * only has icon, it will be displayed bigger and centered. If it has
27497 * icon and label, even that an empty string, icon will be smaller and
27498 * positioned at left.
27500 * @see elm_segment_control_item_add()
27501 * @see elm_segment_control_item_count_get()
27502 * @see elm_segment_control_item_del()
27504 * @ingroup SegmentControl
27506 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);
27509 * Remove a segment control item from its parent, deleting it.
27511 * @param it The item to be removed.
27513 * Items can be added with elm_segment_control_item_add() or
27514 * elm_segment_control_item_insert_at().
27516 * @ingroup SegmentControl
27518 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27521 * Remove a segment control item at given index from its parent,
27524 * @param obj The segment control object.
27525 * @param index The position of the segment control item to be deleted.
27527 * Items can be added with elm_segment_control_item_add() or
27528 * elm_segment_control_item_insert_at().
27530 * @ingroup SegmentControl
27532 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27535 * Get the Segment items count from segment control.
27537 * @param obj The segment control object.
27538 * @return Segment items count.
27540 * It will just return the number of items added to segment control @p obj.
27542 * @ingroup SegmentControl
27544 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27547 * Get the item placed at specified index.
27549 * @param obj The segment control object.
27550 * @param index The index of the segment item.
27551 * @return The segment control item or @c NULL on failure.
27553 * Index is the position of an item in segment control widget. Its
27554 * range is from @c 0 to <tt> count - 1 </tt>.
27555 * Count is the number of items, that can be get with
27556 * elm_segment_control_item_count_get().
27558 * @ingroup SegmentControl
27560 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27563 * Get the label of item.
27565 * @param obj The segment control object.
27566 * @param index The index of the segment item.
27567 * @return The label of the item at @p index.
27569 * The return value is a pointer to the label associated to the item when
27570 * it was created, with function elm_segment_control_item_add(), or later
27571 * with function elm_segment_control_item_label_set. If no label
27572 * was passed as argument, it will return @c NULL.
27574 * @see elm_segment_control_item_label_set() for more details.
27575 * @see elm_segment_control_item_add()
27577 * @ingroup SegmentControl
27579 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27582 * Set the label of item.
27584 * @param it The item of segment control.
27585 * @param text The label of item.
27587 * The label to be displayed by the item.
27588 * Label will be at right of the icon (if set).
27590 * If a label was passed as argument on item creation, with function
27591 * elm_control_segment_item_add(), it will be already
27592 * displayed by the item.
27594 * @see elm_segment_control_item_label_get()
27595 * @see elm_segment_control_item_add()
27597 * @ingroup SegmentControl
27599 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
27602 * Get the icon associated to the item.
27604 * @param obj The segment control object.
27605 * @param index The index of the segment item.
27606 * @return The left side icon associated to the item at @p index.
27608 * The return value is a pointer to the icon associated to the item when
27609 * it was created, with function elm_segment_control_item_add(), or later
27610 * with function elm_segment_control_item_icon_set(). If no icon
27611 * was passed as argument, it will return @c NULL.
27613 * @see elm_segment_control_item_add()
27614 * @see elm_segment_control_item_icon_set()
27616 * @ingroup SegmentControl
27618 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27621 * Set the icon associated to the item.
27623 * @param it The segment control item.
27624 * @param icon The icon object to associate with @p it.
27626 * The icon object to use at left side of the item. An
27627 * icon can be any Evas object, but usually it is an icon created
27628 * with elm_icon_add().
27630 * Once the icon object is set, a previously set one will be deleted.
27631 * @warning Setting the same icon for two items will cause the icon to
27632 * dissapear from the first item.
27634 * If an icon was passed as argument on item creation, with function
27635 * elm_segment_control_item_add(), it will be already
27636 * associated to the item.
27638 * @see elm_segment_control_item_add()
27639 * @see elm_segment_control_item_icon_get()
27641 * @ingroup SegmentControl
27643 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
27646 * Get the index of an item.
27648 * @param it The segment control item.
27649 * @return The position of item in segment control widget.
27651 * Index is the position of an item in segment control widget. Its
27652 * range is from @c 0 to <tt> count - 1 </tt>.
27653 * Count is the number of items, that can be get with
27654 * elm_segment_control_item_count_get().
27656 * @ingroup SegmentControl
27658 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27661 * Get the base object of the item.
27663 * @param it The segment control item.
27664 * @return The base object associated with @p it.
27666 * Base object is the @c Evas_Object that represents that item.
27668 * @ingroup SegmentControl
27670 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27673 * Get the selected item.
27675 * @param obj The segment control object.
27676 * @return The selected item or @c NULL if none of segment items is
27679 * The selected item can be unselected with function
27680 * elm_segment_control_item_selected_set().
27682 * The selected item always will be highlighted on segment control.
27684 * @ingroup SegmentControl
27686 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27689 * Set the selected state of an item.
27691 * @param it The segment control item
27692 * @param select The selected state
27694 * This sets the selected state of the given item @p it.
27695 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
27697 * If a new item is selected the previosly selected will be unselected.
27698 * Previoulsy selected item can be get with function
27699 * elm_segment_control_item_selected_get().
27701 * The selected item always will be highlighted on segment control.
27703 * @see elm_segment_control_item_selected_get()
27705 * @ingroup SegmentControl
27707 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
27714 * @defgroup Grid Grid
27716 * The grid is a grid layout widget that lays out a series of children as a
27717 * fixed "grid" of widgets using a given percentage of the grid width and
27718 * height each using the child object.
27720 * The Grid uses a "Virtual resolution" that is stretched to fill the grid
27721 * widgets size itself. The default is 100 x 100, so that means the
27722 * position and sizes of children will effectively be percentages (0 to 100)
27723 * of the width or height of the grid widget
27729 * Add a new grid to the parent
27731 * @param parent The parent object
27732 * @return The new object or NULL if it cannot be created
27736 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
27739 * Set the virtual size of the grid
27741 * @param obj The grid object
27742 * @param w The virtual width of the grid
27743 * @param h The virtual height of the grid
27747 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
27750 * Get the virtual size of the grid
27752 * @param obj The grid object
27753 * @param w Pointer to integer to store the virtual width of the grid
27754 * @param h Pointer to integer to store the virtual height of the grid
27758 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
27761 * Pack child at given position and size
27763 * @param obj The grid object
27764 * @param subobj The child to pack
27765 * @param x The virtual x coord at which to pack it
27766 * @param y The virtual y coord at which to pack it
27767 * @param w The virtual width at which to pack it
27768 * @param h The virtual height at which to pack it
27772 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
27775 * Unpack a child from a grid object
27777 * @param obj The grid object
27778 * @param subobj The child to unpack
27782 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
27785 * Faster way to remove all child objects from a grid object.
27787 * @param obj The grid object
27788 * @param clear If true, it will delete just removed children
27792 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
27795 * Set packing of an existing child at to position and size
27797 * @param subobj The child to set packing of
27798 * @param x The virtual x coord at which to pack it
27799 * @param y The virtual y coord at which to pack it
27800 * @param w The virtual width at which to pack it
27801 * @param h The virtual height at which to pack it
27805 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
27808 * get packing of a child
27810 * @param subobj The child to query
27811 * @param x Pointer to integer to store the virtual x coord
27812 * @param y Pointer to integer to store the virtual y coord
27813 * @param w Pointer to integer to store the virtual width
27814 * @param h Pointer to integer to store the virtual height
27818 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
27824 EAPI Evas_Object *elm_genscroller_add(Evas_Object *parent);
27825 EAPI void elm_genscroller_world_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h);
27827 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
27828 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
27829 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
27830 EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
27831 EAPI void elm_video_play(Evas_Object *video);
27832 EAPI void elm_video_pause(Evas_Object *video);
27833 EAPI void elm_video_stop(Evas_Object *video);
27834 EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
27835 EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
27836 EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
27837 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
27838 EAPI double elm_video_audio_level_get(Evas_Object *video);
27839 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
27840 EAPI double elm_video_play_position_get(Evas_Object *video);
27841 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
27842 EAPI double elm_video_play_length_get(Evas_Object *video);
27843 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
27844 EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
27845 EAPI const char *elm_video_title_get(Evas_Object *video);
27847 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
27848 EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
27850 // FIXME: incomplete - carousel. don't use this until this comment is removed
27851 typedef struct _Elm_Carousel_Item Elm_Carousel_Item;
27852 EAPI Evas_Object *elm_carousel_add(Evas_Object *parent);
27853 EAPI Elm_Carousel_Item *elm_carousel_item_add(Evas_Object *obj, Evas_Object *icon, const char *label, Evas_Smart_Cb func, const void *data);
27854 EAPI void elm_carousel_item_del(Elm_Carousel_Item *item);
27855 EAPI void elm_carousel_item_select(Elm_Carousel_Item *item);
27856 /* smart callbacks called:
27857 * "clicked" - when the user clicks on a carousel item and becomes selected
27862 typedef enum _Elm_Datefield_ItemType
27864 ELM_DATEFIELD_YEAR = 0,
27865 ELM_DATEFIELD_MONTH,
27866 ELM_DATEFIELD_DATE,
27867 ELM_DATEFIELD_HOUR,
27868 ELM_DATEFIELD_MINUTE,
27870 } Elm_Datefield_ItemType;
27872 EAPI Evas_Object *elm_datefield_add(Evas_Object *parent);
27873 EAPI void elm_datefield_format_set(Evas_Object *obj, const char *fmt);
27874 EAPI char *elm_datefield_format_get(const Evas_Object *obj);
27875 EAPI void elm_datefield_item_enabled_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, Eina_Bool enable);
27876 EAPI Eina_Bool elm_datefield_item_enabled_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
27877 EAPI void elm_datefield_item_value_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value);
27878 EAPI int elm_datefield_item_value_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
27879 EAPI void elm_datefield_item_min_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value, Eina_Bool abs_limit);
27880 EAPI int elm_datefield_item_min_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
27881 EAPI Eina_Bool elm_datefield_item_min_is_absolute(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
27882 EAPI void elm_datefield_item_max_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value, Eina_Bool abs_limit);
27883 EAPI int elm_datefield_item_max_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
27884 EAPI Eina_Bool elm_datefield_item_max_is_absolute(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
27886 /* smart callbacks called:
27887 * "changed" - when datefield value is changed, this signal is sent.
27890 ////////////////////// DEPRECATED ///////////////////////////////////
27892 typedef enum _Elm_Datefield_Layout
27894 ELM_DATEFIELD_LAYOUT_TIME,
27895 ELM_DATEFIELD_LAYOUT_DATE,
27896 ELM_DATEFIELD_LAYOUT_DATEANDTIME
27897 } Elm_Datefield_Layout;
27899 EINA_DEPRECATED EAPI void elm_datefield_layout_set(Evas_Object *obj, Elm_Datefield_Layout layout);
27900 EINA_DEPRECATED EAPI Elm_Datefield_Layout elm_datefield_layout_get(const Evas_Object *obj);
27901 EINA_DEPRECATED EAPI void elm_datefield_date_format_set(Evas_Object *obj, const char *fmt);
27902 EINA_DEPRECATED EAPI const char *elm_datefield_date_format_get(const Evas_Object *obj);
27903 EINA_DEPRECATED EAPI void elm_datefield_time_mode_set(Evas_Object *obj, Eina_Bool mode);
27904 EINA_DEPRECATED EAPI Eina_Bool elm_datefield_time_mode_get(const Evas_Object *obj);
27905 EINA_DEPRECATED EAPI void elm_datefield_date_set(Evas_Object *obj, int year, int month, int day, int hour, int min);
27906 EINA_DEPRECATED EAPI void elm_datefield_date_get(const Evas_Object *obj, int *year, int *month, int *day, int *hour, int *min);
27907 EINA_DEPRECATED EAPI Eina_Bool elm_datefield_date_max_set(Evas_Object *obj, int year, int month, int day);
27908 EINA_DEPRECATED EAPI void elm_datefield_date_max_get(const Evas_Object *obj, int *year, int *month, int *day);
27909 EINA_DEPRECATED EAPI Eina_Bool elm_datefield_date_min_set(Evas_Object *obj, int year, int month, int day);
27910 EINA_DEPRECATED EAPI void elm_datefield_date_min_get(const Evas_Object *obj, int *year, int *month, int *day);
27911 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);
27912 EINA_DEPRECATED EAPI void elm_datefield_input_panel_state_callback_del(Evas_Object *obj, void (*pEventCallbackFunc) (void *data, Evas_Object *obj, int value));
27913 /////////////////////////////////////////////////////////////////////
27916 typedef enum _Elm_Popup_Response
27918 ELM_POPUP_RESPONSE_NONE = -1,
27919 ELM_POPUP_RESPONSE_TIMEOUT = -2,
27920 ELM_POPUP_RESPONSE_OK = -3,
27921 ELM_POPUP_RESPONSE_CANCEL = -4,
27922 ELM_POPUP_RESPONSE_CLOSE = -5
27923 } Elm_Popup_Response;
27925 typedef enum _Elm_Popup_Mode
27927 ELM_POPUP_TYPE_NONE = 0,
27928 ELM_POPUP_TYPE_ALERT = (1 << 0)
27931 typedef enum _Elm_Popup_Orient
27933 ELM_POPUP_ORIENT_TOP,
27934 ELM_POPUP_ORIENT_CENTER,
27935 ELM_POPUP_ORIENT_BOTTOM,
27936 ELM_POPUP_ORIENT_LEFT,
27937 ELM_POPUP_ORIENT_RIGHT,
27938 ELM_POPUP_ORIENT_TOP_LEFT,
27939 ELM_POPUP_ORIENT_TOP_RIGHT,
27940 ELM_POPUP_ORIENT_BOTTOM_LEFT,
27941 ELM_POPUP_ORIENT_BOTTOM_RIGHT
27942 } Elm_Popup_Orient;
27944 /* smart callbacks called:
27945 * "response" - when ever popup is closed, this signal is sent with appropriate response id.".
27948 EAPI Evas_Object *elm_popup_add(Evas_Object *parent);
27949 EAPI void elm_popup_desc_set(Evas_Object *obj, const char *text);
27950 EAPI const char *elm_popup_desc_get(Evas_Object *obj);
27951 EAPI void elm_popup_title_label_set(Evas_Object *obj, const char *text);
27952 EAPI const char *elm_popup_title_label_get(Evas_Object *obj);
27953 EAPI void elm_popup_title_icon_set(Evas_Object *obj, Evas_Object *icon);
27954 EAPI Evas_Object *elm_popup_title_icon_get(Evas_Object *obj);
27955 EAPI void elm_popup_content_set(Evas_Object *obj, Evas_Object *content);
27956 EAPI Evas_Object *elm_popup_content_get(Evas_Object *obj);
27957 EAPI void elm_popup_buttons_add(Evas_Object *obj,int no_of_buttons, const char *first_button_text, ...);
27958 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, ... );
27959 EAPI void elm_popup_timeout_set(Evas_Object *obj, double timeout);
27960 EAPI void elm_popup_mode_set(Evas_Object *obj, Elm_Popup_Mode mode);
27961 EAPI void elm_popup_response(Evas_Object *obj, int response_id);
27962 EAPI void elm_popup_orient_set(Evas_Object *obj, Elm_Popup_Orient orient);
27963 EAPI int elm_popup_run(Evas_Object *obj);
27965 /* NavigationBar */
27966 #define NAVIBAR_TITLEOBJ_INSTANT_HIDE "elm,state,hide,noanimate,title", "elm"
27967 #define NAVIBAR_TITLEOBJ_INSTANT_SHOW "elm,state,show,noanimate,title", "elm"
27971 ELM_NAVIGATIONBAR_FUNCTION_BUTTON1,
27972 ELM_NAVIGATIONBAR_FUNCTION_BUTTON2,
27973 ELM_NAVIGATIONBAR_FUNCTION_BUTTON3,
27974 ELM_NAVIGATIONBAR_BACK_BUTTON
27975 } Elm_Navi_Button_Type;
27977 EAPI Evas_Object *elm_navigationbar_add(Evas_Object *parent);
27978 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);
27979 EAPI void elm_navigationbar_pop(Evas_Object *obj);
27980 EAPI void elm_navigationbar_to_content_pop(Evas_Object *obj, Evas_Object *content);
27981 EAPI void elm_navigationbar_title_label_set(Evas_Object *obj, Evas_Object *content, const char *title);
27982 EAPI const char *elm_navigationbar_title_label_get(Evas_Object *obj, Evas_Object *content);
27983 EAPI void elm_navigationbar_title_object_add(Evas_Object *obj, Evas_Object *content, Evas_Object *title_obj);
27984 EAPI Evas_Object *elm_navigationbar_title_object_get(Evas_Object *obj, Evas_Object *content);
27985 EAPI Eina_List *elm_navigationbar_title_object_list_get(Evas_Object *obj, Evas_Object *content);
27986 EAPI Evas_Object *elm_navigationbar_content_top_get(Evas_Object *obj);
27987 EAPI Evas_Object *elm_navigationbar_content_bottom_get(Evas_Object *obj);
27988 EAPI void elm_navigationbar_hidden_set(Evas_Object *obj, Eina_Bool hidden);
27989 EAPI void elm_navigationbar_title_button_set(Evas_Object *obj, Evas_Object *content, Evas_Object *button, Elm_Navi_Button_Type button_type);
27990 EAPI Evas_Object *elm_navigationbar_title_button_get(Evas_Object *obj, Evas_Object *content, Elm_Navi_Button_Type button_type);
27991 EAPI const char *elm_navigationbar_subtitle_label_get(Evas_Object *obj, Evas_Object *content);
27992 EAPI void elm_navigationbar_subtitle_label_set(Evas_Object *obj, Evas_Object *content, const char *subtitle);
27993 EAPI void elm_navigationbar_title_object_list_unset(Evas_Object *obj, Evas_Object *content, Eina_List **list);
27994 EAPI void elm_navigationbar_animation_disabled_set(Evas_Object *obj, Eina_Bool disable);
27995 EAPI void elm_navigationbar_title_object_visible_set(Evas_Object *obj, Evas_Object *content, Eina_Bool visible);
27996 Eina_Bool elm_navigationbar_title_object_visible_get(Evas_Object *obj, Evas_Object *content);
27997 EAPI void elm_navigationbar_title_icon_set(Evas_Object *obj, Evas_Object *content, Evas_Object *icon);
27998 EAPI Evas_Object *elm_navigationbar_title_icon_get(Evas_Object *obj, Evas_Object *content);
28000 /* NavigationBar */
28001 #define NAVIBAR_EX_TITLEOBJ_INSTANT_HIDE "elm,state,hide,noanimate,title", "elm"
28002 #define NAVIBAR_EX_TITLEOBJ_INSTANT_SHOW "elm,state,show,noanimate,title", "elm"
28006 ELM_NAVIGATIONBAR_EX_BACK_BUTTON,
28007 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON1,
28008 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON2,
28009 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON3,
28010 ELM_NAVIGATIONBAR_EX_MAX
28011 } Elm_Navi_ex_Button_Type;
28012 typedef struct _Elm_Navigationbar_ex_Item Elm_Navigationbar_ex_Item;
28014 EAPI Evas_Object *elm_navigationbar_ex_add(Evas_Object *parent);
28015 EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_push(Evas_Object *obj, Evas_Object *content, const char *item_style);
28016 EAPI void elm_navigationbar_ex_item_pop(Evas_Object *obj);
28017 EAPI void elm_navigationbar_ex_item_promote(Elm_Navigationbar_ex_Item* item);
28018 EAPI void elm_navigationbar_ex_to_item_pop(Elm_Navigationbar_ex_Item* item);
28019 EAPI void elm_navigationbar_ex_item_title_label_set(Elm_Navigationbar_ex_Item *item, const char *title);
28020 EAPI const char *elm_navigationbar_ex_item_title_label_get(Elm_Navigationbar_ex_Item* item);
28021 EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_top_get(const Evas_Object *obj);
28022 EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_bottom_get(const Evas_Object *obj);
28023 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);
28024 EAPI Evas_Object *elm_navigationbar_ex_item_title_button_get(Elm_Navigationbar_ex_Item* item, int button_type);
28025 EAPI void elm_navigationbar_ex_item_title_object_set(Elm_Navigationbar_ex_Item* item, Evas_Object *title_obj);
28026 EAPI Evas_Object *elm_navigationbar_ex_item_title_object_unset(Elm_Navigationbar_ex_Item* item);
28027 EAPI void elm_navigationbar_ex_item_title_hidden_set(Elm_Navigationbar_ex_Item* item, Eina_Bool hidden);
28028 EAPI Evas_Object *elm_navigationbar_ex_item_title_object_get(Elm_Navigationbar_ex_Item* item);
28029 EAPI const char *elm_navigationbar_ex_item_subtitle_label_get(Elm_Navigationbar_ex_Item* item);
28030 EAPI void elm_navigationbar_ex_item_subtitle_label_set( Elm_Navigationbar_ex_Item* item, const char *subtitle);
28031 EAPI void elm_navigationbar_ex_item_style_set(Elm_Navigationbar_ex_Item* item, const char* item_style);
28032 EAPI const char *elm_navigationbar_ex_item_style_get(Elm_Navigationbar_ex_Item* item);
28033 EAPI Evas_Object *elm_navigationbar_ex_item_content_unset(Elm_Navigationbar_ex_Item* item);
28034 EAPI Evas_Object *elm_navigationbar_ex_item_content_get(Elm_Navigationbar_ex_Item* item);
28035 EAPI void elm_navigationbar_ex_delete_on_pop_set(Evas_Object *obj, Eina_Bool del_on_pop);
28036 EAPI Evas_Object *elm_navigationbar_ex_item_icon_get(Elm_Navigationbar_ex_Item* item);
28037 EAPI void elm_navigationbar_ex_item_icon_set(Elm_Navigationbar_ex_Item* item, Evas_Object *icon);
28038 EAPI Evas_Object *elm_navigationbar_ex_item_title_button_unset(Elm_Navigationbar_ex_Item* item, int button_type);
28039 EAPI void elm_navigationbar_ex_animation_disable_set(Evas_Object *obj, Eina_Bool disable);
28040 EAPI void elm_navigationbar_ex_title_object_visible_set(Elm_Navigationbar_ex_Item* item, Eina_Bool visible);
28041 Eina_Bool elm_navigationbar_ex_title_object_visible_get(Elm_Navigationbar_ex_Item* item);
28044 #define ELM_NAVIFRAME_ITEM_CONTENT "elm.swallow.content"
28045 #define ELM_NAVIFRAME_ITEM_ICON "elm.swallow.icon"
28046 #define ELM_NAVIFRAME_ITEM_OPTIONHEADER "elm.swallow.optionheader"
28047 #define ELM_NAVIFRAME_ITEM_OPTIONHEADER2 "elm.swallow.optionheader2"
28048 #define ELM_NAVIFRAME_ITEM_TITLE_LABEL "elm.text.title"
28049 #define ELM_NAVIFRAME_ITEM_PREV_BTN "elm.swallow.prev_btn"
28050 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_CLOSE "elm,state,optionheader,close", ""
28051 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_OPEN "elm,state,optionheader,open", ""
28052 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_INSTANT_CLOSE "elm,state,optionheader,instant_close", ""
28053 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_INSTANT_OPEN "elm,state,optionheader,instant_open", ""
28056 * @defgroup Naviframe Naviframe
28058 * @brief Naviframe is a kind of view manager for the applications.
28060 * Naviframe provides functions to switch different pages with stack
28061 * mechanism. It means if one page(item) needs to be changed to the new one,
28062 * then naviframe would push the new page to it's internal stack. Of course,
28063 * it can be back to the previous page by popping the top page. Naviframe
28064 * provides some transition effect while the pages are switching (same as
28067 * Since each item could keep the different styles, users could keep the
28068 * same look & feel for the pages or different styles for the items in it's
28071 * Signals that you can add callback for are:
28073 * @li "transition,finished" - When the transition is finished in changing
28075 * @li "title,clicked" - User clicked title area
28077 * Default contents parts for the naviframe items that you can use for are:
28079 * @li "elm.swallow.content" - The main content of the page
28080 * @li "elm.swallow.prev_btn" - The button to go to the previous page
28081 * @li "elm.swallow.next_btn" - The button to go to the next page
28083 * Default text parts of naviframe items that you can be used are:
28085 * @li "elm.text.title" - The title label in the title area
28087 * @ref tutorial_naviframe gives a good overview of the usage of the API.
28091 * @brief Add a new Naviframe object to the parent.
28093 * @param parent Parent object
28094 * @return New object or @c NULL, if it cannot be created
28096 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28098 * @brief Push a new item to the top of the naviframe stack (and show it).
28100 * @param obj The naviframe object
28101 * @param title_label The label in the title area. The name of the title
28102 * label part is "elm.text.title"
28103 * @param prev_btn The button to go to the previous item. If it is NULL,
28104 * then naviframe will create a back button automatically. The name of
28105 * the prev_btn part is "elm.swallow.prev_btn"
28106 * @param next_btn The button to go to the next item. Or It could be just an
28107 * extra function button. The name of the next_btn part is
28108 * "elm.swallow.next_btn"
28109 * @param content The main content object. The name of content part is
28110 * "elm.swallow.content"
28111 * @param item_style The current item style name. @c NULL would be default.
28112 * @return The created item or @c NULL upon failure.
28114 * The item pushed becomes one page of the naviframe, this item will be
28115 * deleted when it is popped.
28117 * @see also elm_naviframe_item_style_set()
28119 * The following styles are available for this item:
28122 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);
28124 * @brief Pop an item that is on top of the stack
28126 * @param obj The naviframe object
28127 * @return @c NULL or the content object(if the
28128 * elm_naviframe_content_preserve_on_pop_get is true).
28130 * This pops an item that is on the top(visible) of the naviframe, makes it
28131 * disappear, then deletes the item. The item that was underneath it on the
28132 * stack will become visible.
28134 * @see also elm_naviframe_content_preserve_on_pop_get()
28136 * @ingroup Naviframe
28138 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
28140 * @brief Pop the items between the top and the above one on the given item.
28142 * @param it The naviframe item
28144 * @ingroup Naviframe
28146 EAPI void elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28148 * Promote an item already in the naviframe stack to the top of the stack
28150 * @param it The naviframe item
28152 * This will take the indicated item and promote it to the top of the stack
28153 * as if it had been pushed there. The item must already be inside the
28154 * naviframe stack to work.
28157 EAPI void elm_naviframe_item_promote(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28159 * @brief Delete the given item instantly.
28161 * @param it The naviframe item
28163 * This just deletes the given item from the naviframe item list instantly.
28164 * So this would not emit any signals for view transitions but just change
28165 * the current view if the given item is a top one.
28167 * @ingroup Naviframe
28169 EAPI void elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28171 * @brief preserve the content objects when items are popped.
28173 * @param obj The naviframe object
28174 * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
28176 * @see also elm_naviframe_content_preserve_on_pop_get()
28178 * @ingroup Naviframe
28180 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
28182 * @brief Get a value whether preserve mode is enabled or not.
28184 * @param obj The naviframe object
28185 * @return If @c EINA_TRUE, preserve mode is enabled
28187 * @see also elm_naviframe_content_preserve_on_pop_set()
28189 * @ingroup Naviframe
28191 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28193 * @brief Get a top item on the naviframe stack
28195 * @param obj The naviframe object
28196 * @return The top item on the naviframe stack or @c NULL, if the stack is
28199 * @ingroup Naviframe
28201 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28203 * @brief Get a bottom item on the naviframe stack
28205 * @param obj The naviframe object
28206 * @return The bottom item on the naviframe stack or @c NULL, if the stack is
28209 * @ingroup Naviframe
28211 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28213 * @brief Set an item style
28215 * @param obj The naviframe item
28216 * @param item_style The current item style name. @c NULL would be default
28218 * The following styles are available for this item:
28221 * @see also elm_naviframe_item_style_get()
28223 * @ingroup Naviframe
28225 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
28227 * @brief Get an item style
28229 * @param obj The naviframe item
28230 * @return The current item style name
28232 * @see also elm_naviframe_item_style_set()
28234 * @ingroup Naviframe
28236 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28238 * @brief Show/Hide the title area
28240 * @param it The naviframe item
28241 * @param visible If @c EINA_TRUE, title area will be visible, hidden
28244 * When the title area is invisible, then the controls would be hidden so as * to expand the content area to full-size.
28246 * @see also elm_naviframe_item_title_visible_get()
28248 * @ingroup Naviframe
28250 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
28252 * @brief Get a value whether title area is visible or not.
28254 * @param it The naviframe item
28255 * @return If @c EINA_TRUE, title area is visible
28257 * @see also elm_naviframe_item_title_visible_set()
28259 * @ingroup Naviframe
28261 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28264 * @brief Set creating prev button automatically or not
28266 * @param obj The naviframe object
28267 * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
28268 * be created internally when you pass the @c NULL to the prev_btn
28269 * parameter in elm_naviframe_item_push
28271 * @see also elm_naviframe_item_push()
28273 EAPI void elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
28275 * @brief Get a value whether prev button(back button) will be auto pushed or
28278 * @param obj The naviframe object
28279 * @return If @c EINA_TRUE, prev button will be auto pushed.
28281 * @see also elm_naviframe_item_push()
28282 * elm_naviframe_prev_btn_auto_pushed_set()
28284 EAPI Eina_Bool elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
28287 #define CONTROLBAR_SYSTEM_ICON_ALBUMS "controlbar_albums"
28288 #define CONTROLBAR_SYSTEM_ICON_ARTISTS "controlbar_artists"
28289 #define CONTROLBAR_SYSTEM_ICON_SONGS "controlbar_songs"
28290 #define CONTROLBAR_SYSTEM_ICON_PLAYLIST "controlbar_playlist"
28291 #define CONTROLBAR_SYSTEM_ICON_MORE "controlbar_more"
28292 #define CONTROLBAR_SYSTEM_ICON_CONTACTS "controlbar_contacts"
28293 #define CONTROLBAR_SYSTEM_ICON_DIALER "controlbar_dialer"
28294 #define CONTROLBAR_SYSTEM_ICON_FAVORITES "controlbar_favorites"
28295 #define CONTROLBAR_SYSTEM_ICON_LOGS "controlbar_logs"
28297 typedef enum _Elm_Controlbar_Mode_Type
28299 ELM_CONTROLBAR_MODE_DEFAULT = 0,
28300 ELM_CONTROLBAR_MODE_TRANSLUCENCE,
28301 ELM_CONTROLBAR_MODE_TRANSPARENCY,
28302 ELM_CONTROLBAR_MODE_LARGE,
28303 ELM_CONTROLBAR_MODE_SMALL,
28304 ELM_CONTROLBAR_MODE_LEFT,
28305 ELM_CONTROLBAR_MODE_RIGHT
28306 } Elm_Controlbar_Mode_Type;
28308 typedef struct _Elm_Controlbar_Item Elm_Controlbar_Item;
28309 EAPI Evas_Object *elm_controlbar_add(Evas_Object *parent);
28310 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_append(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
28311 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_prepend(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
28312 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);
28313 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);
28314 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);
28315 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);
28316 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);
28317 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);
28318 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_append(Evas_Object *obj, Evas_Object *obj_item, const int sel);
28319 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_prepend(Evas_Object *obj, Evas_Object *obj_item, const int sel);
28320 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_before(Evas_Object *obj, Elm_Controlbar_Item *before, Evas_Object *obj_item, const int sel);
28321 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_after(Evas_Object *obj, Elm_Controlbar_Item *after, Evas_Object *obj_item, const int sel);
28322 EAPI Evas_Object *elm_controlbar_object_item_object_get(const Elm_Controlbar_Item *it);
28323 EAPI void elm_controlbar_item_del(Elm_Controlbar_Item *it);
28324 EAPI void elm_controlbar_item_select(Elm_Controlbar_Item *it);
28325 EAPI void elm_controlbar_item_visible_set(Elm_Controlbar_Item *it, Eina_Bool bar);
28326 EAPI Eina_Bool elm_controlbar_item_visible_get(const Elm_Controlbar_Item * it);
28327 EAPI void elm_controlbar_item_disabled_set(Elm_Controlbar_Item * it, Eina_Bool disabled);
28328 EAPI Eina_Bool elm_controlbar_item_disabled_get(const Elm_Controlbar_Item * it);
28329 EAPI void elm_controlbar_item_icon_set(Elm_Controlbar_Item *it, const char *icon_path);
28330 EAPI Evas_Object *elm_controlbar_item_icon_get(const Elm_Controlbar_Item *it);
28331 EAPI void elm_controlbar_item_label_set(Elm_Controlbar_Item *it, const char *label);
28332 EAPI const char *elm_controlbar_item_label_get(const Elm_Controlbar_Item *it);
28333 EAPI Elm_Controlbar_Item *elm_controlbar_selected_item_get(const Evas_Object *obj);
28334 EAPI Elm_Controlbar_Item *elm_controlbar_first_item_get(const Evas_Object *obj);
28335 EAPI Elm_Controlbar_Item *elm_controlbar_last_item_get(const Evas_Object *obj);
28336 EAPI const Eina_List *elm_controlbar_items_get(const Evas_Object *obj);
28337 EAPI Elm_Controlbar_Item *elm_controlbar_item_prev(Elm_Controlbar_Item *it);
28338 EAPI Elm_Controlbar_Item *elm_controlbar_item_next(Elm_Controlbar_Item *it);
28339 EAPI void elm_controlbar_item_view_set(Elm_Controlbar_Item *it, Evas_Object * view);
28340 EAPI Evas_Object *elm_controlbar_item_view_get(const Elm_Controlbar_Item *it);
28341 EAPI Evas_Object *elm_controlbar_item_view_unset(Elm_Controlbar_Item *it);
28342 EAPI Evas_Object *elm_controlbar_item_button_get(const Elm_Controlbar_Item *it);
28343 EAPI void elm_controlbar_mode_set(Evas_Object *obj, int mode);
28344 EAPI void elm_controlbar_alpha_set(Evas_Object *obj, int alpha);
28345 EAPI void elm_controlbar_item_auto_align_set(Evas_Object *obj, Eina_Bool auto_align);
28346 EAPI void elm_controlbar_vertical_set(Evas_Object *obj, Eina_Bool vertical);
28349 EAPI Evas_Object *elm_searchbar_add(Evas_Object *parent);
28350 EAPI void elm_searchbar_text_set(Evas_Object *obj, const char *entry);
28351 EAPI const char *elm_searchbar_text_get(Evas_Object *obj);
28352 EAPI Evas_Object *elm_searchbar_entry_get(Evas_Object *obj);
28353 EAPI Evas_Object *elm_searchbar_editfield_get(Evas_Object *obj);
28354 EAPI void elm_searchbar_cancel_button_animation_set(Evas_Object *obj, Eina_Bool cancel_btn_ani_flag);
28355 EAPI void elm_searchbar_cancel_button_set(Evas_Object *obj, Eina_Bool visible);
28356 EAPI void elm_searchbar_clear(Evas_Object *obj);
28357 EAPI void elm_searchbar_boundary_rect_set(Evas_Object *obj, Eina_Bool boundary);
28359 EAPI Evas_Object *elm_page_control_add(Evas_Object *parent);
28360 EAPI void elm_page_control_page_count_set(Evas_Object *obj, unsigned int page_count);
28361 EAPI void elm_page_control_page_id_set(Evas_Object *obj, unsigned int page_id);
28362 EAPI unsigned int elm_page_control_page_id_get(Evas_Object *obj);
28365 EAPI Evas_Object *elm_nocontents_add(Evas_Object *parent);
28366 EAPI void elm_nocontents_label_set(Evas_Object *obj, const char *label);
28367 EAPI const char *elm_nocontents_label_get(const Evas_Object *obj);
28368 EAPI void elm_nocontents_custom_set(const Evas_Object *obj, Evas_Object *custom);
28369 EAPI Evas_Object *elm_nocontents_custom_get(const Evas_Object *obj);
28374 ELM_TICKERNOTI_ORIENT_TOP = 0,
28375 ELM_TICKERNOTI_ORIENT_BOTTOM,
28376 ELM_TICKERNOTI_ORIENT_LAST
28377 } Elm_Tickernoti_Orient;
28379 EAPI Evas_Object *elm_tickernoti_add (Evas_Object *parent);
28380 EAPI void elm_tickernoti_orient_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
28381 EAPI Elm_Tickernoti_Orient elm_tickernoti_orient_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28382 EAPI int elm_tickernoti_rotation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28383 EAPI void elm_tickernoti_rotation_set (Evas_Object *obj, int angle) EINA_ARG_NONNULL(1);
28384 EAPI Evas_Object *elm_tickernoti_win_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28385 /* #### Below APIs and data structures are going to be deprecated, announcment will be made soon ####*/
28388 ELM_TICKERNOTI_DEFAULT,
28389 ELM_TICKERNOTI_DETAILVIEW
28390 } Elm_Tickernoti_Mode;
28391 EAPI void elm_tickernoti_detailview_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
28392 EAPI const char *elm_tickernoti_detailview_label_get (const Evas_Object *obj)EINA_ARG_NONNULL(1);
28393 EAPI void elm_tickernoti_detailview_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(2);
28394 EAPI Evas_Object *elm_tickernoti_detailview_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28395 EAPI void elm_tickernoti_detailview_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
28396 EAPI Evas_Object *elm_tickernoti_detailview_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28397 EAPI Evas_Object *elm_tickernoti_detailview_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28398 EAPI void elm_tickernoti_mode_set (Evas_Object *obj, Elm_Tickernoti_Mode mode) EINA_ARG_NONNULL(1);
28399 EAPI Elm_Tickernoti_Mode elm_tickernoti_mode_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28400 EAPI void elm_tickernoti_orientation_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
28401 EAPI Elm_Tickernoti_Orient elm_tickernoti_orientation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28402 EAPI void elm_tickernoti_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
28403 EAPI const char *elm_tickernoti_label_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28404 EAPI void elm_tickernoti_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
28405 EAPI Evas_Object *elm_tickernoti_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28406 EAPI void elm_tickernoti_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(1);
28407 EAPI Evas_Object *elm_tickernoti_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28408 /* ############################################################################### */
28410 * Parts which can be used with elm_object_text_part_set() and
28411 * elm_object_text_part_get():
28413 * @li NULL/"default" - Operates on tickernoti content-text
28415 * Parts which can be used with elm_object_content_part_set() and
28416 * elm_object_content_part_get():
28418 * @li "icon" - Operates on tickernoti's icon
28419 * @li "button" - Operates on tickernoti's button
28421 * smart callbacks called:
28422 * @li "clicked" - emitted when tickernoti is clicked, except at the
28423 * swallow/button region, if any.
28424 * @li "hide" - emitted when the tickernoti is completely hidden. In case of
28425 * any hide animation, this signal is emitted after the animation.
28429 typedef struct _Colorpalette_Color Elm_Colorpalette_Color;
28431 struct _Colorpalette_Color
28433 unsigned int r, g, b;
28436 EAPI Evas_Object *elm_colorpalette_add(Evas_Object *parent);
28437 EAPI void elm_colorpalette_color_set(Evas_Object *obj, int color_num, Elm_Colorpalette_Color *color);
28438 EAPI void elm_colorpalette_row_column_set(Evas_Object *obj, int row, int col);
28439 /* smart callbacks called:
28440 * "clicked" - when image clicked
28444 EAPI Evas_Object *elm_editfield_add(Evas_Object *parent);
28445 EAPI void elm_editfield_label_set(Evas_Object *obj, const char *label);
28446 EAPI const char *elm_editfield_label_get(Evas_Object *obj);
28447 EAPI void elm_editfield_guide_text_set(Evas_Object *obj, const char *text);
28448 EAPI const char *elm_editfield_guide_text_get(Evas_Object *obj);
28449 EAPI Evas_Object *elm_editfield_entry_get(Evas_Object *obj);
28450 // EAPI Evas_Object *elm_editfield_clear_button_show(Evas_Object *obj, Eina_Bool show);
28451 EAPI void elm_editfield_right_icon_set(Evas_Object *obj, Evas_Object *icon);
28452 EAPI Evas_Object *elm_editfield_right_icon_get(Evas_Object *obj);
28453 EAPI void elm_editfield_left_icon_set(Evas_Object *obj, Evas_Object *icon);
28454 EAPI Evas_Object *elm_editfield_left_icon_get(Evas_Object *obj);
28455 EAPI void elm_editfield_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line);
28456 EAPI Eina_Bool elm_editfield_entry_single_line_get(Evas_Object *obj);
28457 EAPI void elm_editfield_eraser_set(Evas_Object *obj, Eina_Bool visible);
28458 EAPI Eina_Bool elm_editfield_eraser_get(Evas_Object *obj);
28459 /* smart callbacks called:
28460 * "clicked" - when an editfield is clicked
28461 * "unfocused" - when an editfield is unfocused
28465 /* Sliding Drawer */
28466 typedef enum _Elm_SlidingDrawer_Pos
28468 ELM_SLIDINGDRAWER_BOTTOM,
28469 ELM_SLIDINGDRAWER_LEFT,
28470 ELM_SLIDINGDRAWER_RIGHT,
28471 ELM_SLIDINGDRAWER_TOP
28472 } Elm_SlidingDrawer_Pos;
28474 typedef struct _Elm_SlidingDrawer_Drag_Value
28477 } Elm_SlidingDrawer_Drag_Value;
28479 EINA_DEPRECATED EAPI Evas_Object *elm_slidingdrawer_add(Evas_Object *parent);
28480 EINA_DEPRECATED EAPI void elm_slidingdrawer_content_set (Evas_Object *obj, Evas_Object *content);
28481 EINA_DEPRECATED EAPI Evas_Object *elm_slidingdrawer_content_unset(Evas_Object *obj);
28482 EINA_DEPRECATED EAPI void elm_slidingdrawer_pos_set(Evas_Object *obj, Elm_SlidingDrawer_Pos pos);
28483 EINA_DEPRECATED EAPI void elm_slidingdrawer_max_drag_value_set(Evas_Object *obj, double dw, double dh);
28484 EINA_DEPRECATED EAPI void elm_slidingdrawer_drag_value_set(Evas_Object *obj, double dx, double dy);
28486 /* multibuttonentry */
28487 typedef struct _Multibuttonentry_Item Elm_Multibuttonentry_Item;
28488 typedef Eina_Bool (*Elm_Multibuttonentry_Item_Verify_Callback) (Evas_Object *obj, const char *item_label, void *item_data, void *data);
28489 EAPI Evas_Object *elm_multibuttonentry_add(Evas_Object *parent);
28490 EAPI const char *elm_multibuttonentry_label_get(Evas_Object *obj);
28491 EAPI void elm_multibuttonentry_label_set(Evas_Object *obj, const char *label);
28492 EAPI Evas_Object *elm_multibuttonentry_entry_get(Evas_Object *obj);
28493 EAPI const char * elm_multibuttonentry_guide_text_get(Evas_Object *obj);
28494 EAPI void elm_multibuttonentry_guide_text_set(Evas_Object *obj, const char *guidetext);
28495 EAPI int elm_multibuttonentry_contracted_state_get(Evas_Object *obj);
28496 EAPI void elm_multibuttonentry_contracted_state_set(Evas_Object *obj, int contracted);
28497 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_start(Evas_Object *obj, const char *label, void *data);
28498 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_end(Evas_Object *obj, const char *label, void *data);
28499 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_before(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *before, void *data);
28500 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_after(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *after, void *data);
28501 EAPI const Eina_List *elm_multibuttonentry_items_get(Evas_Object *obj);
28502 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_first_get(Evas_Object *obj);
28503 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_last_get(Evas_Object *obj);
28504 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_selected_get(Evas_Object *obj);
28505 EAPI void elm_multibuttonentry_item_selected_set(Elm_Multibuttonentry_Item *item);
28506 EAPI void elm_multibuttonentry_item_unselect_all(Evas_Object *obj);
28507 EAPI void elm_multibuttonentry_item_del(Elm_Multibuttonentry_Item *item);
28508 EAPI void elm_multibuttonentry_items_del(Evas_Object *obj);
28509 EAPI const char *elm_multibuttonentry_item_label_get(Elm_Multibuttonentry_Item *item);
28510 EAPI void elm_multibuttonentry_item_label_set(Elm_Multibuttonentry_Item *item, const char *str);
28511 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prev(Elm_Multibuttonentry_Item *item);
28512 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_next(Elm_Multibuttonentry_Item *item);
28513 EAPI void *elm_multibuttonentry_item_data_get(Elm_Multibuttonentry_Item *item);
28514 EAPI void elm_multibuttonentry_item_data_set(Elm_Multibuttonentry_Item *item, void *data);
28515 EAPI void elm_multibuttonentry_item_verify_callback_set(Evas_Object *obj, Elm_Multibuttonentry_Item_Verify_Callback func, void *data);
28516 /* smart callback called:
28517 * "selected" - This signal is emitted when the selected item of multibuttonentry is changed.
28518 * "added" - This signal is emitted when a new multibuttonentry item is added.
28519 * "deleted" - This signal is emitted when a multibuttonentry item is deleted.
28520 * "expanded" - This signal is emitted when a multibuttonentry is expanded.
28521 * "contracted" - This signal is emitted when a multibuttonentry is contracted.
28522 * "contracted,state,changed" - This signal is emitted when the contracted state of multibuttonentry is changed.
28523 * "item,selected" - This signal is emitted when the selected item of multibuttonentry is changed.
28524 * "item,added" - This signal is emitted when a new multibuttonentry item is added.
28525 * "item,deleted" - This signal is emitted when a multibuttonentry item is deleted.
28526 * "item,clicked" - This signal is emitted when a multibuttonentry item is clicked.
28527 * "clicked" - This signal is emitted when a multibuttonentry is clicked.
28528 * "unfocused" - This signal is emitted when a multibuttonentry is unfocused.
28530 /* available styles:
28535 typedef struct _Stackedicon_Item Elm_Stackedicon_Item;
28536 EAPI Evas_Object *elm_stackedicon_add(Evas_Object *parent);
28537 EAPI Elm_Stackedicon_Item *elm_stackedicon_item_append(Evas_Object *obj, const char *path);
28538 EAPI Elm_Stackedicon_Item *elm_stackedicon_item_prepend(Evas_Object *obj, const char *path);
28539 EAPI void elm_stackedicon_item_del(Elm_Stackedicon_Item *it);
28540 EAPI Eina_List *elm_stackedicon_item_list_get(Evas_Object *obj);
28541 /* smart callback called:
28542 * "expanded" - This signal is emitted when a stackedicon is expanded.
28543 * "clicked" - This signal is emitted when a stackedicon is clicked.
28545 /* available styles:
28549 /* dialoguegroup */
28550 typedef struct _Dialogue_Item Dialogue_Item;
28552 typedef enum _Elm_Dialoguegourp_Item_Style
28554 ELM_DIALOGUEGROUP_ITEM_STYLE_DEFAULT = 0,
28555 ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD = (1 << 0),
28556 ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD_WITH_TITLE = (1 << 1),
28557 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_TITLE = (1 << 2),
28558 ELM_DIALOGUEGROUP_ITEM_STYLE_HIDDEN = (1 << 3),
28559 ELM_DIALOGUEGROUP_ITEM_STYLE_DATAVIEW = (1 << 4),
28560 ELM_DIALOGUEGROUP_ITEM_STYLE_NO_BG = (1 << 5),
28561 ELM_DIALOGUEGROUP_ITEM_STYLE_SUB = (1 << 6),
28562 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT = (1 << 7),
28563 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_MERGE = (1 << 8),
28564 ELM_DIALOGUEGROUP_ITEM_STYLE_LAST = (1 << 9)
28565 } Elm_Dialoguegroup_Item_Style;
28567 EINA_DEPRECATED EAPI Evas_Object *elm_dialoguegroup_add(Evas_Object *parent);
28568 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_append(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
28569 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_prepend(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
28570 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_after(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *after, Elm_Dialoguegroup_Item_Style style);
28571 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_before(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *before, Elm_Dialoguegroup_Item_Style style);
28572 EINA_DEPRECATED EAPI void elm_dialoguegroup_remove(Dialogue_Item *item);
28573 EINA_DEPRECATED EAPI void elm_dialoguegroup_remove_all(Evas_Object *obj);
28574 EINA_DEPRECATED EAPI void elm_dialoguegroup_title_set(Evas_Object *obj, const char *title);
28575 EINA_DEPRECATED EAPI const char *elm_dialoguegroup_title_get(Evas_Object *obj);
28576 EINA_DEPRECATED EAPI void elm_dialoguegroup_press_effect_set(Dialogue_Item *item, Eina_Bool press);
28577 EINA_DEPRECATED EAPI Eina_Bool elm_dialoguegroup_press_effect_get(Dialogue_Item *item);
28578 EINA_DEPRECATED EAPI Evas_Object *elm_dialoguegroup_item_content_get(Dialogue_Item *item);
28579 EINA_DEPRECATED EAPI void elm_dialoguegroup_item_style_set(Dialogue_Item *item, Elm_Dialoguegroup_Item_Style style);
28580 EINA_DEPRECATED EAPI Elm_Dialoguegroup_Item_Style elm_dialoguegroup_item_style_get(Dialogue_Item *item);
28581 EINA_DEPRECATED EAPI void elm_dialoguegroup_item_disabled_set(Dialogue_Item *item, Eina_Bool disabled);
28582 EINA_DEPRECATED EAPI Eina_Bool elm_dialoguegroup_item_disabled_get(Dialogue_Item *item);
28587 ELM_DAYSELECTOR_SUN,
28588 ELM_DAYSELECTOR_MON,
28589 ELM_DAYSELECTOR_TUE,
28590 ELM_DAYSELECTOR_WED,
28591 ELM_DAYSELECTOR_THU,
28592 ELM_DAYSELECTOR_FRI,
28593 ELM_DAYSELECTOR_SAT
28594 } Elm_DaySelector_Day;
28596 EAPI Evas_Object *elm_dayselector_add(Evas_Object *parent);
28597 EAPI Eina_Bool elm_dayselector_check_state_get(Evas_Object *obj, Elm_DaySelector_Day day);
28598 EAPI void elm_dayselector_check_state_set(Evas_Object *obj, Elm_DaySelector_Day day, Eina_Bool checked);
28601 typedef struct _Imageslider_Item Elm_Imageslider_Item;
28602 typedef void (*Elm_Imageslider_Cb)(void *data, Evas_Object *obj, void *event_info);
28603 EAPI Evas_Object *elm_imageslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28604 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);
28605 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);
28606 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);
28607 EAPI void elm_imageslider_item_del(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
28608 EAPI Elm_Imageslider_Item *elm_imageslider_selected_item_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
28609 EAPI Eina_Bool elm_imageslider_item_selected_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
28610 EAPI void elm_imageslider_item_selected_set(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
28611 EAPI const char *elm_imageslider_item_photo_file_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
28612 EAPI Elm_Imageslider_Item *elm_imageslider_item_prev(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
28613 EAPI Elm_Imageslider_Item *elm_imageslider_item_next(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
28614 EAPI void elm_imageslider_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
28615 EAPI void elm_imageslider_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
28616 EAPI void elm_imageslider_item_photo_file_set(Elm_Imageslider_Item *it, const char *photo_file) EINA_ARG_NONNULL(1,2);
28617 EAPI void elm_imageslider_item_update(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);