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 in which the widgets will be
35 @section license License
37 LGPL v2 (see COPYING in the base of Elementary's source). This applies to
38 all files in the source tree.
40 @section ack Acknowledgements
41 There is a lot that goes into making a widget set, and they don't happen out of
42 nothing. It's like trying to make everyone everywhere happy, regardless of age,
43 gender, race or nationality - and that is really tough. So thanks to people and
44 organisations behind this, as listed in the @ref authors page.
49 * @defgroup Start Getting Started
51 * To write an Elementary app, you can get started with the following:
54 #include <Elementary.h>
56 elm_main(int argc, char **argv)
58 // create window(s) here and do any application init
59 elm_run(); // run main loop
60 elm_shutdown(); // after mainloop finishes running, shutdown
61 return 0; // exit 0 for exit code
66 * To use autotools (which helps in many ways in the long run, like being able
67 * to immediately create releases of your software directly from your tree
68 * and ensure everything needed to build it is there) you will need a
69 * configure.ac, Makefile.am and autogen.sh file.
74 AC_INIT(myapp, 0.0.0, myname@mydomain.com)
76 AC_CONFIG_SRCDIR(configure.ac)
77 AM_CONFIG_HEADER(config.h)
79 AM_INIT_AUTOMAKE(1.6 dist-bzip2)
80 PKG_CHECK_MODULES([ELEMENTARY], elementary)
87 AUTOMAKE_OPTIONS = 1.4 foreign
88 MAINTAINERCLEANFILES = Makefile.in aclocal.m4 config.h.in configure depcomp install-sh missing
90 INCLUDES = -I$(top_srcdir)
94 myapp_SOURCES = main.c
95 myapp_LDADD = @ELEMENTARY_LIBS@
96 myapp_CFLAGS = @ELEMENTARY_CFLAGS@
103 echo "Running aclocal..." ; aclocal $ACLOCAL_FLAGS || exit 1
104 echo "Running autoheader..." ; autoheader || exit 1
105 echo "Running autoconf..." ; autoconf || exit 1
106 echo "Running automake..." ; automake --add-missing --copy --gnu || exit 1
110 * To generate all the things needed to bootstrap just run:
116 * This will generate Makefile.in's, the confgure script and everything else.
117 * After this it works like all normal autotools projects:
124 * Note sudo was assumed to get root permissions, as this would install in
125 * /usr/local which is system-owned. Use any way you like to gain root, or
126 * specify a different prefix with configure:
129 ./confiugre --prefix=$HOME/mysoftware
132 * Also remember that autotools buys you some useful commands like:
137 * This uninstalls the software after it was installed with "make install".
138 * It is very useful to clear up what you built if you wish to clean the
145 * This firstly checks if your build tree is "clean" and ready for
146 * distribution. It also builds a tarball (myapp-0.0.0.tar.gz) that is
147 * ready to upload and distribute to the world, that contains the generated
148 * Makefile.in's and configure script. The users do not need to run
149 * autogen.sh - just configure and on. They don't need autotools installed.
150 * This tarball also builds cleanly, has all the sources it needs to build
151 * included (that is sources for your application, not libraries it depends
152 * on like Elementary). It builds cleanly in a buildroot and does not
153 * contain any files that are temporarily generated like binaries and other
154 * build-generated files, so the tarball is clean, and no need to worry
155 * about cleaning up your tree before packaging.
161 * This cleans up all build files (binaries, objects etc.) from the tree.
167 * This cleans out all files from the build and from configure's output too.
170 make maintainer-clean
173 * This deletes all the files autogen.sh will produce so the tree is clean
174 * to be put into a revision-control system (like CVS, SVN or GIT for example).
176 * There is a more advanced way of making use of the quicklaunch infrastructure
177 * in Elementary (which will not be covered here due to its more advanced
180 * Now let's actually create an interactive "Hello World" gui that you can
181 * click the ok button to exit. It's more code because this now does something
182 * much more significant, but it's still very simple:
185 #include <Elementary.h>
188 on_done(void *data, Evas_Object *obj, void *event_info)
190 // quit the mainloop (elm_run function will return)
195 elm_main(int argc, char **argv)
197 Evas_Object *win, *bg, *box, *lab, *btn;
199 // new window - do the usual and give it a name, title and delete handler
200 win = elm_win_add(NULL, "hello", ELM_WIN_BASIC);
201 elm_win_title_set(win, "Hello");
202 // when the user clicks "close" on a window there is a request to delete
203 evas_object_smart_callback_add(win, "delete,request", on_done, NULL);
206 bg = elm_bg_add(win);
207 // add object as a resize object for the window (controls window minimum
208 // size as well as gets resized if window is resized)
209 elm_win_resize_object_add(win, bg);
210 evas_object_show(bg);
212 // add a box object - default is vertical. a box holds children in a row,
213 // either horizontally or vertically. nothing more.
214 box = elm_box_add(win);
215 // make the box hotizontal
216 elm_box_horizontal_set(box, EINA_TRUE);
217 // add object as a resize object for the window (controls window minimum
218 // size as well as gets resized if window is resized)
219 elm_win_resize_object_add(win, box);
220 evas_object_show(box);
222 // add a label widget, set the text and put it in the pad frame
223 lab = elm_label_add(win);
224 // set default text of the label
225 elm_object_text_set(lab, "Hello out there world!");
226 // pack the label at the end of the box
227 elm_box_pack_end(box, lab);
228 evas_object_show(lab);
231 btn = elm_button_add(win);
232 // set default text of button to "OK"
233 elm_object_text_set(btn, "OK");
234 // pack the button at the end of the box
235 elm_box_pack_end(box, btn);
236 evas_object_show(btn);
237 // call on_done when button is clicked
238 evas_object_smart_callback_add(btn, "clicked", on_done, NULL);
240 // now we are done, show the window
241 evas_object_show(win);
243 // run the mainloop and process events and callbacks
253 @page authors Authors
254 @author Carsten Haitzler <raster@@rasterman.com>
255 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
256 @author Cedric Bail <cedric.bail@@free.fr>
257 @author Vincent Torri <vtorri@@univ-evry.fr>
258 @author Daniel Kolesa <quaker66@@gmail.com>
259 @author Jaime Thomas <avi.thomas@@gmail.com>
260 @author Swisscom - http://www.swisscom.ch/
261 @author Christopher Michael <devilhorns@@comcast.net>
262 @author Marco Trevisan (Treviño) <mail@@3v1n0.net>
263 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
264 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
265 @author Brian Wang <brian.wang.0721@@gmail.com>
266 @author Mike Blumenkrantz (zmike) <mike@@zentific.com>
267 @author Samsung Electronics <tbd>
268 @author Samsung SAIT <tbd>
269 @author Brett Nash <nash@@nash.id.au>
270 @author Bruno Dilly <bdilly@@profusion.mobi>
271 @author Rafael Fonseca <rfonseca@@profusion.mobi>
272 @author Chuneon Park <hermet@@hermet.pe.kr>
273 @author Woohyun Jung <wh0705.jung@@samsung.com>
274 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
275 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
276 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
277 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
278 @author Gustavo Lima Chaves <glima@@profusion.mobi>
279 @author Fabiano Fidêncio <fidencio@@profusion.mobi>
280 @author Tiago Falcão <tiago@@profusion.mobi>
281 @author Otavio Pontes <otavio@@profusion.mobi>
282 @author Viktor Kojouharov <vkojouharov@@gmail.com>
283 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
284 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
285 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
286 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
287 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
288 @author Jihoon Kim <jihoon48.kim@@samsung.com>
289 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
290 @author Tom Hacohen <tom@@stosb.com>
291 @author Aharon Hillel <a.hillel@@partner.samsung.com>
292 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
293 @author Shinwoo Kim <kimcinoo@@gmail.com>
294 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
295 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
296 @author Sung W. Park <sungwoo@gmail.com>
297 @author Thierry el Borgi <thierry@substantiel.fr>
298 @author Shilpa Singh <shilpa.singh@samsung.com> <shilpasingh.o@gmail.com>
299 @author Chanwook Jung <joey.jung@samsung.com>
300 @author Hyoyoung Chang <hyoyoung.chang@samsung.com>
301 @author Guillaume "Kuri" Friloux <guillaume.friloux@asp64.com>
302 @author Kim Yunhan <spbear@gmail.com>
304 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
305 contact with the developers and maintainers.
313 * @brief Elementary's API
318 @ELM_UNIX_DEF@ ELM_UNIX
319 @ELM_WIN32_DEF@ ELM_WIN32
320 @ELM_WINCE_DEF@ ELM_WINCE
321 @ELM_EDBUS_DEF@ ELM_EDBUS
322 @ELM_EFREET_DEF@ ELM_EFREET
323 @ELM_ETHUMB_DEF@ ELM_ETHUMB
324 @ELM_WEB_DEF@ ELM_WEB
325 @ELM_EMAP_DEF@ ELM_EMAP
326 @ELM_DEBUG_DEF@ ELM_DEBUG
327 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
328 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
330 /* Standard headers for standard system calls etc. */
335 #include <sys/types.h>
336 #include <sys/stat.h>
337 #include <sys/time.h>
338 #include <sys/param.h>
351 # ifdef ELM_LIBINTL_H
352 # include <libintl.h>
363 #if defined (ELM_WIN32) || defined (ELM_WINCE)
366 # define alloca _alloca
377 #include <Ecore_Evas.h>
378 #include <Ecore_File.h>
379 #include <Ecore_IMF.h>
380 #include <Ecore_Con.h>
389 # include <Efreet_Mime.h>
390 # include <Efreet_Trash.h>
394 # include <Ethumb_Client.h>
406 # ifdef ELEMENTARY_BUILD
408 # define EAPI __declspec(dllexport)
411 # endif /* ! DLL_EXPORT */
413 # define EAPI __declspec(dllimport)
414 # endif /* ! EFL_EVAS_BUILD */
418 # define EAPI __attribute__ ((visibility("default")))
425 #endif /* ! _WIN32 */
430 # define EAPI_MAIN EAPI
433 /* allow usage from c++ */
438 #define ELM_VERSION_MAJOR @VMAJ@
439 #define ELM_VERSION_MINOR @VMIN@
441 typedef struct _Elm_Version
449 EAPI extern Elm_Version *elm_version;
452 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
453 #define ELM_PI 3.14159265358979323846
456 * @defgroup General General
458 * @brief General Elementary API. Functions that don't relate to
459 * Elementary objects specifically.
461 * Here are documented functions which init/shutdown the library,
462 * that apply to generic Elementary objects, that deal with
463 * configuration, et cetera.
465 * @ref general_functions_example_page "This" example contemplates
466 * some of these functions.
470 * @addtogroup General
475 * Defines couple of standard Evas_Object layers to be used
476 * with evas_object_layer_set().
478 * @note whenever extending with new values, try to keep some padding
479 * to siblings so there is room for further extensions.
481 typedef enum _Elm_Object_Layer
483 ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
484 ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
485 ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
486 ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
487 ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
488 ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
491 /**************************************************************************/
492 EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
495 * Emitted when any Elementary's policy value is changed.
497 EAPI extern int ELM_EVENT_POLICY_CHANGED;
500 * @typedef Elm_Event_Policy_Changed
502 * Data on the event when an Elementary policy has changed
504 typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
507 * @struct _Elm_Event_Policy_Changed
509 * Data on the event when an Elementary policy has changed
511 struct _Elm_Event_Policy_Changed
513 unsigned int policy; /**< the policy identifier */
514 int new_value; /**< value the policy had before the change */
515 int old_value; /**< new value the policy got */
519 * Policy identifiers.
521 typedef enum _Elm_Policy
523 ELM_POLICY_QUIT, /**< under which circumstances the application
524 * should quit automatically. @see
528 } Elm_Policy; /**< Elementary policy identifiers/groups enumeration. @see elm_policy_set()
531 typedef enum _Elm_Policy_Quit
533 ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
535 ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
537 * window is closed */
538 } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
540 typedef enum _Elm_Focus_Direction
544 } Elm_Focus_Direction;
546 typedef enum _Elm_Text_Format
548 ELM_TEXT_FORMAT_PLAIN_UTF8,
549 ELM_TEXT_FORMAT_MARKUP_UTF8
553 * Line wrapping types.
555 typedef enum _Elm_Wrap_Type
557 ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
558 ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
559 ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
560 ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
566 ELM_INPUT_PANEL_LAYOUT_NORMAL, /**< Default layout */
567 ELM_INPUT_PANEL_LAYOUT_NUMBER, /**< Number layout */
568 ELM_INPUT_PANEL_LAYOUT_EMAIL, /**< Email layout */
569 ELM_INPUT_PANEL_LAYOUT_URL, /**< URL layout */
570 ELM_INPUT_PANEL_LAYOUT_PHONENUMBER, /**< Phone Number layout */
571 ELM_INPUT_PANEL_LAYOUT_IP, /**< IP layout */
572 ELM_INPUT_PANEL_LAYOUT_MONTH, /**< Month layout */
573 ELM_INPUT_PANEL_LAYOUT_NUMBERONLY, /**< Number Only layout */
574 ELM_INPUT_PANEL_LAYOUT_INVALID
575 } Elm_Input_Panel_Layout;
578 * @typedef Elm_Object_Item
579 * An Elementary Object item handle.
582 typedef struct _Elm_Object_Item Elm_Object_Item;
586 * Called back when a widget's tooltip is activated and needs content.
587 * @param data user-data given to elm_object_tooltip_content_cb_set()
588 * @param obj owner widget.
589 * @param tooltip The tooltip object (affix content to this!)
591 typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip);
594 * Called back when a widget's item tooltip is activated and needs content.
595 * @param data user-data given to elm_object_tooltip_content_cb_set()
596 * @param obj owner widget.
597 * @param tooltip The tooltip object (affix content to this!)
598 * @param item context dependent item. As an example, if tooltip was
599 * set on Elm_List_Item, then it is of this type.
601 typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
603 typedef Eina_Bool (*Elm_Event_Cb) (void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info); /**< Function prototype definition for callbacks on input events happening on Elementary widgets. @a data will receive the user data pointer passed to elm_object_event_callback_add(). @a src will be a pointer to the widget on which the input event took place. @a type will get the type of this event and @a event_info, the struct with details on this event. */
605 #ifndef ELM_LIB_QUICKLAUNCH
606 #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 */
608 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
611 /**************************************************************************/
615 * Initialize Elementary
617 * @param[in] argc System's argument count value
618 * @param[in] argv System's pointer to array of argument strings
619 * @return The init counter value.
621 * This function initializes Elementary and increments a counter of
622 * the number of calls to it. It returns the new counter's value.
624 * @warning This call is exported only for use by the @c ELM_MAIN()
625 * macro. There is no need to use this if you use this macro (which
626 * is highly advisable). An elm_main() should contain the entry
627 * point code for your application, having the same prototype as
628 * elm_init(), and @b not being static (putting the @c EAPI symbol
629 * in front of its type declaration is advisable). The @c
630 * ELM_MAIN() call should be placed just after it.
633 * @dontinclude bg_example_01.c
637 * See the full @ref bg_example_01_c "example".
639 * @see elm_shutdown().
642 EAPI int elm_init(int argc, char **argv);
645 * Shut down Elementary
647 * @return The init counter value.
649 * This should be called at the end of your application, just
650 * before it ceases to do any more processing. This will clean up
651 * any permanent resources your application may have allocated via
652 * Elementary that would otherwise persist.
654 * @see elm_init() for an example
658 EAPI int elm_shutdown(void);
661 * Run Elementary's main loop
663 * This call should be issued just after all initialization is
664 * completed. This function will not return until elm_exit() is
665 * called. It will keep looping, running the main
666 * (event/processing) loop for Elementary.
668 * @see elm_init() for an example
672 EAPI void elm_run(void);
675 * Exit Elementary's main loop
677 * If this call is issued, it will flag the main loop to cease
678 * processing and return back to its parent function (usually your
679 * elm_main() function).
681 * @see elm_init() for an example. There, just after a request to
682 * close the window comes, the main loop will be left.
684 * @note By using the #ELM_POLICY_QUIT on your Elementary
685 * applications, you'll this function called automatically for you.
689 EAPI void elm_exit(void);
692 * Provide information in order to make Elementary determine the @b
693 * run time location of the software in question, so other data files
694 * such as images, sound files, executable utilities, libraries,
695 * modules and locale files can be found.
697 * @param mainfunc This is your application's main function name,
698 * whose binary's location is to be found. Providing @c NULL
699 * will make Elementary not to use it
700 * @param dom This will be used as the application's "domain", in the
701 * form of a prefix to any environment variables that may
702 * override prefix detection and the directory name, inside the
703 * standard share or data directories, where the software's
704 * data files will be looked for.
705 * @param checkfile This is an (optional) magic file's path to check
706 * for existence (and it must be located in the data directory,
707 * under the share directory provided above). Its presence will
708 * help determine the prefix found was correct. Pass @c NULL if
709 * the check is not to be done.
711 * This function allows one to re-locate the application somewhere
712 * else after compilation, if the developer wishes for easier
713 * distribution of pre-compiled binaries.
715 * The prefix system is designed to locate where the given software is
716 * installed (under a common path prefix) at run time and then report
717 * specific locations of this prefix and common directories inside
718 * this prefix like the binary, library, data and locale directories,
719 * through the @c elm_app_*_get() family of functions.
721 * Call elm_app_info_set() early on before you change working
722 * directory or anything about @c argv[0], so it gets accurate
725 * It will then try and trace back which file @p mainfunc comes from,
726 * if provided, to determine the application's prefix directory.
728 * The @p dom parameter provides a string prefix to prepend before
729 * environment variables, allowing a fallback to @b specific
730 * environment variables to locate the software. You would most
731 * probably provide a lowercase string there, because it will also
732 * serve as directory domain, explained next. For environment
733 * variables purposes, this string is made uppercase. For example if
734 * @c "myapp" is provided as the prefix, then the program would expect
735 * @c "MYAPP_PREFIX" as a master environment variable to specify the
736 * exact install prefix for the software, or more specific environment
737 * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
738 * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
739 * the user or scripts before launching. If not provided (@c NULL),
740 * environment variables will not be used to override compiled-in
741 * defaults or auto detections.
743 * The @p dom string also provides a subdirectory inside the system
744 * shared data directory for data files. For example, if the system
745 * directory is @c /usr/local/share, then this directory name is
746 * appended, creating @c /usr/local/share/myapp, if it @p was @c
747 * "myapp". It is expected the application installs data files in
750 * The @p checkfile is a file name or path of something inside the
751 * share or data directory to be used to test that the prefix
752 * detection worked. For example, your app will install a wallpaper
753 * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
754 * check that this worked, provide @c "images/wallpaper.jpg" as the @p
757 * @see elm_app_compile_bin_dir_set()
758 * @see elm_app_compile_lib_dir_set()
759 * @see elm_app_compile_data_dir_set()
760 * @see elm_app_compile_locale_set()
761 * @see elm_app_prefix_dir_get()
762 * @see elm_app_bin_dir_get()
763 * @see elm_app_lib_dir_get()
764 * @see elm_app_data_dir_get()
765 * @see elm_app_locale_dir_get()
767 EAPI void elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
770 * Provide information on the @b fallback application's binaries
771 * directory, on scenarios where they get overriden by
772 * elm_app_info_set().
774 * @param dir The path to the default binaries directory (compile time
777 * @note Elementary will as well use this path to determine actual
778 * names of binaries' directory paths, maybe changing it to be @c
779 * something/local/bin instead of @c something/bin, only, for
782 * @warning You should call this function @b before
783 * elm_app_info_set().
785 EAPI void elm_app_compile_bin_dir_set(const char *dir);
788 * Provide information on the @b fallback application's libraries
789 * directory, on scenarios where they get overriden by
790 * elm_app_info_set().
792 * @param dir The path to the default libraries directory (compile
795 * @note Elementary will as well use this path to determine actual
796 * names of libraries' directory paths, maybe changing it to be @c
797 * something/lib32 or @c something/lib64 instead of @c something/lib,
800 * @warning You should call this function @b before
801 * elm_app_info_set().
803 EAPI void elm_app_compile_lib_dir_set(const char *dir);
806 * Provide information on the @b fallback application's data
807 * directory, on scenarios where they get overriden by
808 * elm_app_info_set().
810 * @param dir The path to the default data directory (compile time
813 * @note Elementary will as well use this path to determine actual
814 * names of data directory paths, maybe changing it to be @c
815 * something/local/share instead of @c something/share, only, for
818 * @warning You should call this function @b before
819 * elm_app_info_set().
821 EAPI void elm_app_compile_data_dir_set(const char *dir);
824 * Provide information on the @b fallback application's locale
825 * directory, on scenarios where they get overriden by
826 * elm_app_info_set().
828 * @param dir The path to the default locale directory (compile time
831 * @warning You should call this function @b before
832 * elm_app_info_set().
834 EAPI void elm_app_compile_locale_set(const char *dir);
837 * Retrieve the application's run time prefix directory, as set by
838 * elm_app_info_set() and the way (environment) the application was
841 * @return The directory prefix the application is actually using
843 EAPI const char *elm_app_prefix_dir_get(void);
846 * Retrieve the application's run time binaries prefix directory, as
847 * set by elm_app_info_set() and the way (environment) the application
850 * @return The binaries directory prefix the application is actually
853 EAPI const char *elm_app_bin_dir_get(void);
856 * Retrieve the application's run time libraries prefix directory, as
857 * set by elm_app_info_set() and the way (environment) the application
860 * @return The libraries directory prefix the application is actually
863 EAPI const char *elm_app_lib_dir_get(void);
866 * Retrieve the application's run time data prefix directory, as
867 * set by elm_app_info_set() and the way (environment) the application
870 * @return The data directory prefix the application is actually
873 EAPI const char *elm_app_data_dir_get(void);
876 * Retrieve the application's run time locale prefix directory, as
877 * set by elm_app_info_set() and the way (environment) the application
880 * @return The locale directory prefix the application is actually
883 EAPI const char *elm_app_locale_dir_get(void);
885 EAPI void elm_quicklaunch_mode_set(Eina_Bool ql_on);
886 EAPI Eina_Bool elm_quicklaunch_mode_get(void);
887 EAPI int elm_quicklaunch_init(int argc, char **argv);
888 EAPI int elm_quicklaunch_sub_init(int argc, char **argv);
889 EAPI int elm_quicklaunch_sub_shutdown(void);
890 EAPI int elm_quicklaunch_shutdown(void);
891 EAPI void elm_quicklaunch_seed(void);
892 EAPI Eina_Bool elm_quicklaunch_prepare(int argc, char **argv);
893 EAPI Eina_Bool elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
894 EAPI void elm_quicklaunch_cleanup(void);
895 EAPI int elm_quicklaunch_fallback(int argc, char **argv);
896 EAPI char *elm_quicklaunch_exe_path_get(const char *exe);
898 EAPI Eina_Bool elm_need_efreet(void);
899 EAPI Eina_Bool elm_need_e_dbus(void);
902 * This must be called before any other function that handle with
903 * elm_thumb objects or ethumb_client instances.
907 EAPI Eina_Bool elm_need_ethumb(void);
910 * This must be called before any other function that handle with
911 * elm_web objects or ewk_view instances.
915 EAPI Eina_Bool elm_need_web(void);
918 * Set a new policy's value (for a given policy group/identifier).
920 * @param policy policy identifier, as in @ref Elm_Policy.
921 * @param value policy value, which depends on the identifier
923 * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
925 * Elementary policies define applications' behavior,
926 * somehow. These behaviors are divided in policy groups (see
927 * #Elm_Policy enumeration). This call will emit the Ecore event
928 * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
929 * handlers. An #Elm_Event_Policy_Changed struct will be passed,
932 * @note Currently, we have only one policy identifier/group
933 * (#ELM_POLICY_QUIT), which has two possible values.
937 EAPI Eina_Bool elm_policy_set(unsigned int policy, int value);
940 * Gets the policy value set for given policy identifier.
942 * @param policy policy identifier, as in #Elm_Policy.
943 * @return The currently set policy value, for that
944 * identifier. Will be @c 0 if @p policy passed is invalid.
948 EAPI int elm_policy_get(unsigned int policy);
951 * Set a label of an object
953 * @param obj The Elementary object
954 * @param part The text part name to set (NULL for the default label)
955 * @param label The new text of the label
957 * @note Elementary objects may have many labels (e.g. Action Slider)
961 EAPI void elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
963 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
966 * Get a label of an object
968 * @param obj The Elementary object
969 * @param part The text part name to get (NULL for the default label)
970 * @return text of the label or NULL for any error
972 * @note Elementary objects may have many labels (e.g. Action Slider)
976 EAPI const char *elm_object_text_part_get(const Evas_Object *obj, const char *part);
978 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
981 * Set a content of an object
983 * @param obj The Elementary object
984 * @param part The content part name to set (NULL for the default content)
985 * @param content The new content of the object
987 * @note Elementary objects may have many contents
991 EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
993 #define elm_object_content_set(obj, content) elm_object_content_part_set((obj), NULL, (content))
996 * Get a content of an object
998 * @param obj The Elementary object
999 * @param item The content part name to get (NULL for the default content)
1000 * @return content of the object or NULL for any error
1002 * @note Elementary objects may have many contents
1006 EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
1008 #define elm_object_content_get(obj) elm_object_content_part_get((obj), NULL)
1011 * Unset a content of an object
1013 * @param obj The Elementary object
1014 * @param item The content part name to unset (NULL for the default content)
1016 * @note Elementary objects may have many contents
1020 EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
1022 #define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
1025 * Get the wiget object's handle which contains a given item
1027 * @param item The Elementary object item
1028 * @return The widget object
1030 * @note This returns the widget object itself that an item belongs to.
1034 EAPI Evas_Object *elm_object_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1037 * Set a content of an object item
1039 * @param it The Elementary object item
1040 * @param part The content part name to set (NULL for the default content)
1041 * @param content The new content of the object item
1043 * @note Elementary object items may have many contents
1047 EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1049 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
1052 * Get a content of an object item
1054 * @param it The Elementary object item
1055 * @param part The content part name to unset (NULL for the default content)
1056 * @return content of the object item or NULL for any error
1058 * @note Elementary object items may have many contents
1062 EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *part);
1064 #define elm_object_item_content_get(it) elm_object_item_content_part_get((it), NULL)
1067 * Unset a content of an object item
1069 * @param it The Elementary object item
1070 * @param part The content part name to unset (NULL for the default content)
1072 * @note Elementary object items may have many contents
1076 EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1078 #define elm_object_item_content_unset(it) elm_object_item_content_part_unset((it), NULL)
1081 * Set a label of an object item
1083 * @param it The Elementary object item
1084 * @param part The text part name to set (NULL for the default label)
1085 * @param label The new text of the label
1087 * @note Elementary object items may have many labels
1091 EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1093 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
1096 * Get a label of an object
1098 * @param it The Elementary object item
1099 * @param part The text part name to get (NULL for the default label)
1100 * @return text of the label or NULL for any error
1102 * @note Elementary object items may have many labels
1106 EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1108 #define elm_object_item_text_get(it) elm_object_item_text_part_get((it), NULL)
1111 * Set the text to read out when in accessibility mode
1113 * @param obj The object which is to be described
1114 * @param txt The text that describes the widget to people with poor or no vision
1118 EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1121 * Set the text to read out when in accessibility mode
1123 * @param it The object item which is to be described
1124 * @param txt The text that describes the widget to people with poor or no vision
1128 EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1131 * Get the data associated with an object item
1132 * @param it The object item
1133 * @return The data associated with @p it
1137 EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
1140 * Set the data associated with an object item
1141 * @param it The object item
1142 * @param data The data to be associated with @p it
1146 EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
1149 * Send a signal to the edje object of the widget item.
1151 * This function sends a signal to the edje object of the obj item. An
1152 * edje program can respond to a signal by specifying matching
1153 * 'signal' and 'source' fields.
1155 * @param it The Elementary object item
1156 * @param emission The signal's name.
1157 * @param source The signal's source.
1160 EAPI void elm_object_item_signal_emit(Elm_Object_Item *it, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1167 * @defgroup Caches Caches
1169 * These are functions which let one fine-tune some cache values for
1170 * Elementary applications, thus allowing for performance adjustments.
1176 * @brief Flush all caches.
1178 * Frees all data that was in cache and is not currently being used to reduce
1179 * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1180 * to calling all of the following functions:
1181 * @li edje_file_cache_flush()
1182 * @li edje_collection_cache_flush()
1183 * @li eet_clearcache()
1184 * @li evas_image_cache_flush()
1185 * @li evas_font_cache_flush()
1186 * @li evas_render_dump()
1187 * @note Evas caches are flushed for every canvas associated with a window.
1191 EAPI void elm_all_flush(void);
1194 * Get the configured cache flush interval time
1196 * This gets the globally configured cache flush interval time, in
1199 * @return The cache flush interval time
1202 * @see elm_all_flush()
1204 EAPI int elm_cache_flush_interval_get(void);
1207 * Set the configured cache flush interval time
1209 * This sets the globally configured cache flush interval time, in ticks
1211 * @param size The cache flush interval time
1214 * @see elm_all_flush()
1216 EAPI void elm_cache_flush_interval_set(int size);
1219 * Set the configured cache flush interval time for all applications on the
1222 * This sets the globally configured cache flush interval time -- in ticks
1223 * -- for all applications on the display.
1225 * @param size The cache flush interval time
1228 EAPI void elm_cache_flush_interval_all_set(int size);
1231 * Get the configured cache flush enabled state
1233 * This gets the globally configured cache flush state - if it is enabled
1234 * or not. When cache flushing is enabled, elementary will regularly
1235 * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1236 * memory and allow usage to re-seed caches and data in memory where it
1237 * can do so. An idle application will thus minimise its memory usage as
1238 * data will be freed from memory and not be re-loaded as it is idle and
1239 * not rendering or doing anything graphically right now.
1241 * @return The cache flush state
1244 * @see elm_all_flush()
1246 EAPI Eina_Bool elm_cache_flush_enabled_get(void);
1249 * Set the configured cache flush enabled state
1251 * This sets the globally configured cache flush enabled state
1253 * @param size The cache flush enabled state
1256 * @see elm_all_flush()
1258 EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
1261 * Set the configured cache flush enabled state for all applications on the
1264 * This sets the globally configured cache flush enabled state for all
1265 * applications on the display.
1267 * @param size The cache flush enabled state
1270 EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1273 * Get the configured font cache size
1275 * This gets the globally configured font cache size, in bytes
1277 * @return The font cache size
1280 EAPI int elm_font_cache_get(void);
1283 * Set the configured font cache size
1285 * This sets the globally configured font cache size, in bytes
1287 * @param size The font cache size
1290 EAPI void elm_font_cache_set(int size);
1293 * Set the configured font cache size for all applications on the
1296 * This sets the globally configured font cache size -- in bytes
1297 * -- for all applications on the display.
1299 * @param size The font cache size
1302 EAPI void elm_font_cache_all_set(int size);
1305 * Get the configured image cache size
1307 * This gets the globally configured image cache size, in bytes
1309 * @return The image cache size
1312 EAPI int elm_image_cache_get(void);
1315 * Set the configured image cache size
1317 * This sets the globally configured image cache size, in bytes
1319 * @param size The image cache size
1322 EAPI void elm_image_cache_set(int size);
1325 * Set the configured image cache size for all applications on the
1328 * This sets the globally configured image cache size -- in bytes
1329 * -- for all applications on the display.
1331 * @param size The image cache size
1334 EAPI void elm_image_cache_all_set(int size);
1337 * Get the configured edje file cache size.
1339 * This gets the globally configured edje file cache size, in number
1342 * @return The edje file cache size
1345 EAPI int elm_edje_file_cache_get(void);
1348 * Set the configured edje file cache size
1350 * This sets the globally configured edje file cache size, in number
1353 * @param size The edje file cache size
1356 EAPI void elm_edje_file_cache_set(int size);
1359 * Set the configured edje file cache size for all applications on the
1362 * This sets the globally configured edje file cache size -- in number
1363 * of files -- for all applications on the display.
1365 * @param size The edje file cache size
1368 EAPI void elm_edje_file_cache_all_set(int size);
1371 * Get the configured edje collections (groups) cache size.
1373 * This gets the globally configured edje collections cache size, in
1374 * number of collections.
1376 * @return The edje collections cache size
1379 EAPI int elm_edje_collection_cache_get(void);
1382 * Set the configured edje collections (groups) cache size
1384 * This sets the globally configured edje collections cache size, in
1385 * number of collections.
1387 * @param size The edje collections cache size
1390 EAPI void elm_edje_collection_cache_set(int size);
1393 * Set the configured edje collections (groups) cache size for all
1394 * applications on the display
1396 * This sets the globally configured edje collections cache size -- in
1397 * number of collections -- for all applications on the display.
1399 * @param size The edje collections cache size
1402 EAPI void elm_edje_collection_cache_all_set(int size);
1409 * @defgroup Scaling Widget Scaling
1411 * Different widgets can be scaled independently. These functions
1412 * allow you to manipulate this scaling on a per-widget basis. The
1413 * object and all its children get their scaling factors multiplied
1414 * by the scale factor set. This is multiplicative, in that if a
1415 * child also has a scale size set it is in turn multiplied by its
1416 * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
1417 * double size, @c 0.5 is half, etc.
1419 * @ref general_functions_example_page "This" example contemplates
1420 * some of these functions.
1424 * Get the global scaling factor
1426 * This gets the globally configured scaling factor that is applied to all
1429 * @return The scaling factor
1432 EAPI double elm_scale_get(void);
1435 * Set the global scaling factor
1437 * This sets the globally configured scaling factor that is applied to all
1440 * @param scale The scaling factor to set
1443 EAPI void elm_scale_set(double scale);
1446 * Set the global scaling factor for all applications on the display
1448 * This sets the globally configured scaling factor that is applied to all
1449 * objects for all applications.
1450 * @param scale The scaling factor to set
1453 EAPI void elm_scale_all_set(double scale);
1456 * Set the scaling factor for a given Elementary object
1458 * @param obj The Elementary to operate on
1459 * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1464 EAPI void elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1467 * Get the scaling factor for a given Elementary object
1469 * @param obj The object
1470 * @return The scaling factor set by elm_object_scale_set()
1474 EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1477 * @defgroup Password_last_show Password last input show
1479 * Last show feature of password mode enables user to view
1480 * the last input entered for few seconds before masking it.
1481 * These functions allow to set this feature in password mode
1482 * of entry widget and also allow to manipulate the duration
1483 * for which the input has to be visible.
1489 * Get show last setting of password mode.
1491 * This gets the show last input setting of password mode which might be
1492 * enabled or disabled.
1494 * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1496 * @ingroup Password_last_show
1498 EAPI Eina_Bool elm_password_show_last_get(void);
1501 * Set show last setting in password mode.
1503 * This enables or disables show last setting of password mode.
1505 * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1506 * @see elm_password_show_last_timeout_set()
1507 * @ingroup Password_last_show
1509 EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1512 * Get's the timeout value in last show password mode.
1514 * This gets the time out value for which the last input entered in password
1515 * mode will be visible.
1517 * @return The timeout value of last show password mode.
1518 * @ingroup Password_last_show
1520 EAPI double elm_password_show_last_timeout_get(void);
1523 * Set's the timeout value in last show password mode.
1525 * This sets the time out value for which the last input entered in password
1526 * mode will be visible.
1528 * @param password_show_last_timeout The timeout value.
1529 * @see elm_password_show_last_set()
1530 * @ingroup Password_last_show
1532 EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1539 * @defgroup UI-Mirroring Selective Widget mirroring
1541 * These functions allow you to set ui-mirroring on specific
1542 * widgets or the whole interface. Widgets can be in one of two
1543 * modes, automatic and manual. Automatic means they'll be changed
1544 * according to the system mirroring mode and manual means only
1545 * explicit changes will matter. You are not supposed to change
1546 * mirroring state of a widget set to automatic, will mostly work,
1547 * but the behavior is not really defined.
1552 EAPI Eina_Bool elm_mirrored_get(void);
1553 EAPI void elm_mirrored_set(Eina_Bool mirrored);
1556 * Get the system mirrored mode. This determines the default mirrored mode
1559 * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1561 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1564 * Set the system mirrored mode. This determines the default mirrored mode
1567 * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1569 EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1572 * Returns the widget's mirrored mode setting.
1574 * @param obj The widget.
1575 * @return mirrored mode setting of the object.
1578 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1581 * Sets the widget's mirrored mode setting.
1582 * When widget in automatic mode, it follows the system mirrored mode set by
1583 * elm_mirrored_set().
1584 * @param obj The widget.
1585 * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1587 EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1594 * Set the style to use by a widget
1596 * Sets the style name that will define the appearance of a widget. Styles
1597 * vary from widget to widget and may also be defined by other themes
1598 * by means of extensions and overlays.
1600 * @param obj The Elementary widget to style
1601 * @param style The style name to use
1603 * @see elm_theme_extension_add()
1604 * @see elm_theme_extension_del()
1605 * @see elm_theme_overlay_add()
1606 * @see elm_theme_overlay_del()
1610 EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1612 * Get the style used by the widget
1614 * This gets the style being used for that widget. Note that the string
1615 * pointer is only valid as longas the object is valid and the style doesn't
1618 * @param obj The Elementary widget to query for its style
1619 * @return The style name used
1621 * @see elm_object_style_set()
1625 EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1628 * @defgroup Styles Styles
1630 * Widgets can have different styles of look. These generic API's
1631 * set styles of widgets, if they support them (and if the theme(s)
1634 * @ref general_functions_example_page "This" example contemplates
1635 * some of these functions.
1639 * Set the disabled state of an Elementary object.
1641 * @param obj The Elementary object to operate on
1642 * @param disabled The state to put in in: @c EINA_TRUE for
1643 * disabled, @c EINA_FALSE for enabled
1645 * Elementary objects can be @b disabled, in which state they won't
1646 * receive input and, in general, will be themed differently from
1647 * their normal state, usually greyed out. Useful for contexts
1648 * where you don't want your users to interact with some of the
1649 * parts of you interface.
1651 * This sets the state for the widget, either disabling it or
1656 EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1659 * Get the disabled state of an Elementary object.
1661 * @param obj The Elementary object to operate on
1662 * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1663 * if it's enabled (or on errors)
1665 * This gets the state of the widget, which might be enabled or disabled.
1669 EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1672 * @defgroup WidgetNavigation Widget Tree Navigation.
1674 * How to check if an Evas Object is an Elementary widget? How to
1675 * get the first elementary widget that is parent of the given
1676 * object? These are all covered in widget tree navigation.
1678 * @ref general_functions_example_page "This" example contemplates
1679 * some of these functions.
1683 * Check if the given Evas Object is an Elementary widget.
1685 * @param obj the object to query.
1686 * @return @c EINA_TRUE if it is an elementary widget variant,
1687 * @c EINA_FALSE otherwise
1688 * @ingroup WidgetNavigation
1690 EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1693 * Get the first parent of the given object that is an Elementary
1696 * @param obj the Elementary object to query parent from.
1697 * @return the parent object that is an Elementary widget, or @c
1698 * NULL, if it was not found.
1700 * Use this to query for an object's parent widget.
1702 * @note Most of Elementary users wouldn't be mixing non-Elementary
1703 * smart objects in the objects tree of an application, as this is
1704 * an advanced usage of Elementary with Evas. So, except for the
1705 * application's window, which is the root of that tree, all other
1706 * objects would have valid Elementary widget parents.
1708 * @ingroup WidgetNavigation
1710 EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1713 * Get the top level parent of an Elementary widget.
1715 * @param obj The object to query.
1716 * @return The top level Elementary widget, or @c NULL if parent cannot be
1718 * @ingroup WidgetNavigation
1720 EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1723 * Get the string that represents this Elementary widget.
1725 * @note Elementary is weird and exposes itself as a single
1726 * Evas_Object_Smart_Class of type "elm_widget", so
1727 * evas_object_type_get() always return that, making debug and
1728 * language bindings hard. This function tries to mitigate this
1729 * problem, but the solution is to change Elementary to use
1730 * proper inheritance.
1732 * @param obj the object to query.
1733 * @return Elementary widget name, or @c NULL if not a valid widget.
1734 * @ingroup WidgetNavigation
1736 EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1739 * @defgroup Config Elementary Config
1741 * Elementary configuration is formed by a set options bounded to a
1742 * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1743 * "finger size", etc. These are functions with which one syncronizes
1744 * changes made to those values to the configuration storing files, de
1745 * facto. You most probably don't want to use the functions in this
1746 * group unlees you're writing an elementary configuration manager.
1752 * Save back Elementary's configuration, so that it will persist on
1755 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1758 * This function will take effect -- thus, do I/O -- immediately. Use
1759 * it when you want to apply all configuration changes at once. The
1760 * current configuration set will get saved onto the current profile
1761 * configuration file.
1764 EAPI Eina_Bool elm_config_save(void);
1767 * Reload Elementary's configuration, bounded to current selected
1770 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1773 * Useful when you want to force reloading of configuration values for
1774 * a profile. If one removes user custom configuration directories,
1775 * for example, it will force a reload with system values insted.
1778 EAPI void elm_config_reload(void);
1785 * @defgroup Profile Elementary Profile
1787 * Profiles are pre-set options that affect the whole look-and-feel of
1788 * Elementary-based applications. There are, for example, profiles
1789 * aimed at desktop computer applications and others aimed at mobile,
1790 * touchscreen-based ones. You most probably don't want to use the
1791 * functions in this group unlees you're writing an elementary
1792 * configuration manager.
1798 * Get Elementary's profile in use.
1800 * This gets the global profile that is applied to all Elementary
1803 * @return The profile's name
1806 EAPI const char *elm_profile_current_get(void);
1809 * Get an Elementary's profile directory path in the filesystem. One
1810 * may want to fetch a system profile's dir or an user one (fetched
1813 * @param profile The profile's name
1814 * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
1815 * or a system one (@c EINA_FALSE)
1816 * @return The profile's directory path.
1819 * @note You must free it with elm_profile_dir_free().
1821 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1824 * Free an Elementary's profile directory path, as returned by
1825 * elm_profile_dir_get().
1827 * @param p_dir The profile's path
1831 EAPI void elm_profile_dir_free(const char *p_dir);
1834 * Get Elementary's list of available profiles.
1836 * @return The profiles list. List node data are the profile name
1840 * @note One must free this list, after usage, with the function
1841 * elm_profile_list_free().
1843 EAPI Eina_List *elm_profile_list_get(void);
1846 * Free Elementary's list of available profiles.
1848 * @param l The profiles list, as returned by elm_profile_list_get().
1852 EAPI void elm_profile_list_free(Eina_List *l);
1855 * Set Elementary's profile.
1857 * This sets the global profile that is applied to Elementary
1858 * applications. Just the process the call comes from will be
1861 * @param profile The profile's name
1865 EAPI void elm_profile_set(const char *profile);
1868 * Set Elementary's profile.
1870 * This sets the global profile that is applied to all Elementary
1871 * applications. All running Elementary windows will be affected.
1873 * @param profile The profile's name
1877 EAPI void elm_profile_all_set(const char *profile);
1884 * @defgroup Engine Elementary Engine
1886 * These are functions setting and querying which rendering engine
1887 * Elementary will use for drawing its windows' pixels.
1889 * The following are the available engines:
1890 * @li "software_x11"
1893 * @li "software_16_x11"
1894 * @li "software_8_x11"
1897 * @li "software_gdi"
1898 * @li "software_16_wince_gdi"
1900 * @li "software_16_sdl"
1909 * @brief Get Elementary's rendering engine in use.
1911 * @return The rendering engine's name
1912 * @note there's no need to free the returned string, here.
1914 * This gets the global rendering engine that is applied to all Elementary
1917 * @see elm_engine_set()
1919 EAPI const char *elm_engine_current_get(void);
1922 * @brief Set Elementary's rendering engine for use.
1924 * @param engine The rendering engine's name
1926 * This sets global rendering engine that is applied to all Elementary
1927 * applications. Note that it will take effect only to Elementary windows
1928 * created after this is called.
1930 * @see elm_win_add()
1932 EAPI void elm_engine_set(const char *engine);
1939 * @defgroup Fonts Elementary Fonts
1941 * These are functions dealing with font rendering, selection and the
1942 * like for Elementary applications. One might fetch which system
1943 * fonts are there to use and set custom fonts for individual classes
1944 * of UI items containing text (text classes).
1949 typedef struct _Elm_Text_Class
1955 typedef struct _Elm_Font_Overlay
1957 const char *text_class;
1959 Evas_Font_Size size;
1962 typedef struct _Elm_Font_Properties
1966 } Elm_Font_Properties;
1969 * Get Elementary's list of supported text classes.
1971 * @return The text classes list, with @c Elm_Text_Class blobs as data.
1974 * Release the list with elm_text_classes_list_free().
1976 EAPI const Eina_List *elm_text_classes_list_get(void);
1979 * Free Elementary's list of supported text classes.
1983 * @see elm_text_classes_list_get().
1985 EAPI void elm_text_classes_list_free(const Eina_List *list);
1988 * Get Elementary's list of font overlays, set with
1989 * elm_font_overlay_set().
1991 * @return The font overlays list, with @c Elm_Font_Overlay blobs as
1996 * For each text class, one can set a <b>font overlay</b> for it,
1997 * overriding the default font properties for that class coming from
1998 * the theme in use. There is no need to free this list.
2000 * @see elm_font_overlay_set() and elm_font_overlay_unset().
2002 EAPI const Eina_List *elm_font_overlay_list_get(void);
2005 * Set a font overlay for a given Elementary text class.
2007 * @param text_class Text class name
2008 * @param font Font name and style string
2009 * @param size Font size
2013 * @p font has to be in the format returned by
2014 * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
2015 * and elm_font_overlay_unset().
2017 EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
2020 * Unset a font overlay for a given Elementary text class.
2022 * @param text_class Text class name
2026 * This will bring back text elements belonging to text class
2027 * @p text_class back to their default font settings.
2029 EAPI void elm_font_overlay_unset(const char *text_class);
2032 * Apply the changes made with elm_font_overlay_set() and
2033 * elm_font_overlay_unset() on the current Elementary window.
2037 * This applies all font overlays set to all objects in the UI.
2039 EAPI void elm_font_overlay_apply(void);
2042 * Apply the changes made with elm_font_overlay_set() and
2043 * elm_font_overlay_unset() on all Elementary application windows.
2047 * This applies all font overlays set to all objects in the UI.
2049 EAPI void elm_font_overlay_all_apply(void);
2052 * Translate a font (family) name string in fontconfig's font names
2053 * syntax into an @c Elm_Font_Properties struct.
2055 * @param font The font name and styles string
2056 * @return the font properties struct
2060 * @note The reverse translation can be achived with
2061 * elm_font_fontconfig_name_get(), for one style only (single font
2062 * instance, not family).
2064 EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
2067 * Free font properties return by elm_font_properties_get().
2069 * @param efp the font properties struct
2073 EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
2076 * Translate a font name, bound to a style, into fontconfig's font names
2079 * @param name The font (family) name
2080 * @param style The given style (may be @c NULL)
2082 * @return the font name and style string
2086 * @note The reverse translation can be achived with
2087 * elm_font_properties_get(), for one style only (single font
2088 * instance, not family).
2090 EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
2093 * Free the font string return by elm_font_fontconfig_name_get().
2095 * @param efp the font properties struct
2099 EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
2102 * Create a font hash table of available system fonts.
2104 * One must call it with @p list being the return value of
2105 * evas_font_available_list(). The hash will be indexed by font
2106 * (family) names, being its values @c Elm_Font_Properties blobs.
2108 * @param list The list of available system fonts, as returned by
2109 * evas_font_available_list().
2110 * @return the font hash.
2114 * @note The user is supposed to get it populated at least with 3
2115 * default font families (Sans, Serif, Monospace), which should be
2116 * present on most systems.
2118 EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
2121 * Free the hash return by elm_font_available_hash_add().
2123 * @param hash the hash to be freed.
2127 EAPI void elm_font_available_hash_del(Eina_Hash *hash);
2134 * @defgroup Fingers Fingers
2136 * Elementary is designed to be finger-friendly for touchscreens,
2137 * and so in addition to scaling for display resolution, it can
2138 * also scale based on finger "resolution" (or size). You can then
2139 * customize the granularity of the areas meant to receive clicks
2142 * Different profiles may have pre-set values for finger sizes.
2144 * @ref general_functions_example_page "This" example contemplates
2145 * some of these functions.
2151 * Get the configured "finger size"
2153 * @return The finger size
2155 * This gets the globally configured finger size, <b>in pixels</b>
2159 EAPI Evas_Coord elm_finger_size_get(void);
2162 * Set the configured finger size
2164 * This sets the globally configured finger size in pixels
2166 * @param size The finger size
2169 EAPI void elm_finger_size_set(Evas_Coord size);
2172 * Set the configured finger size for all applications on the display
2174 * This sets the globally configured finger size in pixels for all
2175 * applications on the display
2177 * @param size The finger size
2180 EAPI void elm_finger_size_all_set(Evas_Coord size);
2187 * @defgroup Focus Focus
2189 * An Elementary application has, at all times, one (and only one)
2190 * @b focused object. This is what determines where the input
2191 * events go to within the application's window. Also, focused
2192 * objects can be decorated differently, in order to signal to the
2193 * user where the input is, at a given moment.
2195 * Elementary applications also have the concept of <b>focus
2196 * chain</b>: one can cycle through all the windows' focusable
2197 * objects by input (tab key) or programmatically. The default
2198 * focus chain for an application is the one define by the order in
2199 * which the widgets where added in code. One will cycle through
2200 * top level widgets, and, for each one containg sub-objects, cycle
2201 * through them all, before returning to the level
2202 * above. Elementary also allows one to set @b custom focus chains
2203 * for their applications.
2205 * Besides the focused decoration a widget may exhibit, when it
2206 * gets focus, Elementary has a @b global focus highlight object
2207 * that can be enabled for a window. If one chooses to do so, this
2208 * extra highlight effect will surround the current focused object,
2211 * @note Some Elementary widgets are @b unfocusable, after
2212 * creation, by their very nature: they are not meant to be
2213 * interacted with input events, but are there just for visual
2216 * @ref general_functions_example_page "This" example contemplates
2217 * some of these functions.
2221 * Get the enable status of the focus highlight
2223 * This gets whether the highlight on focused objects is enabled or not
2226 EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
2229 * Set the enable status of the focus highlight
2231 * Set whether to show or not the highlight on focused objects
2232 * @param enable Enable highlight if EINA_TRUE, disable otherwise
2235 EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
2238 * Get the enable status of the highlight animation
2240 * Get whether the focus highlight, if enabled, will animate its switch from
2241 * one object to the next
2244 EAPI Eina_Bool elm_focus_highlight_animate_get(void);
2247 * Set the enable status of the highlight animation
2249 * Set whether the focus highlight, if enabled, will animate its switch from
2250 * one object to the next
2251 * @param animate Enable animation if EINA_TRUE, disable otherwise
2254 EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
2257 * Get the whether an Elementary object has the focus or not.
2259 * @param obj The Elementary object to get the information from
2260 * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2261 * not (and on errors).
2263 * @see elm_object_focus_set()
2267 EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2270 * Set/unset focus to a given Elementary object.
2272 * @param obj The Elementary object to operate on.
2273 * @param enable @c EINA_TRUE Set focus to a given object,
2274 * @c EINA_FALSE Unset focus to a given object.
2276 * @note When you set focus to this object, if it can handle focus, will
2277 * take the focus away from the one who had it previously and will, for
2278 * now on, be the one receiving input events. Unsetting focus will remove
2279 * the focus from @p obj, passing it back to the previous element in the
2282 * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2286 EAPI void elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2289 * Make a given Elementary object the focused one.
2291 * @param obj The Elementary object to make focused.
2293 * @note This object, if it can handle focus, will take the focus
2294 * away from the one who had it previously and will, for now on, be
2295 * the one receiving input events.
2297 * @see elm_object_focus_get()
2298 * @deprecated use elm_object_focus_set() instead.
2302 EINA_DEPRECATED EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2305 * Remove the focus from an Elementary object
2307 * @param obj The Elementary to take focus from
2309 * This removes the focus from @p obj, passing it back to the
2310 * previous element in the focus chain list.
2312 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2313 * @deprecated use elm_object_focus_set() instead.
2317 EINA_DEPRECATED EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2320 * Set the ability for an Element object to be focused
2322 * @param obj The Elementary object to operate on
2323 * @param enable @c EINA_TRUE if the object can be focused, @c
2324 * EINA_FALSE if not (and on errors)
2326 * This sets whether the object @p obj is able to take focus or
2327 * not. Unfocusable objects do nothing when programmatically
2328 * focused, being the nearest focusable parent object the one
2329 * really getting focus. Also, when they receive mouse input, they
2330 * will get the event, but not take away the focus from where it
2335 EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2338 * Get whether an Elementary object is focusable or not
2340 * @param obj The Elementary object to operate on
2341 * @return @c EINA_TRUE if the object is allowed to be focused, @c
2342 * EINA_FALSE if not (and on errors)
2344 * @note Objects which are meant to be interacted with by input
2345 * events are created able to be focused, by default. All the
2350 EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2353 * Set custom focus chain.
2355 * This function overwrites any previous custom focus chain within
2356 * the list of objects. The previous list will be deleted and this list
2357 * will be managed by elementary. After it is set, don't modify it.
2359 * @note On focus cycle, only will be evaluated children of this container.
2361 * @param obj The container object
2362 * @param objs Chain of objects to pass focus
2365 EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2368 * Unset a custom focus chain on a given Elementary widget
2370 * @param obj The container object to remove focus chain from
2372 * Any focus chain previously set on @p obj (for its child objects)
2373 * is removed entirely after this call.
2377 EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2380 * Get custom focus chain
2382 * @param obj The container object
2385 EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2388 * Append object to custom focus chain.
2390 * @note If relative_child equal to NULL or not in custom chain, the object
2391 * will be added in end.
2393 * @note On focus cycle, only will be evaluated children of this container.
2395 * @param obj The container object
2396 * @param child The child to be added in custom chain
2397 * @param relative_child The relative object to position the child
2400 EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2403 * Prepend object to custom focus chain.
2405 * @note If relative_child equal to NULL or not in custom chain, the object
2406 * will be added in begin.
2408 * @note On focus cycle, only will be evaluated children of this container.
2410 * @param obj The container object
2411 * @param child The child to be added in custom chain
2412 * @param relative_child The relative object to position the child
2415 EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2418 * Give focus to next object in object tree.
2420 * Give focus to next object in focus chain of one object sub-tree.
2421 * If the last object of chain already have focus, the focus will go to the
2422 * first object of chain.
2424 * @param obj The object root of sub-tree
2425 * @param dir Direction to cycle the focus
2429 EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2432 * Give focus to near object in one direction.
2434 * Give focus to near object in direction of one object.
2435 * If none focusable object in given direction, the focus will not change.
2437 * @param obj The reference object
2438 * @param x Horizontal component of direction to focus
2439 * @param y Vertical component of direction to focus
2443 EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2446 * Make the elementary object and its children to be unfocusable
2449 * @param obj The Elementary object to operate on
2450 * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2451 * @c EINA_FALSE for focusable.
2453 * This sets whether the object @p obj and its children objects
2454 * are able to take focus or not. If the tree is set as unfocusable,
2455 * newest focused object which is not in this tree will get focus.
2456 * This API can be helpful for an object to be deleted.
2457 * When an object will be deleted soon, it and its children may not
2458 * want to get focus (by focus reverting or by other focus controls).
2459 * Then, just use this API before deleting.
2461 * @see elm_object_tree_unfocusable_get()
2465 EAPI void elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
2468 * Get whether an Elementary object and its children are unfocusable or not.
2470 * @param obj The Elementary object to get the information from
2471 * @return @c EINA_TRUE, if the tree is unfocussable,
2472 * @c EINA_FALSE if not (and on errors).
2474 * @see elm_object_tree_unfocusable_set()
2478 EAPI Eina_Bool elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
2481 * @defgroup Scrolling Scrolling
2483 * These are functions setting how scrollable views in Elementary
2484 * widgets should behave on user interaction.
2490 * Get whether scrollers should bounce when they reach their
2491 * viewport's edge during a scroll.
2493 * @return the thumb scroll bouncing state
2495 * This is the default behavior for touch screens, in general.
2496 * @ingroup Scrolling
2498 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
2501 * Set whether scrollers should bounce when they reach their
2502 * viewport's edge during a scroll.
2504 * @param enabled the thumb scroll bouncing state
2506 * @see elm_thumbscroll_bounce_enabled_get()
2507 * @ingroup Scrolling
2509 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2512 * Set whether scrollers should bounce when they reach their
2513 * viewport's edge during a scroll, for all Elementary application
2516 * @param enabled the thumb scroll bouncing state
2518 * @see elm_thumbscroll_bounce_enabled_get()
2519 * @ingroup Scrolling
2521 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2524 * Get the amount of inertia a scroller will impose at bounce
2527 * @return the thumb scroll bounce friction
2529 * @ingroup Scrolling
2531 EAPI double elm_scroll_bounce_friction_get(void);
2534 * Set the amount of inertia a scroller will impose at bounce
2537 * @param friction the thumb scroll bounce friction
2539 * @see elm_thumbscroll_bounce_friction_get()
2540 * @ingroup Scrolling
2542 EAPI void elm_scroll_bounce_friction_set(double friction);
2545 * Set the amount of inertia a scroller will impose at bounce
2546 * animations, for all Elementary application windows.
2548 * @param friction the thumb scroll bounce friction
2550 * @see elm_thumbscroll_bounce_friction_get()
2551 * @ingroup Scrolling
2553 EAPI void elm_scroll_bounce_friction_all_set(double friction);
2556 * Get the amount of inertia a <b>paged</b> scroller will impose at
2557 * page fitting animations.
2559 * @return the page scroll friction
2561 * @ingroup Scrolling
2563 EAPI double elm_scroll_page_scroll_friction_get(void);
2566 * Set the amount of inertia a <b>paged</b> scroller will impose at
2567 * page fitting animations.
2569 * @param friction the page scroll friction
2571 * @see elm_thumbscroll_page_scroll_friction_get()
2572 * @ingroup Scrolling
2574 EAPI void elm_scroll_page_scroll_friction_set(double friction);
2577 * Set the amount of inertia a <b>paged</b> scroller will impose at
2578 * page fitting animations, for all Elementary application windows.
2580 * @param friction the page scroll friction
2582 * @see elm_thumbscroll_page_scroll_friction_get()
2583 * @ingroup Scrolling
2585 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
2588 * Get the amount of inertia a scroller will impose at region bring
2591 * @return the bring in scroll friction
2593 * @ingroup Scrolling
2595 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
2598 * Set the amount of inertia a scroller will impose at region bring
2601 * @param friction the bring in scroll friction
2603 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2604 * @ingroup Scrolling
2606 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
2609 * Set the amount of inertia a scroller will impose at region bring
2610 * animations, for all Elementary application windows.
2612 * @param friction the bring in scroll friction
2614 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2615 * @ingroup Scrolling
2617 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
2620 * Get the amount of inertia scrollers will impose at animations
2621 * triggered by Elementary widgets' zooming API.
2623 * @return the zoom friction
2625 * @ingroup Scrolling
2627 EAPI double elm_scroll_zoom_friction_get(void);
2630 * Set the amount of inertia scrollers will impose at animations
2631 * triggered by Elementary widgets' zooming API.
2633 * @param friction the zoom friction
2635 * @see elm_thumbscroll_zoom_friction_get()
2636 * @ingroup Scrolling
2638 EAPI void elm_scroll_zoom_friction_set(double friction);
2641 * Set the amount of inertia scrollers will impose at animations
2642 * triggered by Elementary widgets' zooming API, for all Elementary
2643 * application windows.
2645 * @param friction the zoom friction
2647 * @see elm_thumbscroll_zoom_friction_get()
2648 * @ingroup Scrolling
2650 EAPI void elm_scroll_zoom_friction_all_set(double friction);
2653 * Get whether scrollers should be draggable from any point in their
2656 * @return the thumb scroll state
2658 * @note This is the default behavior for touch screens, in general.
2659 * @note All other functions namespaced with "thumbscroll" will only
2660 * have effect if this mode is enabled.
2662 * @ingroup Scrolling
2664 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
2667 * Set whether scrollers should be draggable from any point in their
2670 * @param enabled the thumb scroll state
2672 * @see elm_thumbscroll_enabled_get()
2673 * @ingroup Scrolling
2675 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2678 * Set whether scrollers should be draggable from any point in their
2679 * views, for all Elementary application windows.
2681 * @param enabled the thumb scroll state
2683 * @see elm_thumbscroll_enabled_get()
2684 * @ingroup Scrolling
2686 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2689 * Get the number of pixels one should travel while dragging a
2690 * scroller's view to actually trigger scrolling.
2692 * @return the thumb scroll threshould
2694 * One would use higher values for touch screens, in general, because
2695 * of their inherent imprecision.
2696 * @ingroup Scrolling
2698 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
2701 * Set the number of pixels one should travel while dragging a
2702 * scroller's view to actually trigger scrolling.
2704 * @param threshold the thumb scroll threshould
2706 * @see elm_thumbscroll_threshould_get()
2707 * @ingroup Scrolling
2709 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2712 * Set the number of pixels one should travel while dragging a
2713 * scroller's view to actually trigger scrolling, for all Elementary
2714 * application windows.
2716 * @param threshold the thumb scroll threshould
2718 * @see elm_thumbscroll_threshould_get()
2719 * @ingroup Scrolling
2721 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2724 * Get the minimum speed of mouse cursor movement which will trigger
2725 * list self scrolling animation after a mouse up event
2728 * @return the thumb scroll momentum threshould
2730 * @ingroup Scrolling
2732 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
2735 * Set the minimum speed of mouse cursor movement which will trigger
2736 * list self scrolling animation after a mouse up event
2739 * @param threshold the thumb scroll momentum threshould
2741 * @see elm_thumbscroll_momentum_threshould_get()
2742 * @ingroup Scrolling
2744 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
2747 * Set the minimum speed of mouse cursor movement which will trigger
2748 * list self scrolling animation after a mouse up event
2749 * (pixels/second), for all Elementary application windows.
2751 * @param threshold the thumb scroll momentum threshould
2753 * @see elm_thumbscroll_momentum_threshould_get()
2754 * @ingroup Scrolling
2756 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
2759 * Get the amount of inertia a scroller will impose at self scrolling
2762 * @return the thumb scroll friction
2764 * @ingroup Scrolling
2766 EAPI double elm_scroll_thumbscroll_friction_get(void);
2769 * Set the amount of inertia a scroller will impose at self scrolling
2772 * @param friction the thumb scroll friction
2774 * @see elm_thumbscroll_friction_get()
2775 * @ingroup Scrolling
2777 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
2780 * Set the amount of inertia a scroller will impose at self scrolling
2781 * animations, for all Elementary application windows.
2783 * @param friction the thumb scroll friction
2785 * @see elm_thumbscroll_friction_get()
2786 * @ingroup Scrolling
2788 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
2791 * Get the amount of lag between your actual mouse cursor dragging
2792 * movement and a scroller's view movement itself, while pushing it
2793 * into bounce state manually.
2795 * @return the thumb scroll border friction
2797 * @ingroup Scrolling
2799 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
2802 * Set the amount of lag between your actual mouse cursor dragging
2803 * movement and a scroller's view movement itself, while pushing it
2804 * into bounce state manually.
2806 * @param friction the thumb scroll border friction. @c 0.0 for
2807 * perfect synchrony between two movements, @c 1.0 for maximum
2810 * @see elm_thumbscroll_border_friction_get()
2811 * @note parameter value will get bound to 0.0 - 1.0 interval, always
2813 * @ingroup Scrolling
2815 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
2818 * Set the amount of lag between your actual mouse cursor dragging
2819 * movement and a scroller's view movement itself, while pushing it
2820 * into bounce state manually, for all Elementary application windows.
2822 * @param friction the thumb scroll border friction. @c 0.0 for
2823 * perfect synchrony between two movements, @c 1.0 for maximum
2826 * @see elm_thumbscroll_border_friction_get()
2827 * @note parameter value will get bound to 0.0 - 1.0 interval, always
2829 * @ingroup Scrolling
2831 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
2838 * @defgroup Scrollhints Scrollhints
2840 * Objects when inside a scroller can scroll, but this may not always be
2841 * desirable in certain situations. This allows an object to hint to itself
2842 * and parents to "not scroll" in one of 2 ways. If any child object of a
2843 * scroller has pushed a scroll freeze or hold then it affects all parent
2844 * scrollers until all children have released them.
2846 * 1. To hold on scrolling. This means just flicking and dragging may no
2847 * longer scroll, but pressing/dragging near an edge of the scroller will
2848 * still scroll. This is automatically used by the entry object when
2851 * 2. To totally freeze scrolling. This means it stops. until
2858 * Push the scroll hold by 1
2860 * This increments the scroll hold count by one. If it is more than 0 it will
2861 * take effect on the parents of the indicated object.
2863 * @param obj The object
2864 * @ingroup Scrollhints
2866 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2869 * Pop the scroll hold by 1
2871 * This decrements the scroll hold count by one. If it is more than 0 it will
2872 * take effect on the parents of the indicated object.
2874 * @param obj The object
2875 * @ingroup Scrollhints
2877 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2880 * Push the scroll freeze by 1
2882 * This increments the scroll freeze count by one. If it is more
2883 * than 0 it will take effect on the parents of the indicated
2886 * @param obj The object
2887 * @ingroup Scrollhints
2889 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2892 * Pop the scroll freeze by 1
2894 * This decrements the scroll freeze count by one. If it is more
2895 * than 0 it will take effect on the parents of the indicated
2898 * @param obj The object
2899 * @ingroup Scrollhints
2901 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2904 * Lock the scrolling of the given widget (and thus all parents)
2906 * This locks the given object from scrolling in the X axis (and implicitly
2907 * also locks all parent scrollers too from doing the same).
2909 * @param obj The object
2910 * @param lock The lock state (1 == locked, 0 == unlocked)
2911 * @ingroup Scrollhints
2913 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2916 * Lock the scrolling of the given widget (and thus all parents)
2918 * This locks the given object from scrolling in the Y axis (and implicitly
2919 * also locks all parent scrollers too from doing the same).
2921 * @param obj The object
2922 * @param lock The lock state (1 == locked, 0 == unlocked)
2923 * @ingroup Scrollhints
2925 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2928 * Get the scrolling lock of the given widget
2930 * This gets the lock for X axis scrolling.
2932 * @param obj The object
2933 * @ingroup Scrollhints
2935 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2938 * Get the scrolling lock of the given widget
2940 * This gets the lock for X axis scrolling.
2942 * @param obj The object
2943 * @ingroup Scrollhints
2945 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2952 * Send a signal to the widget edje object.
2954 * This function sends a signal to the edje object of the obj. An
2955 * edje program can respond to a signal by specifying matching
2956 * 'signal' and 'source' fields.
2958 * @param obj The object
2959 * @param emission The signal's name.
2960 * @param source The signal's source.
2963 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
2966 * Add a callback for a signal emitted by widget edje object.
2968 * This function connects a callback function to a signal emitted by the
2969 * edje object of the obj.
2970 * Globs can occur in either the emission or source name.
2972 * @param obj The object
2973 * @param emission The signal's name.
2974 * @param source The signal's source.
2975 * @param func The callback function to be executed when the signal is
2977 * @param data A pointer to data to pass in to the callback function.
2980 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);
2983 * Remove a signal-triggered callback from a widget edje object.
2985 * This function removes a callback, previoulsy attached to a
2986 * signal emitted by the edje object of the obj. The parameters
2987 * emission, source and func must match exactly those passed to a
2988 * previous call to elm_object_signal_callback_add(). The data
2989 * pointer that was passed to this call will be returned.
2991 * @param obj The object
2992 * @param emission The signal's name.
2993 * @param source The signal's source.
2994 * @param func The callback function to be executed when the signal is
2996 * @return The data pointer
2999 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);
3002 * Add a callback for input events (key up, key down, mouse wheel)
3003 * on a given Elementary widget
3005 * @param obj The widget to add an event callback on
3006 * @param func The callback function to be executed when the event
3008 * @param data Data to pass in to @p func
3010 * Every widget in an Elementary interface set to receive focus,
3011 * with elm_object_focus_allow_set(), will propagate @b all of its
3012 * key up, key down and mouse wheel input events up to its parent
3013 * object, and so on. All of the focusable ones in this chain which
3014 * had an event callback set, with this call, will be able to treat
3015 * those events. There are two ways of making the propagation of
3016 * these event upwards in the tree of widgets to @b cease:
3017 * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
3018 * the event was @b not processed, so the propagation will go on.
3019 * - The @c event_info pointer passed to @p func will contain the
3020 * event's structure and, if you OR its @c event_flags inner
3021 * value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
3022 * one has already handled it, thus killing the event's
3025 * @note Your event callback will be issued on those events taking
3026 * place only if no other child widget of @obj has consumed the
3029 * @note Not to be confused with @c
3030 * evas_object_event_callback_add(), which will add event callbacks
3031 * per type on general Evas objects (no event propagation
3032 * infrastructure taken in account).
3034 * @note Not to be confused with @c
3035 * elm_object_signal_callback_add(), which will add callbacks to @b
3036 * signals coming from a widget's theme, not input events.
3038 * @note Not to be confused with @c
3039 * edje_object_signal_callback_add(), which does the same as
3040 * elm_object_signal_callback_add(), but directly on an Edje
3043 * @note Not to be confused with @c
3044 * evas_object_smart_callback_add(), which adds callbacks to smart
3045 * objects' <b>smart events</b>, and not input events.
3047 * @see elm_object_event_callback_del()
3051 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3054 * Remove an event callback from a widget.
3056 * This function removes a callback, previoulsy attached to event emission
3058 * The parameters func and data must match exactly those passed to
3059 * a previous call to elm_object_event_callback_add(). The data pointer that
3060 * was passed to this call will be returned.
3062 * @param obj The object
3063 * @param func The callback function to be executed when the event is
3065 * @param data Data to pass in to the callback function.
3066 * @return The data pointer
3069 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3072 * Adjust size of an element for finger usage.
3074 * @param times_w How many fingers should fit horizontally
3075 * @param w Pointer to the width size to adjust
3076 * @param times_h How many fingers should fit vertically
3077 * @param h Pointer to the height size to adjust
3079 * This takes width and height sizes (in pixels) as input and a
3080 * size multiple (which is how many fingers you want to place
3081 * within the area, being "finger" the size set by
3082 * elm_finger_size_set()), and adjusts the size to be large enough
3083 * to accommodate the resulting size -- if it doesn't already
3084 * accommodate it. On return the @p w and @p h sizes pointed to by
3085 * these parameters will be modified, on those conditions.
3087 * @note This is kind of a low level Elementary call, most useful
3088 * on size evaluation times for widgets. An external user wouldn't
3089 * be calling, most of the time.
3093 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
3096 * Get the duration for occuring long press event.
3098 * @return Timeout for long press event
3099 * @ingroup Longpress
3101 EAPI double elm_longpress_timeout_get(void);
3104 * Set the duration for occuring long press event.
3106 * @param lonpress_timeout Timeout for long press event
3107 * @ingroup Longpress
3109 EAPI void elm_longpress_timeout_set(double longpress_timeout);
3112 * @defgroup Debug Debug
3113 * don't use it unless you are sure
3119 * Print Tree object hierarchy in stdout
3121 * @param obj The root object
3124 EAPI void elm_object_tree_dump(const Evas_Object *top);
3127 * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3129 * @param obj The root object
3130 * @param file The path of output file
3133 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3140 * @defgroup Theme Theme
3142 * Elementary uses Edje to theme its widgets, naturally. But for the most
3143 * part this is hidden behind a simpler interface that lets the user set
3144 * extensions and choose the style of widgets in a much easier way.
3146 * Instead of thinking in terms of paths to Edje files and their groups
3147 * each time you want to change the appearance of a widget, Elementary
3148 * works so you can add any theme file with extensions or replace the
3149 * main theme at one point in the application, and then just set the style
3150 * of widgets with elm_object_style_set() and related functions. Elementary
3151 * will then look in its list of themes for a matching group and apply it,
3152 * and when the theme changes midway through the application, all widgets
3153 * will be updated accordingly.
3155 * There are three concepts you need to know to understand how Elementary
3156 * theming works: default theme, extensions and overlays.
3158 * Default theme, obviously enough, is the one that provides the default
3159 * look of all widgets. End users can change the theme used by Elementary
3160 * by setting the @c ELM_THEME environment variable before running an
3161 * application, or globally for all programs using the @c elementary_config
3162 * utility. Applications can change the default theme using elm_theme_set(),
3163 * but this can go against the user wishes, so it's not an adviced practice.
3165 * Ideally, applications should find everything they need in the already
3166 * provided theme, but there may be occasions when that's not enough and
3167 * custom styles are required to correctly express the idea. For this
3168 * cases, Elementary has extensions.
3170 * Extensions allow the application developer to write styles of its own
3171 * to apply to some widgets. This requires knowledge of how each widget
3172 * is themed, as extensions will always replace the entire group used by
3173 * the widget, so important signals and parts need to be there for the
3174 * object to behave properly (see documentation of Edje for details).
3175 * Once the theme for the extension is done, the application needs to add
3176 * it to the list of themes Elementary will look into, using
3177 * elm_theme_extension_add(), and set the style of the desired widgets as
3178 * he would normally with elm_object_style_set().
3180 * Overlays, on the other hand, can replace the look of all widgets by
3181 * overriding the default style. Like extensions, it's up to the application
3182 * developer to write the theme for the widgets it wants, the difference
3183 * being that when looking for the theme, Elementary will check first the
3184 * list of overlays, then the set theme and lastly the list of extensions,
3185 * so with overlays it's possible to replace the default view and every
3186 * widget will be affected. This is very much alike to setting the whole
3187 * theme for the application and will probably clash with the end user
3188 * options, not to mention the risk of ending up with not matching styles
3189 * across the program. Unless there's a very special reason to use them,
3190 * overlays should be avoided for the resons exposed before.
3192 * All these theme lists are handled by ::Elm_Theme instances. Elementary
3193 * keeps one default internally and every function that receives one of
3194 * these can be called with NULL to refer to this default (except for
3195 * elm_theme_free()). It's possible to create a new instance of a
3196 * ::Elm_Theme to set other theme for a specific widget (and all of its
3197 * children), but this is as discouraged, if not even more so, than using
3198 * overlays. Don't use this unless you really know what you are doing.
3200 * But to be less negative about things, you can look at the following
3202 * @li @ref theme_example_01 "Using extensions"
3203 * @li @ref theme_example_02 "Using overlays"
3208 * @typedef Elm_Theme
3210 * Opaque handler for the list of themes Elementary looks for when
3211 * rendering widgets.
3213 * Stay out of this unless you really know what you are doing. For most
3214 * cases, sticking to the default is all a developer needs.
3216 typedef struct _Elm_Theme Elm_Theme;
3219 * Create a new specific theme
3221 * This creates an empty specific theme that only uses the default theme. A
3222 * specific theme has its own private set of extensions and overlays too
3223 * (which are empty by default). Specific themes do not fall back to themes
3224 * of parent objects. They are not intended for this use. Use styles, overlays
3225 * and extensions when needed, but avoid specific themes unless there is no
3226 * other way (example: you want to have a preview of a new theme you are
3227 * selecting in a "theme selector" window. The preview is inside a scroller
3228 * and should display what the theme you selected will look like, but not
3229 * actually apply it yet. The child of the scroller will have a specific
3230 * theme set to show this preview before the user decides to apply it to all
3233 EAPI Elm_Theme *elm_theme_new(void);
3235 * Free a specific theme
3237 * @param th The theme to free
3239 * This frees a theme created with elm_theme_new().
3241 EAPI void elm_theme_free(Elm_Theme *th);
3243 * Copy the theme fom the source to the destination theme
3245 * @param th The source theme to copy from
3246 * @param thdst The destination theme to copy data to
3248 * This makes a one-time static copy of all the theme config, extensions
3249 * and overlays from @p th to @p thdst. If @p th references a theme, then
3250 * @p thdst is also set to reference it, with all the theme settings,
3251 * overlays and extensions that @p th had.
3253 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3255 * Tell the source theme to reference the ref theme
3257 * @param th The theme that will do the referencing
3258 * @param thref The theme that is the reference source
3260 * This clears @p th to be empty and then sets it to refer to @p thref
3261 * so @p th acts as an override to @p thref, but where its overrides
3262 * don't apply, it will fall through to @p thref for configuration.
3264 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3266 * Return the theme referred to
3268 * @param th The theme to get the reference from
3269 * @return The referenced theme handle
3271 * This gets the theme set as the reference theme by elm_theme_ref_set().
3272 * If no theme is set as a reference, NULL is returned.
3274 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
3276 * Return the default theme
3278 * @return The default theme handle
3280 * This returns the internal default theme setup handle that all widgets
3281 * use implicitly unless a specific theme is set. This is also often use
3282 * as a shorthand of NULL.
3284 EAPI Elm_Theme *elm_theme_default_get(void);
3286 * Prepends a theme overlay to the list of overlays
3288 * @param th The theme to add to, or if NULL, the default theme
3289 * @param item The Edje file path to be used
3291 * Use this if your application needs to provide some custom overlay theme
3292 * (An Edje file that replaces some default styles of widgets) where adding
3293 * new styles, or changing system theme configuration is not possible. Do
3294 * NOT use this instead of a proper system theme configuration. Use proper
3295 * configuration files, profiles, environment variables etc. to set a theme
3296 * so that the theme can be altered by simple confiugration by a user. Using
3297 * this call to achieve that effect is abusing the API and will create lots
3300 * @see elm_theme_extension_add()
3302 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
3304 * Delete a theme overlay from the list of overlays
3306 * @param th The theme to delete from, or if NULL, the default theme
3307 * @param item The name of the theme overlay
3309 * @see elm_theme_overlay_add()
3311 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
3313 * Appends a theme extension to the list of extensions.
3315 * @param th The theme to add to, or if NULL, the default theme
3316 * @param item The Edje file path to be used
3318 * This is intended when an application needs more styles of widgets or new
3319 * widget themes that the default does not provide (or may not provide). The
3320 * application has "extended" usage by coming up with new custom style names
3321 * for widgets for specific uses, but as these are not "standard", they are
3322 * not guaranteed to be provided by a default theme. This means the
3323 * application is required to provide these extra elements itself in specific
3324 * Edje files. This call adds one of those Edje files to the theme search
3325 * path to be search after the default theme. The use of this call is
3326 * encouraged when default styles do not meet the needs of the application.
3327 * Use this call instead of elm_theme_overlay_add() for almost all cases.
3329 * @see elm_object_style_set()
3331 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
3333 * Deletes a theme extension from the list of extensions.
3335 * @param th The theme to delete from, or if NULL, the default theme
3336 * @param item The name of the theme extension
3338 * @see elm_theme_extension_add()
3340 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
3342 * Set the theme search order for the given theme
3344 * @param th The theme to set the search order, or if NULL, the default theme
3345 * @param theme Theme search string
3347 * This sets the search string for the theme in path-notation from first
3348 * theme to search, to last, delimited by the : character. Example:
3350 * "shiny:/path/to/file.edj:default"
3352 * See the ELM_THEME environment variable for more information.
3354 * @see elm_theme_get()
3355 * @see elm_theme_list_get()
3357 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
3359 * Return the theme search order
3361 * @param th The theme to get the search order, or if NULL, the default theme
3362 * @return The internal search order path
3364 * This function returns a colon separated string of theme elements as
3365 * returned by elm_theme_list_get().
3367 * @see elm_theme_set()
3368 * @see elm_theme_list_get()
3370 EAPI const char *elm_theme_get(Elm_Theme *th);
3372 * Return a list of theme elements to be used in a theme.
3374 * @param th Theme to get the list of theme elements from.
3375 * @return The internal list of theme elements
3377 * This returns the internal list of theme elements (will only be valid as
3378 * long as the theme is not modified by elm_theme_set() or theme is not
3379 * freed by elm_theme_free(). This is a list of strings which must not be
3380 * altered as they are also internal. If @p th is NULL, then the default
3381 * theme element list is returned.
3383 * A theme element can consist of a full or relative path to a .edj file,
3384 * or a name, without extension, for a theme to be searched in the known
3385 * theme paths for Elemementary.
3387 * @see elm_theme_set()
3388 * @see elm_theme_get()
3390 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3392 * Return the full patrh for a theme element
3394 * @param f The theme element name
3395 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3396 * @return The full path to the file found.
3398 * This returns a string you should free with free() on success, NULL on
3399 * failure. This will search for the given theme element, and if it is a
3400 * full or relative path element or a simple searchable name. The returned
3401 * path is the full path to the file, if searched, and the file exists, or it
3402 * is simply the full path given in the element or a resolved path if
3403 * relative to home. The @p in_search_path boolean pointed to is set to
3404 * EINA_TRUE if the file was a searchable file andis in the search path,
3405 * and EINA_FALSE otherwise.
3407 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3409 * Flush the current theme.
3411 * @param th Theme to flush
3413 * This flushes caches that let elementary know where to find theme elements
3414 * in the given theme. If @p th is NULL, then the default theme is flushed.
3415 * Call this function if source theme data has changed in such a way as to
3416 * make any caches Elementary kept invalid.
3418 EAPI void elm_theme_flush(Elm_Theme *th);
3420 * This flushes all themes (default and specific ones).
3422 * This will flush all themes in the current application context, by calling
3423 * elm_theme_flush() on each of them.
3425 EAPI void elm_theme_full_flush(void);
3427 * Set the theme for all elementary using applications on the current display
3429 * @param theme The name of the theme to use. Format same as the ELM_THEME
3430 * environment variable.
3432 EAPI void elm_theme_all_set(const char *theme);
3434 * Return a list of theme elements in the theme search path
3436 * @return A list of strings that are the theme element names.
3438 * This lists all available theme files in the standard Elementary search path
3439 * for theme elements, and returns them in alphabetical order as theme
3440 * element names in a list of strings. Free this with
3441 * elm_theme_name_available_list_free() when you are done with the list.
3443 EAPI Eina_List *elm_theme_name_available_list_new(void);
3445 * Free the list returned by elm_theme_name_available_list_new()
3447 * This frees the list of themes returned by
3448 * elm_theme_name_available_list_new(). Once freed the list should no longer
3449 * be used. a new list mys be created.
3451 EAPI void elm_theme_name_available_list_free(Eina_List *list);
3453 * Set a specific theme to be used for this object and its children
3455 * @param obj The object to set the theme on
3456 * @param th The theme to set
3458 * This sets a specific theme that will be used for the given object and any
3459 * child objects it has. If @p th is NULL then the theme to be used is
3460 * cleared and the object will inherit its theme from its parent (which
3461 * ultimately will use the default theme if no specific themes are set).
3463 * Use special themes with great care as this will annoy users and make
3464 * configuration difficult. Avoid any custom themes at all if it can be
3467 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3469 * Get the specific theme to be used
3471 * @param obj The object to get the specific theme from
3472 * @return The specifc theme set.
3474 * This will return a specific theme set, or NULL if no specific theme is
3475 * set on that object. It will not return inherited themes from parents, only
3476 * the specific theme set for that specific object. See elm_object_theme_set()
3477 * for more information.
3479 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3482 * Get a data item from a theme
3484 * @param th The theme, or NULL for default theme
3485 * @param key The data key to search with
3486 * @return The data value, or NULL on failure
3488 * This function is used to return data items from edc in @p th, an overlay, or an extension.
3489 * It works the same way as edje_file_data_get() except that the return is stringshared.
3491 EAPI const char *elm_theme_data_get(Elm_Theme *th, const char *key) EINA_ARG_NONNULL(2);
3497 /** @defgroup Win Win
3499 * @image html img/widget/win/preview-00.png
3500 * @image latex img/widget/win/preview-00.eps
3502 * The window class of Elementary. Contains functions to manipulate
3503 * windows. The Evas engine used to render the window contents is specified
3504 * in the system or user elementary config files (whichever is found last),
3505 * and can be overridden with the ELM_ENGINE environment variable for
3506 * testing. Engines that may be supported (depending on Evas and Ecore-Evas
3507 * compilation setup and modules actually installed at runtime) are (listed
3508 * in order of best supported and most likely to be complete and work to
3511 * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3512 * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3514 * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3516 * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3518 * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3520 * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3521 * rendering using SDL as the buffer)
3522 * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3523 * GDI with software)
3524 * @li "dfb", "directfb" (Rendering to a DirectFB window)
3525 * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3526 * grayscale using dedicated 8bit software engine in X11)
3527 * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3528 * X11 using 16bit software engine)
3529 * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3530 * (Windows CE rendering via GDI with 16bit software renderer)
3531 * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3532 * buffer with 16bit software renderer)
3533 * @li "ews" (rendering to EWS - Ecore + Evas Single Process Windowing System)
3535 * All engines use a simple string to select the engine to render, EXCEPT
3536 * the "shot" engine. This actually encodes the output of the virtual
3537 * screenshot and how long to delay in the engine string. The engine string
3538 * is encoded in the following way:
3540 * "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3542 * Where options are separated by a ":" char if more than one option is
3543 * given, with delay, if provided being the first option and file the last
3544 * (order is important). The delay specifies how long to wait after the
3545 * window is shown before doing the virtual "in memory" rendering and then
3546 * save the output to the file specified by the file option (and then exit).
3547 * If no delay is given, the default is 0.5 seconds. If no file is given the
3548 * default output file is "out.png". Repeat option is for continous
3549 * capturing screenshots. Repeat range is from 1 to 999 and filename is
3550 * fixed to "out001.png" Some examples of using the shot engine:
3552 * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3553 * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3554 * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3555 * ELM_ENGINE="shot:delay=2.0" elementary_test
3556 * ELM_ENGINE="shot:" elementary_test
3558 * Signals that you can add callbacks for are:
3560 * @li "delete,request": the user requested to close the window. See
3561 * elm_win_autodel_set().
3562 * @li "focus,in": window got focus
3563 * @li "focus,out": window lost focus
3564 * @li "moved": window that holds the canvas was moved
3567 * @li @ref win_example_01
3572 * Defines the types of window that can be created
3574 * These are hints set on the window so that a running Window Manager knows
3575 * how the window should be handled and/or what kind of decorations it
3578 * Currently, only the X11 backed engines use them.
3580 typedef enum _Elm_Win_Type
3582 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3583 window. Almost every window will be created with this
3585 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3586 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3587 window holding desktop icons. */
3588 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3589 be kept on top of any other window by the Window
3591 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3593 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3594 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3596 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3597 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3598 entry in a menubar is clicked. Typically used
3599 with elm_win_override_set(). This hint exists
3600 for completion only, as the EFL way of
3601 implementing a menu would not normally use a
3602 separate window for its contents. */
3603 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3604 triggered by right-clicking an object. */
3605 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3606 explanatory text that typically appear after the
3607 mouse cursor hovers over an object for a while.
3608 Typically used with elm_win_override_set() and also
3609 not very commonly used in the EFL. */
3610 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3611 battery life or a new E-Mail received. */
3612 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3613 usually used in the EFL. */
3614 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3615 object being dragged across different windows, or even
3616 applications. Typically used with
3617 elm_win_override_set(). */
3618 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3619 buffer. No actual window is created for this
3620 type, instead the window and all of its
3621 contents will be rendered to an image buffer.
3622 This allows to have children window inside a
3623 parent one just like any other object would
3624 be, and do other things like applying @c
3625 Evas_Map effects to it. This is the only type
3626 of window that requires the @c parent
3627 parameter of elm_win_add() to be a valid @c
3632 * The differents layouts that can be requested for the virtual keyboard.
3634 * When the application window is being managed by Illume, it may request
3635 * any of the following layouts for the virtual keyboard.
3637 typedef enum _Elm_Win_Keyboard_Mode
3639 ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3640 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3641 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3642 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3643 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3644 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3645 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3646 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3647 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3648 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3649 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3650 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3651 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3652 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3653 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3654 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3655 } Elm_Win_Keyboard_Mode;
3658 * Available commands that can be sent to the Illume manager.
3660 * When running under an Illume session, a window may send commands to the
3661 * Illume manager to perform different actions.
3663 typedef enum _Elm_Illume_Command
3665 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3667 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3669 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3671 ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3672 } Elm_Illume_Command;
3675 * Adds a window object. If this is the first window created, pass NULL as
3678 * @param parent Parent object to add the window to, or NULL
3679 * @param name The name of the window
3680 * @param type The window type, one of #Elm_Win_Type.
3682 * The @p parent paramter can be @c NULL for every window @p type except
3683 * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3684 * which the image object will be created.
3686 * @return The created object, or NULL on failure
3688 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3690 * Add @p subobj as a resize object of window @p obj.
3693 * Setting an object as a resize object of the window means that the
3694 * @p subobj child's size and position will be controlled by the window
3695 * directly. That is, the object will be resized to match the window size
3696 * and should never be moved or resized manually by the developer.
3698 * In addition, resize objects of the window control what the minimum size
3699 * of it will be, as well as whether it can or not be resized by the user.
3701 * For the end user to be able to resize a window by dragging the handles
3702 * or borders provided by the Window Manager, or using any other similar
3703 * mechanism, all of the resize objects in the window should have their
3704 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
3706 * @param obj The window object
3707 * @param subobj The resize object to add
3709 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3711 * Delete @p subobj as a resize object of window @p obj.
3713 * This function removes the object @p subobj from the resize objects of
3714 * the window @p obj. It will not delete the object itself, which will be
3715 * left unmanaged and should be deleted by the developer, manually handled
3716 * or set as child of some other container.
3718 * @param obj The window object
3719 * @param subobj The resize object to add
3721 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3723 * Set the title of the window
3725 * @param obj The window object
3726 * @param title The title to set
3728 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3730 * Get the title of the window
3732 * The returned string is an internal one and should not be freed or
3733 * modified. It will also be rendered invalid if a new title is set or if
3734 * the window is destroyed.
3736 * @param obj The window object
3739 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3741 * Set the window's autodel state.
3743 * When closing the window in any way outside of the program control, like
3744 * pressing the X button in the titlebar or using a command from the
3745 * Window Manager, a "delete,request" signal is emitted to indicate that
3746 * this event occurred and the developer can take any action, which may
3747 * include, or not, destroying the window object.
3749 * When the @p autodel parameter is set, the window will be automatically
3750 * destroyed when this event occurs, after the signal is emitted.
3751 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
3752 * and is up to the program to do so when it's required.
3754 * @param obj The window object
3755 * @param autodel If true, the window will automatically delete itself when
3758 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
3760 * Get the window's autodel state.
3762 * @param obj The window object
3763 * @return If the window will automatically delete itself when closed
3765 * @see elm_win_autodel_set()
3767 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3769 * Activate a window object.
3771 * This function sends a request to the Window Manager to activate the
3772 * window pointed by @p obj. If honored by the WM, the window will receive
3773 * the keyboard focus.
3775 * @note This is just a request that a Window Manager may ignore, so calling
3776 * this function does not ensure in any way that the window will be the
3777 * active one after it.
3779 * @param obj The window object
3781 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
3783 * Lower a window object.
3785 * Places the window pointed by @p obj at the bottom of the stack, so that
3786 * no other window is covered by it.
3788 * If elm_win_override_set() is not set, the Window Manager may ignore this
3791 * @param obj The window object
3793 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
3795 * Raise a window object.
3797 * Places the window pointed by @p obj at the top of the stack, so that it's
3798 * not covered by any other window.
3800 * If elm_win_override_set() is not set, the Window Manager may ignore this
3803 * @param obj The window object
3805 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
3807 * Set the borderless state of a window.
3809 * This function requests the Window Manager to not draw any decoration
3810 * around the window.
3812 * @param obj The window object
3813 * @param borderless If true, the window is borderless
3815 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
3817 * Get the borderless state of a window.
3819 * @param obj The window object
3820 * @return If true, the window is borderless
3822 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3824 * Set the shaped state of a window.
3826 * Shaped windows, when supported, will render the parts of the window that
3827 * has no content, transparent.
3829 * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
3830 * background object or cover the entire window in any other way, or the
3831 * parts of the canvas that have no data will show framebuffer artifacts.
3833 * @param obj The window object
3834 * @param shaped If true, the window is shaped
3836 * @see elm_win_alpha_set()
3838 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
3840 * Get the shaped state of a window.
3842 * @param obj The window object
3843 * @return If true, the window is shaped
3845 * @see elm_win_shaped_set()
3847 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3849 * Set the alpha channel state of a window.
3851 * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
3852 * possibly making parts of the window completely or partially transparent.
3853 * This is also subject to the underlying system supporting it, like for
3854 * example, running under a compositing manager. If no compositing is
3855 * available, enabling this option will instead fallback to using shaped
3856 * windows, with elm_win_shaped_set().
3858 * @param obj The window object
3859 * @param alpha If true, the window has an alpha channel
3861 * @see elm_win_alpha_set()
3863 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
3865 * Get the transparency state of a window.
3867 * @param obj The window object
3868 * @return If true, the window is transparent
3870 * @see elm_win_transparent_set()
3872 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3874 * Set the transparency state of a window.
3876 * Use elm_win_alpha_set() instead.
3878 * @param obj The window object
3879 * @param transparent If true, the window is transparent
3881 * @see elm_win_alpha_set()
3883 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
3885 * Get the alpha channel state of a window.
3887 * @param obj The window object
3888 * @return If true, the window has an alpha channel
3890 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3892 * Set the override state of a window.
3894 * A window with @p override set to EINA_TRUE will not be managed by the
3895 * Window Manager. This means that no decorations of any kind will be shown
3896 * for it, moving and resizing must be handled by the application, as well
3897 * as the window visibility.
3899 * This should not be used for normal windows, and even for not so normal
3900 * ones, it should only be used when there's a good reason and with a lot
3901 * of care. Mishandling override windows may result situations that
3902 * disrupt the normal workflow of the end user.
3904 * @param obj The window object
3905 * @param override If true, the window is overridden
3907 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
3909 * Get the override state of a window.
3911 * @param obj The window object
3912 * @return If true, the window is overridden
3914 * @see elm_win_override_set()
3916 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3918 * Set the fullscreen state of a window.
3920 * @param obj The window object
3921 * @param fullscreen If true, the window is fullscreen
3923 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
3925 * Get the fullscreen state of a window.
3927 * @param obj The window object
3928 * @return If true, the window is fullscreen
3930 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3932 * Set the maximized state of a window.
3934 * @param obj The window object
3935 * @param maximized If true, the window is maximized
3937 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
3939 * Get the maximized state of a window.
3941 * @param obj The window object
3942 * @return If true, the window is maximized
3944 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3946 * Set the iconified state of a window.
3948 * @param obj The window object
3949 * @param iconified If true, the window is iconified
3951 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
3953 * Get the iconified state of a window.
3955 * @param obj The window object
3956 * @return If true, the window is iconified
3958 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3960 * Set the layer of the window.
3962 * What this means exactly will depend on the underlying engine used.
3964 * In the case of X11 backed engines, the value in @p layer has the
3965 * following meanings:
3966 * @li < 3: The window will be placed below all others.
3967 * @li > 5: The window will be placed above all others.
3968 * @li other: The window will be placed in the default layer.
3970 * @param obj The window object
3971 * @param layer The layer of the window
3973 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
3975 * Get the layer of the window.
3977 * @param obj The window object
3978 * @return The layer of the window
3980 * @see elm_win_layer_set()
3982 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3984 * Set the rotation of the window.
3986 * Most engines only work with multiples of 90.
3988 * This function is used to set the orientation of the window @p obj to
3989 * match that of the screen. The window itself will be resized to adjust
3990 * to the new geometry of its contents. If you want to keep the window size,
3991 * see elm_win_rotation_with_resize_set().
3993 * @param obj The window object
3994 * @param rotation The rotation of the window, in degrees (0-360),
3995 * counter-clockwise.
3997 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
3999 * Rotates the window and resizes it.
4001 * Like elm_win_rotation_set(), but it also resizes the window's contents so
4002 * that they fit inside the current window geometry.
4004 * @param obj The window object
4005 * @param layer The rotation of the window in degrees (0-360),
4006 * counter-clockwise.
4008 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4010 * Get the rotation of the window.
4012 * @param obj The window object
4013 * @return The rotation of the window in degrees (0-360)
4015 * @see elm_win_rotation_set()
4016 * @see elm_win_rotation_with_resize_set()
4018 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4020 * Set the sticky state of the window.
4022 * Hints the Window Manager that the window in @p obj should be left fixed
4023 * at its position even when the virtual desktop it's on moves or changes.
4025 * @param obj The window object
4026 * @param sticky If true, the window's sticky state is enabled
4028 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
4030 * Get the sticky state of the window.
4032 * @param obj The window object
4033 * @return If true, the window's sticky state is enabled
4035 * @see elm_win_sticky_set()
4037 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4039 * Set if this window is an illume conformant window
4041 * @param obj The window object
4042 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
4044 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
4046 * Get if this window is an illume conformant window
4048 * @param obj The window object
4049 * @return A boolean if this window is illume conformant or not
4051 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4053 * Set a window to be an illume quickpanel window
4055 * By default window objects are not quickpanel windows.
4057 * @param obj The window object
4058 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4060 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4062 * Get if this window is a quickpanel or not
4064 * @param obj The window object
4065 * @return A boolean if this window is a quickpanel or not
4067 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4069 * Set the major priority of a quickpanel window
4071 * @param obj The window object
4072 * @param priority The major priority for this quickpanel
4074 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4076 * Get the major priority of a quickpanel window
4078 * @param obj The window object
4079 * @return The major priority of this quickpanel
4081 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4083 * Set the minor priority of a quickpanel window
4085 * @param obj The window object
4086 * @param priority The minor priority for this quickpanel
4088 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4090 * Get the minor priority of a quickpanel window
4092 * @param obj The window object
4093 * @return The minor priority of this quickpanel
4095 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4097 * Set which zone this quickpanel should appear in
4099 * @param obj The window object
4100 * @param zone The requested zone for this quickpanel
4102 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4104 * Get which zone this quickpanel should appear in
4106 * @param obj The window object
4107 * @return The requested zone for this quickpanel
4109 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4111 * Set the window to be skipped by keyboard focus
4113 * This sets the window to be skipped by normal keyboard input. This means
4114 * a window manager will be asked to not focus this window as well as omit
4115 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4117 * Call this and enable it on a window BEFORE you show it for the first time,
4118 * otherwise it may have no effect.
4120 * Use this for windows that have only output information or might only be
4121 * interacted with by the mouse or fingers, and never for typing input.
4122 * Be careful that this may have side-effects like making the window
4123 * non-accessible in some cases unless the window is specially handled. Use
4126 * @param obj The window object
4127 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4129 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4131 * Send a command to the windowing environment
4133 * This is intended to work in touchscreen or small screen device
4134 * environments where there is a more simplistic window management policy in
4135 * place. This uses the window object indicated to select which part of the
4136 * environment to control (the part that this window lives in), and provides
4137 * a command and an optional parameter structure (use NULL for this if not
4140 * @param obj The window object that lives in the environment to control
4141 * @param command The command to send
4142 * @param params Optional parameters for the command
4144 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4146 * Get the inlined image object handle
4148 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4149 * then the window is in fact an evas image object inlined in the parent
4150 * canvas. You can get this object (be careful to not manipulate it as it
4151 * is under control of elementary), and use it to do things like get pixel
4152 * data, save the image to a file, etc.
4154 * @param obj The window object to get the inlined image from
4155 * @return The inlined image object, or NULL if none exists
4157 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4159 * Set the enabled status for the focus highlight in a window
4161 * This function will enable or disable the focus highlight only for the
4162 * given window, regardless of the global setting for it
4164 * @param obj The window where to enable the highlight
4165 * @param enabled The enabled value for the highlight
4167 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4169 * Get the enabled value of the focus highlight for this window
4171 * @param obj The window in which to check if the focus highlight is enabled
4173 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4175 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4177 * Set the style for the focus highlight on this window
4179 * Sets the style to use for theming the highlight of focused objects on
4180 * the given window. If @p style is NULL, the default will be used.
4182 * @param obj The window where to set the style
4183 * @param style The style to set
4185 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4187 * Get the style set for the focus highlight object
4189 * Gets the style set for this windows highilght object, or NULL if none
4192 * @param obj The window to retrieve the highlights style from
4194 * @return The style set or NULL if none was. Default is used in that case.
4196 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4198 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4199 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4200 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4201 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4202 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4203 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4204 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4206 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4207 * (blank mouse, private mouse obj, defaultmouse)
4211 * Sets the keyboard mode of the window.
4213 * @param obj The window object
4214 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4216 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4218 * Gets the keyboard mode of the window.
4220 * @param obj The window object
4221 * @return The mode, one of #Elm_Win_Keyboard_Mode
4223 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4225 * Sets whether the window is a keyboard.
4227 * @param obj The window object
4228 * @param is_keyboard If true, the window is a virtual keyboard
4230 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4232 * Gets whether the window is a keyboard.
4234 * @param obj The window object
4235 * @return If the window is a virtual keyboard
4237 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4240 * Get the screen position of a window.
4242 * @param obj The window object
4243 * @param x The int to store the x coordinate to
4244 * @param y The int to store the y coordinate to
4246 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4252 * @defgroup Inwin Inwin
4254 * @image html img/widget/inwin/preview-00.png
4255 * @image latex img/widget/inwin/preview-00.eps
4256 * @image html img/widget/inwin/preview-01.png
4257 * @image latex img/widget/inwin/preview-01.eps
4258 * @image html img/widget/inwin/preview-02.png
4259 * @image latex img/widget/inwin/preview-02.eps
4261 * An inwin is a window inside a window that is useful for a quick popup.
4262 * It does not hover.
4264 * It works by creating an object that will occupy the entire window, so it
4265 * must be created using an @ref Win "elm_win" as parent only. The inwin
4266 * object can be hidden or restacked below every other object if it's
4267 * needed to show what's behind it without destroying it. If this is done,
4268 * the elm_win_inwin_activate() function can be used to bring it back to
4269 * full visibility again.
4271 * There are three styles available in the default theme. These are:
4272 * @li default: The inwin is sized to take over most of the window it's
4274 * @li minimal: The size of the inwin will be the minimum necessary to show
4276 * @li minimal_vertical: Horizontally, the inwin takes as much space as
4277 * possible, but it's sized vertically the most it needs to fit its\
4280 * Some examples of Inwin can be found in the following:
4281 * @li @ref inwin_example_01
4286 * Adds an inwin to the current window
4288 * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4289 * Never call this function with anything other than the top-most window
4290 * as its parameter, unless you are fond of undefined behavior.
4292 * After creating the object, the widget will set itself as resize object
4293 * for the window with elm_win_resize_object_add(), so when shown it will
4294 * appear to cover almost the entire window (how much of it depends on its
4295 * content and the style used). It must not be added into other container
4296 * objects and it needs not be moved or resized manually.
4298 * @param parent The parent object
4299 * @return The new object or NULL if it cannot be created
4301 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4303 * Activates an inwin object, ensuring its visibility
4305 * This function will make sure that the inwin @p obj is completely visible
4306 * by calling evas_object_show() and evas_object_raise() on it, to bring it
4307 * to the front. It also sets the keyboard focus to it, which will be passed
4310 * The object's theme will also receive the signal "elm,action,show" with
4313 * @param obj The inwin to activate
4315 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4317 * Set the content of an inwin object.
4319 * Once the content object is set, a previously set one will be deleted.
4320 * If you want to keep that old content object, use the
4321 * elm_win_inwin_content_unset() function.
4323 * @param obj The inwin object
4324 * @param content The object to set as content
4326 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4328 * Get the content of an inwin object.
4330 * Return the content object which is set for this widget.
4332 * The returned object is valid as long as the inwin is still alive and no
4333 * other content is set on it. Deleting the object will notify the inwin
4334 * about it and this one will be left empty.
4336 * If you need to remove an inwin's content to be reused somewhere else,
4337 * see elm_win_inwin_content_unset().
4339 * @param obj The inwin object
4340 * @return The content that is being used
4342 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4344 * Unset the content of an inwin object.
4346 * Unparent and return the content object which was set for this widget.
4348 * @param obj The inwin object
4349 * @return The content that was being used
4351 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4355 /* X specific calls - won't work on non-x engines (return 0) */
4358 * Get the Ecore_X_Window of an Evas_Object
4360 * @param obj The object
4362 * @return The Ecore_X_Window of @p obj
4366 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4368 /* smart callbacks called:
4369 * "delete,request" - the user requested to delete the window
4370 * "focus,in" - window got focus
4371 * "focus,out" - window lost focus
4372 * "moved" - window that holds the canvas was moved
4378 * @image html img/widget/bg/preview-00.png
4379 * @image latex img/widget/bg/preview-00.eps
4381 * @brief Background object, used for setting a solid color, image or Edje
4382 * group as background to a window or any container object.
4384 * The bg object is used for setting a solid background to a window or
4385 * packing into any container object. It works just like an image, but has
4386 * some properties useful to a background, like setting it to tiled,
4387 * centered, scaled or stretched.
4389 * Here is some sample code using it:
4390 * @li @ref bg_01_example_page
4391 * @li @ref bg_02_example_page
4392 * @li @ref bg_03_example_page
4396 typedef enum _Elm_Bg_Option
4398 ELM_BG_OPTION_CENTER, /**< center the background */
4399 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
4400 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4401 ELM_BG_OPTION_TILE /**< tile background at its original size */
4405 * Add a new background to the parent
4407 * @param parent The parent object
4408 * @return The new object or NULL if it cannot be created
4412 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4415 * Set the file (image or edje) used for the background
4417 * @param obj The bg object
4418 * @param file The file path
4419 * @param group Optional key (group in Edje) within the file
4421 * This sets the image file used in the background object. The image (or edje)
4422 * will be stretched (retaining aspect if its an image file) to completely fill
4423 * the bg object. This may mean some parts are not visible.
4425 * @note Once the image of @p obj is set, a previously set one will be deleted,
4426 * even if @p file is NULL.
4430 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4433 * Get the file (image or edje) used for the background
4435 * @param obj The bg object
4436 * @param file The file path
4437 * @param group Optional key (group in Edje) within the file
4441 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4444 * Set the option used for the background image
4446 * @param obj The bg object
4447 * @param option The desired background option (TILE, SCALE)
4449 * This sets the option used for manipulating the display of the background
4450 * image. The image can be tiled or scaled.
4454 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4457 * Get the option used for the background image
4459 * @param obj The bg object
4460 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4464 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4466 * Set the option used for the background color
4468 * @param obj The bg object
4473 * This sets the color used for the background rectangle. Its range goes
4478 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4480 * Get the option used for the background color
4482 * @param obj The bg object
4489 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4492 * Set the overlay object used for the background object.
4494 * @param obj The bg object
4495 * @param overlay The overlay object
4497 * This provides a way for elm_bg to have an 'overlay' that will be on top
4498 * of the bg. Once the over object is set, a previously set one will be
4499 * deleted, even if you set the new one to NULL. If you want to keep that
4500 * old content object, use the elm_bg_overlay_unset() function.
4505 EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4508 * Get the overlay object used for the background object.
4510 * @param obj The bg object
4511 * @return The content that is being used
4513 * Return the content object which is set for this widget
4517 EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4520 * Get the overlay object used for the background object.
4522 * @param obj The bg object
4523 * @return The content that was being used
4525 * Unparent and return the overlay object which was set for this widget
4529 EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4532 * Set the size of the pixmap representation of the image.
4534 * This option just makes sense if an image is going to be set in the bg.
4536 * @param obj The bg object
4537 * @param w The new width of the image pixmap representation.
4538 * @param h The new height of the image pixmap representation.
4540 * This function sets a new size for pixmap representation of the given bg
4541 * image. It allows the image to be loaded already in the specified size,
4542 * reducing the memory usage and load time when loading a big image with load
4543 * size set to a smaller size.
4545 * NOTE: this is just a hint, the real size of the pixmap may differ
4546 * depending on the type of image being loaded, being bigger than requested.
4550 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4551 /* smart callbacks called:
4555 * @defgroup Icon Icon
4557 * @image html img/widget/icon/preview-00.png
4558 * @image latex img/widget/icon/preview-00.eps
4560 * An object that provides standard icon images (delete, edit, arrows, etc.)
4561 * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4563 * The icon image requested can be in the elementary theme, or in the
4564 * freedesktop.org paths. It's possible to set the order of preference from
4565 * where the image will be used.
4567 * This API is very similar to @ref Image, but with ready to use images.
4569 * Default images provided by the theme are described below.
4571 * The first list contains icons that were first intended to be used in
4572 * toolbars, but can be used in many other places too:
4588 * Now some icons that were designed to be used in menus (but again, you can
4589 * use them anywhere else):
4594 * @li menu/arrow_down
4595 * @li menu/arrow_left
4596 * @li menu/arrow_right
4605 * And here we have some media player specific icons:
4606 * @li media_player/forward
4607 * @li media_player/info
4608 * @li media_player/next
4609 * @li media_player/pause
4610 * @li media_player/play
4611 * @li media_player/prev
4612 * @li media_player/rewind
4613 * @li media_player/stop
4615 * Signals that you can add callbacks for are:
4617 * "clicked" - This is called when a user has clicked the icon
4619 * An example of usage for this API follows:
4620 * @li @ref tutorial_icon
4628 typedef enum _Elm_Icon_Type
4635 * @enum _Elm_Icon_Lookup_Order
4636 * @typedef Elm_Icon_Lookup_Order
4638 * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4639 * theme, FDO paths, or both?
4643 typedef enum _Elm_Icon_Lookup_Order
4645 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4646 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4647 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
4648 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
4649 } Elm_Icon_Lookup_Order;
4652 * Add a new icon object to the parent.
4654 * @param parent The parent object
4655 * @return The new object or NULL if it cannot be created
4657 * @see elm_icon_file_set()
4661 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4663 * Set the file that will be used as icon.
4665 * @param obj The icon object
4666 * @param file The path to file that will be used as icon image
4667 * @param group The group that the icon belongs to in edje file
4669 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4671 * @note The icon image set by this function can be changed by
4672 * elm_icon_standard_set().
4674 * @see elm_icon_file_get()
4678 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4680 * Set a location in memory to be used as an icon
4682 * @param obj The icon object
4683 * @param img The binary data that will be used as an image
4684 * @param size The size of binary data @p img
4685 * @param format Optional format of @p img to pass to the image loader
4686 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
4688 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4690 * @note The icon image set by this function can be changed by
4691 * elm_icon_standard_set().
4695 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);
4697 * Get the file that will be used as icon.
4699 * @param obj The icon object
4700 * @param file The path to file that will be used as icon icon image
4701 * @param group The group that the icon belongs to in edje file
4703 * @see elm_icon_file_set()
4707 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4708 EAPI void elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4710 * Set the icon by icon standards names.
4712 * @param obj The icon object
4713 * @param name The icon name
4715 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4717 * For example, freedesktop.org defines standard icon names such as "home",
4718 * "network", etc. There can be different icon sets to match those icon
4719 * keys. The @p name given as parameter is one of these "keys", and will be
4720 * used to look in the freedesktop.org paths and elementary theme. One can
4721 * change the lookup order with elm_icon_order_lookup_set().
4723 * If name is not found in any of the expected locations and it is the
4724 * absolute path of an image file, this image will be used.
4726 * @note The icon image set by this function can be changed by
4727 * elm_icon_file_set().
4729 * @see elm_icon_standard_get()
4730 * @see elm_icon_file_set()
4734 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
4736 * Get the icon name set by icon standard names.
4738 * @param obj The icon object
4739 * @return The icon name
4741 * If the icon image was set using elm_icon_file_set() instead of
4742 * elm_icon_standard_set(), then this function will return @c NULL.
4744 * @see elm_icon_standard_set()
4748 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4750 * Set the smooth effect for an icon object.
4752 * @param obj The icon object
4753 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4754 * otherwise. Default is @c EINA_TRUE.
4756 * Set the scaling algorithm to be used when scaling the icon image. Smooth
4757 * scaling provides a better resulting image, but is slower.
4759 * The smooth scaling should be disabled when making animations that change
4760 * the icon size, since they will be faster. Animations that don't require
4761 * resizing of the icon can keep the smooth scaling enabled (even if the icon
4762 * is already scaled, since the scaled icon image will be cached).
4764 * @see elm_icon_smooth_get()
4768 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4770 * Get the smooth effect for an icon object.
4772 * @param obj The icon object
4773 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4775 * @see elm_icon_smooth_set()
4779 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4781 * Disable scaling of this object.
4783 * @param obj The icon object.
4784 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4785 * otherwise. Default is @c EINA_FALSE.
4787 * This function disables scaling of the icon object through the function
4788 * elm_object_scale_set(). However, this does not affect the object
4789 * size/resize in any way. For that effect, take a look at
4790 * elm_icon_scale_set().
4792 * @see elm_icon_no_scale_get()
4793 * @see elm_icon_scale_set()
4794 * @see elm_object_scale_set()
4798 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
4800 * Get whether scaling is disabled on the object.
4802 * @param obj The icon object
4803 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
4805 * @see elm_icon_no_scale_set()
4809 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4811 * Set if the object is (up/down) resizable.
4813 * @param obj The icon object
4814 * @param scale_up A bool to set if the object is resizable up. Default is
4816 * @param scale_down A bool to set if the object is resizable down. Default
4819 * This function limits the icon object resize ability. If @p scale_up is set to
4820 * @c EINA_FALSE, the object can't have its height or width resized to a value
4821 * higher than the original icon size. Same is valid for @p scale_down.
4823 * @see elm_icon_scale_get()
4827 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
4829 * Get if the object is (up/down) resizable.
4831 * @param obj The icon object
4832 * @param scale_up A bool to set if the object is resizable up
4833 * @param scale_down A bool to set if the object is resizable down
4835 * @see elm_icon_scale_set()
4839 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
4841 * Get the object's image size
4843 * @param obj The icon object
4844 * @param w A pointer to store the width in
4845 * @param h A pointer to store the height in
4849 EAPI void elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4851 * Set if the icon fill the entire object area.
4853 * @param obj The icon object
4854 * @param fill_outside @c EINA_TRUE if the object is filled outside,
4855 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4857 * When the icon object is resized to a different aspect ratio from the
4858 * original icon image, the icon image will still keep its aspect. This flag
4859 * tells how the image should fill the object's area. They are: keep the
4860 * entire icon inside the limits of height and width of the object (@p
4861 * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
4862 * of the object, and the icon will fill the entire object (@p fill_outside
4865 * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
4866 * retain property to false. Thus, the icon image will always keep its
4867 * original aspect ratio.
4869 * @see elm_icon_fill_outside_get()
4870 * @see elm_image_fill_outside_set()
4874 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
4876 * Get if the object is filled outside.
4878 * @param obj The icon object
4879 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
4881 * @see elm_icon_fill_outside_set()
4885 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4887 * Set the prescale size for the icon.
4889 * @param obj The icon object
4890 * @param size The prescale size. This value is used for both width and
4893 * This function sets a new size for pixmap representation of the given
4894 * icon. It allows the icon to be loaded already in the specified size,
4895 * reducing the memory usage and load time when loading a big icon with load
4896 * size set to a smaller size.
4898 * It's equivalent to the elm_bg_load_size_set() function for bg.
4900 * @note this is just a hint, the real size of the pixmap may differ
4901 * depending on the type of icon being loaded, being bigger than requested.
4903 * @see elm_icon_prescale_get()
4904 * @see elm_bg_load_size_set()
4908 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
4910 * Get the prescale size for the icon.
4912 * @param obj The icon object
4913 * @return The prescale size
4915 * @see elm_icon_prescale_set()
4919 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4921 * Sets the icon lookup order used by elm_icon_standard_set().
4923 * @param obj The icon object
4924 * @param order The icon lookup order (can be one of
4925 * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
4926 * or ELM_ICON_LOOKUP_THEME)
4928 * @see elm_icon_order_lookup_get()
4929 * @see Elm_Icon_Lookup_Order
4933 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
4935 * Gets the icon lookup order.
4937 * @param obj The icon object
4938 * @return The icon lookup order
4940 * @see elm_icon_order_lookup_set()
4941 * @see Elm_Icon_Lookup_Order
4945 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4947 * Get if the icon supports animation or not.
4949 * @param obj The icon object
4950 * @return @c EINA_TRUE if the icon supports animation,
4951 * @c EINA_FALSE otherwise.
4953 * Return if this elm icon's image can be animated. Currently Evas only
4954 * supports gif animation. If the return value is EINA_FALSE, other
4955 * elm_icon_animated_XXX APIs won't work.
4958 EAPI Eina_Bool elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4960 * Set animation mode of the icon.
4962 * @param obj The icon object
4963 * @param anim @c EINA_TRUE if the object do animation job,
4964 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4966 * Even though elm icon's file can be animated,
4967 * sometimes appication developer want to just first page of image.
4968 * In that time, don't call this function, because default value is EINA_FALSE
4969 * Only when you want icon support anition,
4970 * use this function and set animated to EINA_TURE
4973 EAPI void elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
4975 * Get animation mode of the icon.
4977 * @param obj The icon object
4978 * @return The animation mode of the icon object
4979 * @see elm_icon_animated_set
4982 EAPI Eina_Bool elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4984 * Set animation play mode of the icon.
4986 * @param obj The icon object
4987 * @param play @c EINA_TRUE the object play animation images,
4988 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4990 * If you want to play elm icon's animation, you set play to EINA_TURE.
4991 * For example, you make gif player using this set/get API and click event.
4993 * 1. Click event occurs
4994 * 2. Check play flag using elm_icon_animaged_play_get
4995 * 3. If elm icon was playing, set play to EINA_FALSE.
4996 * Then animation will be stopped and vice versa
4999 EAPI void elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
5001 * Get animation play mode of the icon.
5003 * @param obj The icon object
5004 * @return The play mode of the icon object
5006 * @see elm_icon_animated_lay_get
5009 EAPI Eina_Bool elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5016 * @defgroup Image Image
5018 * @image html img/widget/image/preview-00.png
5019 * @image latex img/widget/image/preview-00.eps
5022 * An object that allows one to load an image file to it. It can be used
5023 * anywhere like any other elementary widget.
5025 * This widget provides most of the functionality provided from @ref Bg or @ref
5026 * Icon, but with a slightly different API (use the one that fits better your
5029 * The features not provided by those two other image widgets are:
5030 * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
5031 * @li change the object orientation with elm_image_orient_set();
5032 * @li and turning the image editable with elm_image_editable_set().
5034 * Signals that you can add callbacks for are:
5036 * @li @c "clicked" - This is called when a user has clicked the image
5038 * An example of usage for this API follows:
5039 * @li @ref tutorial_image
5048 * @enum _Elm_Image_Orient
5049 * @typedef Elm_Image_Orient
5051 * Possible orientation options for elm_image_orient_set().
5053 * @image html elm_image_orient_set.png
5054 * @image latex elm_image_orient_set.eps width=\textwidth
5058 typedef enum _Elm_Image_Orient
5060 ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
5061 ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
5062 ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
5063 ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5064 ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
5065 ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
5066 ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
5067 ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
5071 * Add a new image to the parent.
5073 * @param parent The parent object
5074 * @return The new object or NULL if it cannot be created
5076 * @see elm_image_file_set()
5080 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5082 * Set the file that will be used as image.
5084 * @param obj The image object
5085 * @param file The path to file that will be used as image
5086 * @param group The group that the image belongs in edje file (if it's an
5089 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5091 * @see elm_image_file_get()
5095 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5097 * Get the file that will be used as image.
5099 * @param obj The image object
5100 * @param file The path to file
5101 * @param group The group that the image belongs in edje file
5103 * @see elm_image_file_set()
5107 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5109 * Set the smooth effect for an image.
5111 * @param obj The image object
5112 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5113 * otherwise. Default is @c EINA_TRUE.
5115 * Set the scaling algorithm to be used when scaling the image. Smooth
5116 * scaling provides a better resulting image, but is slower.
5118 * The smooth scaling should be disabled when making animations that change
5119 * the image size, since it will be faster. Animations that don't require
5120 * resizing of the image can keep the smooth scaling enabled (even if the
5121 * image is already scaled, since the scaled image will be cached).
5123 * @see elm_image_smooth_get()
5127 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5129 * Get the smooth effect for an image.
5131 * @param obj The image object
5132 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5134 * @see elm_image_smooth_get()
5138 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5140 * Gets the current size of the image.
5142 * @param obj The image object.
5143 * @param w Pointer to store width, or NULL.
5144 * @param h Pointer to store height, or NULL.
5146 * This is the real size of the image, not the size of the object.
5148 * On error, neither w or h will be written.
5152 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5154 * Disable scaling of this object.
5156 * @param obj The image object.
5157 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5158 * otherwise. Default is @c EINA_FALSE.
5160 * This function disables scaling of the elm_image widget through the
5161 * function elm_object_scale_set(). However, this does not affect the widget
5162 * size/resize in any way. For that effect, take a look at
5163 * elm_image_scale_set().
5165 * @see elm_image_no_scale_get()
5166 * @see elm_image_scale_set()
5167 * @see elm_object_scale_set()
5171 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5173 * Get whether scaling is disabled on the object.
5175 * @param obj The image object
5176 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5178 * @see elm_image_no_scale_set()
5182 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5184 * Set if the object is (up/down) resizable.
5186 * @param obj The image object
5187 * @param scale_up A bool to set if the object is resizable up. Default is
5189 * @param scale_down A bool to set if the object is resizable down. Default
5192 * This function limits the image resize ability. If @p scale_up is set to
5193 * @c EINA_FALSE, the object can't have its height or width resized to a value
5194 * higher than the original image size. Same is valid for @p scale_down.
5196 * @see elm_image_scale_get()
5200 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5202 * Get if the object is (up/down) resizable.
5204 * @param obj The image object
5205 * @param scale_up A bool to set if the object is resizable up
5206 * @param scale_down A bool to set if the object is resizable down
5208 * @see elm_image_scale_set()
5212 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5214 * Set if the image fill the entire object area when keeping the aspect ratio.
5216 * @param obj The image object
5217 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5218 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5220 * When the image should keep its aspect ratio even if resized to another
5221 * aspect ratio, there are two possibilities to resize it: keep the entire
5222 * image inside the limits of height and width of the object (@p fill_outside
5223 * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5224 * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5226 * @note This option will have no effect if
5227 * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5229 * @see elm_image_fill_outside_get()
5230 * @see elm_image_aspect_ratio_retained_set()
5234 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5236 * Get if the object is filled outside
5238 * @param obj The image object
5239 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5241 * @see elm_image_fill_outside_set()
5245 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5247 * Set the prescale size for the image
5249 * @param obj The image object
5250 * @param size The prescale size. This value is used for both width and
5253 * This function sets a new size for pixmap representation of the given
5254 * image. It allows the image to be loaded already in the specified size,
5255 * reducing the memory usage and load time when loading a big image with load
5256 * size set to a smaller size.
5258 * It's equivalent to the elm_bg_load_size_set() function for bg.
5260 * @note this is just a hint, the real size of the pixmap may differ
5261 * depending on the type of image being loaded, being bigger than requested.
5263 * @see elm_image_prescale_get()
5264 * @see elm_bg_load_size_set()
5268 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5270 * Get the prescale size for the image
5272 * @param obj The image object
5273 * @return The prescale size
5275 * @see elm_image_prescale_set()
5279 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5281 * Set the image orientation.
5283 * @param obj The image object
5284 * @param orient The image orientation
5285 * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
5286 * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
5287 * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
5288 * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE).
5289 * Default is #ELM_IMAGE_ORIENT_NONE.
5291 * This function allows to rotate or flip the given image.
5293 * @see elm_image_orient_get()
5294 * @see @ref Elm_Image_Orient
5298 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5300 * Get the image orientation.
5302 * @param obj The image object
5303 * @return The image orientation
5304 * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
5305 * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
5306 * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
5307 * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE)
5309 * @see elm_image_orient_set()
5310 * @see @ref Elm_Image_Orient
5314 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5316 * Make the image 'editable'.
5318 * @param obj Image object.
5319 * @param set Turn on or off editability. Default is @c EINA_FALSE.
5321 * This means the image is a valid drag target for drag and drop, and can be
5322 * cut or pasted too.
5326 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5328 * Make the image 'editable'.
5330 * @param obj Image object.
5331 * @return Editability.
5333 * This means the image is a valid drag target for drag and drop, and can be
5334 * cut or pasted too.
5338 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5340 * Get the basic Evas_Image object from this object (widget).
5342 * @param obj The image object to get the inlined image from
5343 * @return The inlined image object, or NULL if none exists
5345 * This function allows one to get the underlying @c Evas_Object of type
5346 * Image from this elementary widget. It can be useful to do things like get
5347 * the pixel data, save the image to a file, etc.
5349 * @note Be careful to not manipulate it, as it is under control of
5354 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5356 * Set whether the original aspect ratio of the image should be kept on resize.
5358 * @param obj The image object.
5359 * @param retained @c EINA_TRUE if the image should retain the aspect,
5360 * @c EINA_FALSE otherwise.
5362 * The original aspect ratio (width / height) of the image is usually
5363 * distorted to match the object's size. Enabling this option will retain
5364 * this original aspect, and the way that the image is fit into the object's
5365 * area depends on the option set by elm_image_fill_outside_set().
5367 * @see elm_image_aspect_ratio_retained_get()
5368 * @see elm_image_fill_outside_set()
5372 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5374 * Get if the object retains the original aspect ratio.
5376 * @param obj The image object.
5377 * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5382 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5389 typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5391 typedef enum _Elm_GLView_Mode
5393 ELM_GLVIEW_ALPHA = 1,
5394 ELM_GLVIEW_DEPTH = 2,
5395 ELM_GLVIEW_STENCIL = 4
5399 * Defines a policy for the glview resizing.
5401 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5403 typedef enum _Elm_GLView_Resize_Policy
5405 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
5406 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
5407 } Elm_GLView_Resize_Policy;
5409 typedef enum _Elm_GLView_Render_Policy
5411 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
5412 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
5413 } Elm_GLView_Render_Policy;
5418 * A simple GLView widget that allows GL rendering.
5420 * Signals that you can add callbacks for are:
5426 * Add a new glview to the parent
5428 * @param parent The parent object
5429 * @return The new object or NULL if it cannot be created
5433 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5436 * Sets the size of the glview
5438 * @param obj The glview object
5439 * @param width width of the glview object
5440 * @param height height of the glview object
5444 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5447 * Gets the size of the glview.
5449 * @param obj The glview object
5450 * @param width width of the glview object
5451 * @param height height of the glview object
5453 * Note that this function returns the actual image size of the
5454 * glview. This means that when the scale policy is set to
5455 * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5460 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5463 * Gets the gl api struct for gl rendering
5465 * @param obj The glview object
5466 * @return The api object or NULL if it cannot be created
5470 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5473 * Set the mode of the GLView. Supports Three simple modes.
5475 * @param obj The glview object
5476 * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5477 * @return True if set properly.
5481 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5484 * Set the resize policy for the glview object.
5486 * @param obj The glview object.
5487 * @param policy The scaling policy.
5489 * By default, the resize policy is set to
5490 * ELM_GLVIEW_RESIZE_POLICY_RECREATE. When resize is called it
5491 * destroys the previous surface and recreates the newly specified
5492 * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5493 * however, glview only scales the image object and not the underlying
5498 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5501 * Set the render policy for the glview object.
5503 * @param obj The glview object.
5504 * @param policy The render policy.
5506 * By default, the render policy is set to
5507 * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND. This policy is set such
5508 * that during the render loop, glview is only redrawn if it needs
5509 * to be redrawn. (i.e. When it is visible) If the policy is set to
5510 * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5511 * whether it is visible/need redrawing or not.
5515 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5518 * Set the init function that runs once in the main loop.
5520 * @param obj The glview object.
5521 * @param func The init function to be registered.
5523 * The registered init function gets called once during the render loop.
5527 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5530 * Set the render function that runs in the main loop.
5532 * @param obj The glview object.
5533 * @param func The delete function to be registered.
5535 * The registered del function gets called when GLView object is deleted.
5539 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5542 * Set the resize function that gets called when resize happens.
5544 * @param obj The glview object.
5545 * @param func The resize function to be registered.
5549 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5552 * Set the render function that runs in the main loop.
5554 * @param obj The glview object.
5555 * @param func The render function to be registered.
5559 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5562 * Notifies that there has been changes in the GLView.
5564 * @param obj The glview object.
5568 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5578 * @image html img/widget/box/preview-00.png
5579 * @image latex img/widget/box/preview-00.eps width=\textwidth
5581 * @image html img/box.png
5582 * @image latex img/box.eps width=\textwidth
5584 * A box arranges objects in a linear fashion, governed by a layout function
5585 * that defines the details of this arrangement.
5587 * By default, the box will use an internal function to set the layout to
5588 * a single row, either vertical or horizontal. This layout is affected
5589 * by a number of parameters, such as the homogeneous flag set by
5590 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5591 * elm_box_align_set() and the hints set to each object in the box.
5593 * For this default layout, it's possible to change the orientation with
5594 * elm_box_horizontal_set(). The box will start in the vertical orientation,
5595 * placing its elements ordered from top to bottom. When horizontal is set,
5596 * the order will go from left to right. If the box is set to be
5597 * homogeneous, every object in it will be assigned the same space, that
5598 * of the largest object. Padding can be used to set some spacing between
5599 * the cell given to each object. The alignment of the box, set with
5600 * elm_box_align_set(), determines how the bounding box of all the elements
5601 * will be placed within the space given to the box widget itself.
5603 * The size hints of each object also affect how they are placed and sized
5604 * within the box. evas_object_size_hint_min_set() will give the minimum
5605 * size the object can have, and the box will use it as the basis for all
5606 * latter calculations. Elementary widgets set their own minimum size as
5607 * needed, so there's rarely any need to use it manually.
5609 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5610 * used to tell whether the object will be allocated the minimum size it
5611 * needs or if the space given to it should be expanded. It's important
5612 * to realize that expanding the size given to the object is not the same
5613 * thing as resizing the object. It could very well end being a small
5614 * widget floating in a much larger empty space. If not set, the weight
5615 * for objects will normally be 0.0 for both axis, meaning the widget will
5616 * not be expanded. To take as much space possible, set the weight to
5617 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5619 * Besides how much space each object is allocated, it's possible to control
5620 * how the widget will be placed within that space using
5621 * evas_object_size_hint_align_set(). By default, this value will be 0.5
5622 * for both axis, meaning the object will be centered, but any value from
5623 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5624 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5625 * is -1.0, means the object will be resized to fill the entire space it
5628 * In addition, customized functions to define the layout can be set, which
5629 * allow the application developer to organize the objects within the box
5630 * in any number of ways.
5632 * The special elm_box_layout_transition() function can be used
5633 * to switch from one layout to another, animating the motion of the
5634 * children of the box.
5636 * @note Objects should not be added to box objects using _add() calls.
5638 * Some examples on how to use boxes follow:
5639 * @li @ref box_example_01
5640 * @li @ref box_example_02
5645 * @typedef Elm_Box_Transition
5647 * Opaque handler containing the parameters to perform an animated
5648 * transition of the layout the box uses.
5650 * @see elm_box_transition_new()
5651 * @see elm_box_layout_set()
5652 * @see elm_box_layout_transition()
5654 typedef struct _Elm_Box_Transition Elm_Box_Transition;
5657 * Add a new box to the parent
5659 * By default, the box will be in vertical mode and non-homogeneous.
5661 * @param parent The parent object
5662 * @return The new object or NULL if it cannot be created
5664 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5666 * Set the horizontal orientation
5668 * By default, box object arranges their contents vertically from top to
5670 * By calling this function with @p horizontal as EINA_TRUE, the box will
5671 * become horizontal, arranging contents from left to right.
5673 * @note This flag is ignored if a custom layout function is set.
5675 * @param obj The box object
5676 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5677 * EINA_FALSE = vertical)
5679 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5681 * Get the horizontal orientation
5683 * @param obj The box object
5684 * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
5686 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5688 * Set the box to arrange its children homogeneously
5690 * If enabled, homogeneous layout makes all items the same size, according
5691 * to the size of the largest of its children.
5693 * @note This flag is ignored if a custom layout function is set.
5695 * @param obj The box object
5696 * @param homogeneous The homogeneous flag
5698 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5700 * Get whether the box is using homogeneous mode or not
5702 * @param obj The box object
5703 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5705 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5706 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5707 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5709 * Add an object to the beginning of the pack list
5711 * Pack @p subobj into the box @p obj, placing it first in the list of
5712 * children objects. The actual position the object will get on screen
5713 * depends on the layout used. If no custom layout is set, it will be at
5714 * the top or left, depending if the box is vertical or horizontal,
5717 * @param obj The box object
5718 * @param subobj The object to add to the box
5720 * @see elm_box_pack_end()
5721 * @see elm_box_pack_before()
5722 * @see elm_box_pack_after()
5723 * @see elm_box_unpack()
5724 * @see elm_box_unpack_all()
5725 * @see elm_box_clear()
5727 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5729 * Add an object at the end of the pack list
5731 * Pack @p subobj into the box @p obj, placing it last in the list of
5732 * children objects. The actual position the object will get on screen
5733 * depends on the layout used. If no custom layout is set, it will be at
5734 * the bottom or right, depending if the box is vertical or horizontal,
5737 * @param obj The box object
5738 * @param subobj The object to add to the box
5740 * @see elm_box_pack_start()
5741 * @see elm_box_pack_before()
5742 * @see elm_box_pack_after()
5743 * @see elm_box_unpack()
5744 * @see elm_box_unpack_all()
5745 * @see elm_box_clear()
5747 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5749 * Adds an object to the box before the indicated object
5751 * This will add the @p subobj to the box indicated before the object
5752 * indicated with @p before. If @p before is not already in the box, results
5753 * are undefined. Before means either to the left of the indicated object or
5754 * above it depending on orientation.
5756 * @param obj The box object
5757 * @param subobj The object to add to the box
5758 * @param before The object before which to add it
5760 * @see elm_box_pack_start()
5761 * @see elm_box_pack_end()
5762 * @see elm_box_pack_after()
5763 * @see elm_box_unpack()
5764 * @see elm_box_unpack_all()
5765 * @see elm_box_clear()
5767 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
5769 * Adds an object to the box after the indicated object
5771 * This will add the @p subobj to the box indicated after the object
5772 * indicated with @p after. If @p after is not already in the box, results
5773 * are undefined. After means either to the right of the indicated object or
5774 * below it depending on orientation.
5776 * @param obj The box object
5777 * @param subobj The object to add to the box
5778 * @param after The object after which to add it
5780 * @see elm_box_pack_start()
5781 * @see elm_box_pack_end()
5782 * @see elm_box_pack_before()
5783 * @see elm_box_unpack()
5784 * @see elm_box_unpack_all()
5785 * @see elm_box_clear()
5787 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
5789 * Clear the box of all children
5791 * Remove all the elements contained by the box, deleting the respective
5794 * @param obj The box object
5796 * @see elm_box_unpack()
5797 * @see elm_box_unpack_all()
5799 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5803 * Remove the object given by @p subobj from the box @p obj without
5806 * @param obj The box object
5808 * @see elm_box_unpack_all()
5809 * @see elm_box_clear()
5811 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5813 * Remove all items from the box, without deleting them
5815 * Clear the box from all children, but don't delete the respective objects.
5816 * If no other references of the box children exist, the objects will never
5817 * be deleted, and thus the application will leak the memory. Make sure
5818 * when using this function that you hold a reference to all the objects
5819 * in the box @p obj.
5821 * @param obj The box object
5823 * @see elm_box_clear()
5824 * @see elm_box_unpack()
5826 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5828 * Retrieve a list of the objects packed into the box
5830 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
5831 * The order of the list corresponds to the packing order the box uses.
5833 * You must free this list with eina_list_free() once you are done with it.
5835 * @param obj The box object
5837 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5839 * Set the space (padding) between the box's elements.
5841 * Extra space in pixels that will be added between a box child and its
5842 * neighbors after its containing cell has been calculated. This padding
5843 * is set for all elements in the box, besides any possible padding that
5844 * individual elements may have through their size hints.
5846 * @param obj The box object
5847 * @param horizontal The horizontal space between elements
5848 * @param vertical The vertical space between elements
5850 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5852 * Get the space (padding) between the box's elements.
5854 * @param obj The box object
5855 * @param horizontal The horizontal space between elements
5856 * @param vertical The vertical space between elements
5858 * @see elm_box_padding_set()
5860 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5862 * Set the alignment of the whole bouding box of contents.
5864 * Sets how the bounding box containing all the elements of the box, after
5865 * their sizes and position has been calculated, will be aligned within
5866 * the space given for the whole box widget.
5868 * @param obj The box object
5869 * @param horizontal The horizontal alignment of elements
5870 * @param vertical The vertical alignment of elements
5872 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
5874 * Get the alignment of the whole bouding box of contents.
5876 * @param obj The box object
5877 * @param horizontal The horizontal alignment of elements
5878 * @param vertical The vertical alignment of elements
5880 * @see elm_box_align_set()
5882 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
5885 * Force the box to recalculate its children packing.
5887 * If any children was added or removed, box will not calculate the
5888 * values immediately rather leaving it to the next main loop
5889 * iteration. While this is great as it would save lots of
5890 * recalculation, whenever you need to get the position of a just
5891 * added item you must force recalculate before doing so.
5893 * @param obj The box object.
5895 EAPI void elm_box_recalculate(Evas_Object *obj);
5898 * Set the layout defining function to be used by the box
5900 * Whenever anything changes that requires the box in @p obj to recalculate
5901 * the size and position of its elements, the function @p cb will be called
5902 * to determine what the layout of the children will be.
5904 * Once a custom function is set, everything about the children layout
5905 * is defined by it. The flags set by elm_box_horizontal_set() and
5906 * elm_box_homogeneous_set() no longer have any meaning, and the values
5907 * given by elm_box_padding_set() and elm_box_align_set() are up to this
5908 * layout function to decide if they are used and how. These last two
5909 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
5910 * passed to @p cb. The @c Evas_Object the function receives is not the
5911 * Elementary widget, but the internal Evas Box it uses, so none of the
5912 * functions described here can be used on it.
5914 * Any of the layout functions in @c Evas can be used here, as well as the
5915 * special elm_box_layout_transition().
5917 * The final @p data argument received by @p cb is the same @p data passed
5918 * here, and the @p free_data function will be called to free it
5919 * whenever the box is destroyed or another layout function is set.
5921 * Setting @p cb to NULL will revert back to the default layout function.
5923 * @param obj The box object
5924 * @param cb The callback function used for layout
5925 * @param data Data that will be passed to layout function
5926 * @param free_data Function called to free @p data
5928 * @see elm_box_layout_transition()
5930 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);
5932 * Special layout function that animates the transition from one layout to another
5934 * Normally, when switching the layout function for a box, this will be
5935 * reflected immediately on screen on the next render, but it's also
5936 * possible to do this through an animated transition.
5938 * This is done by creating an ::Elm_Box_Transition and setting the box
5939 * layout to this function.
5943 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
5944 * evas_object_box_layout_vertical, // start
5945 * NULL, // data for initial layout
5946 * NULL, // free function for initial data
5947 * evas_object_box_layout_horizontal, // end
5948 * NULL, // data for final layout
5949 * NULL, // free function for final data
5950 * anim_end, // will be called when animation ends
5951 * NULL); // data for anim_end function\
5952 * elm_box_layout_set(box, elm_box_layout_transition, t,
5953 * elm_box_transition_free);
5956 * @note This function can only be used with elm_box_layout_set(). Calling
5957 * it directly will not have the expected results.
5959 * @see elm_box_transition_new
5960 * @see elm_box_transition_free
5961 * @see elm_box_layout_set
5963 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
5965 * Create a new ::Elm_Box_Transition to animate the switch of layouts
5967 * If you want to animate the change from one layout to another, you need
5968 * to set the layout function of the box to elm_box_layout_transition(),
5969 * passing as user data to it an instance of ::Elm_Box_Transition with the
5970 * necessary information to perform this animation. The free function to
5971 * set for the layout is elm_box_transition_free().
5973 * The parameters to create an ::Elm_Box_Transition sum up to how long
5974 * will it be, in seconds, a layout function to describe the initial point,
5975 * another for the final position of the children and one function to be
5976 * called when the whole animation ends. This last function is useful to
5977 * set the definitive layout for the box, usually the same as the end
5978 * layout for the animation, but could be used to start another transition.
5980 * @param start_layout The layout function that will be used to start the animation
5981 * @param start_layout_data The data to be passed the @p start_layout function
5982 * @param start_layout_free_data Function to free @p start_layout_data
5983 * @param end_layout The layout function that will be used to end the animation
5984 * @param end_layout_free_data The data to be passed the @p end_layout function
5985 * @param end_layout_free_data Function to free @p end_layout_data
5986 * @param transition_end_cb Callback function called when animation ends
5987 * @param transition_end_data Data to be passed to @p transition_end_cb
5988 * @return An instance of ::Elm_Box_Transition
5990 * @see elm_box_transition_new
5991 * @see elm_box_layout_transition
5993 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);
5995 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
5997 * This function is mostly useful as the @c free_data parameter in
5998 * elm_box_layout_set() when elm_box_layout_transition().
6000 * @param data The Elm_Box_Transition instance to be freed.
6002 * @see elm_box_transition_new
6003 * @see elm_box_layout_transition
6005 EAPI void elm_box_transition_free(void *data);
6012 * @defgroup Button Button
6014 * @image html img/widget/button/preview-00.png
6015 * @image latex img/widget/button/preview-00.eps
6016 * @image html img/widget/button/preview-01.png
6017 * @image latex img/widget/button/preview-01.eps
6018 * @image html img/widget/button/preview-02.png
6019 * @image latex img/widget/button/preview-02.eps
6021 * This is a push-button. Press it and run some function. It can contain
6022 * a simple label and icon object and it also has an autorepeat feature.
6024 * This widgets emits the following signals:
6025 * @li "clicked": the user clicked the button (press/release).
6026 * @li "repeated": the user pressed the button without releasing it.
6027 * @li "pressed": button was pressed.
6028 * @li "unpressed": button was released after being pressed.
6029 * In all three cases, the @c event parameter of the callback will be
6032 * Also, defined in the default theme, the button has the following styles
6034 * @li default: a normal button.
6035 * @li anchor: Like default, but the button fades away when the mouse is not
6036 * over it, leaving only the text or icon.
6037 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
6038 * continuous look across its options.
6039 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
6041 * Follow through a complete example @ref button_example_01 "here".
6045 * Add a new button to the parent's canvas
6047 * @param parent The parent object
6048 * @return The new object or NULL if it cannot be created
6050 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6052 * Set the label used in the button
6054 * The passed @p label can be NULL to clean any existing text in it and
6055 * leave the button as an icon only object.
6057 * @param obj The button object
6058 * @param label The text will be written on the button
6059 * @deprecated use elm_object_text_set() instead.
6061 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6063 * Get the label set for the button
6065 * The string returned is an internal pointer and should not be freed or
6066 * altered. It will also become invalid when the button is destroyed.
6067 * The string returned, if not NULL, is a stringshare, so if you need to
6068 * keep it around even after the button is destroyed, you can use
6069 * eina_stringshare_ref().
6071 * @param obj The button object
6072 * @return The text set to the label, or NULL if nothing is set
6073 * @deprecated use elm_object_text_set() instead.
6075 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6077 * Set the icon used for the button
6079 * Setting a new icon will delete any other that was previously set, making
6080 * any reference to them invalid. If you need to maintain the previous
6081 * object alive, unset it first with elm_button_icon_unset().
6083 * @param obj The button object
6084 * @param icon The icon object for the button
6086 EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6088 * Get the icon used for the button
6090 * Return the icon object which is set for this widget. If the button is
6091 * destroyed or another icon is set, the returned object will be deleted
6092 * and any reference to it will be invalid.
6094 * @param obj The button object
6095 * @return The icon object that is being used
6097 * @see elm_button_icon_unset()
6099 EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6101 * Remove the icon set without deleting it and return the object
6103 * This function drops the reference the button holds of the icon object
6104 * and returns this last object. It is used in case you want to remove any
6105 * icon, or set another one, without deleting the actual object. The button
6106 * will be left without an icon set.
6108 * @param obj The button object
6109 * @return The icon object that was being used
6111 EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6113 * Turn on/off the autorepeat event generated when the button is kept pressed
6115 * When off, no autorepeat is performed and buttons emit a normal @c clicked
6116 * signal when they are clicked.
6118 * When on, keeping a button pressed will continuously emit a @c repeated
6119 * signal until the button is released. The time it takes until it starts
6120 * emitting the signal is given by
6121 * elm_button_autorepeat_initial_timeout_set(), and the time between each
6122 * new emission by elm_button_autorepeat_gap_timeout_set().
6124 * @param obj The button object
6125 * @param on A bool to turn on/off the event
6127 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6129 * Get whether the autorepeat feature is enabled
6131 * @param obj The button object
6132 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6134 * @see elm_button_autorepeat_set()
6136 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6138 * Set the initial timeout before the autorepeat event is generated
6140 * Sets the timeout, in seconds, since the button is pressed until the
6141 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6142 * won't be any delay and the even will be fired the moment the button is
6145 * @param obj The button object
6146 * @param t Timeout in seconds
6148 * @see elm_button_autorepeat_set()
6149 * @see elm_button_autorepeat_gap_timeout_set()
6151 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6153 * Get the initial timeout before the autorepeat event is generated
6155 * @param obj The button object
6156 * @return Timeout in seconds
6158 * @see elm_button_autorepeat_initial_timeout_set()
6160 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6162 * Set the interval between each generated autorepeat event
6164 * After the first @c repeated event is fired, all subsequent ones will
6165 * follow after a delay of @p t seconds for each.
6167 * @param obj The button object
6168 * @param t Interval in seconds
6170 * @see elm_button_autorepeat_initial_timeout_set()
6172 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6174 * Get the interval between each generated autorepeat event
6176 * @param obj The button object
6177 * @return Interval in seconds
6179 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6185 * @defgroup File_Selector_Button File Selector Button
6187 * @image html img/widget/fileselector_button/preview-00.png
6188 * @image latex img/widget/fileselector_button/preview-00.eps
6189 * @image html img/widget/fileselector_button/preview-01.png
6190 * @image latex img/widget/fileselector_button/preview-01.eps
6191 * @image html img/widget/fileselector_button/preview-02.png
6192 * @image latex img/widget/fileselector_button/preview-02.eps
6194 * This is a button that, when clicked, creates an Elementary
6195 * window (or inner window) <b> with a @ref Fileselector "file
6196 * selector widget" within</b>. When a file is chosen, the (inner)
6197 * window is closed and the button emits a signal having the
6198 * selected file as it's @c event_info.
6200 * This widget encapsulates operations on its internal file
6201 * selector on its own API. There is less control over its file
6202 * selector than that one would have instatiating one directly.
6204 * The following styles are available for this button:
6207 * @li @c "hoversel_vertical"
6208 * @li @c "hoversel_vertical_entry"
6210 * Smart callbacks one can register to:
6211 * - @c "file,chosen" - the user has selected a path, whose string
6212 * pointer comes as the @c event_info data (a stringshared
6215 * Here is an example on its usage:
6216 * @li @ref fileselector_button_example
6218 * @see @ref File_Selector_Entry for a similar widget.
6223 * Add a new file selector button widget to the given parent
6224 * Elementary (container) object
6226 * @param parent The parent object
6227 * @return a new file selector button widget handle or @c NULL, on
6230 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6233 * Set the label for a given file selector button widget
6235 * @param obj The file selector button widget
6236 * @param label The text label to be displayed on @p obj
6238 * @deprecated use elm_object_text_set() instead.
6240 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6243 * Get the label set for a given file selector button widget
6245 * @param obj The file selector button widget
6246 * @return The button label
6248 * @deprecated use elm_object_text_set() instead.
6250 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6253 * Set the icon on a given file selector button widget
6255 * @param obj The file selector button widget
6256 * @param icon The icon object for the button
6258 * Once the icon object is set, a previously set one will be
6259 * deleted. If you want to keep the latter, use the
6260 * elm_fileselector_button_icon_unset() function.
6262 * @see elm_fileselector_button_icon_get()
6264 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6267 * Get the icon set for a given file selector button widget
6269 * @param obj The file selector button widget
6270 * @return The icon object currently set on @p obj or @c NULL, if
6273 * @see elm_fileselector_button_icon_set()
6275 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6278 * Unset the icon used in a given file selector button widget
6280 * @param obj The file selector button widget
6281 * @return The icon object that was being used on @p obj or @c
6284 * Unparent and return the icon object which was set for this
6287 * @see elm_fileselector_button_icon_set()
6289 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6292 * Set the title for a given file selector button widget's window
6294 * @param obj The file selector button widget
6295 * @param title The title string
6297 * This will change the window's title, when the file selector pops
6298 * out after a click on the button. Those windows have the default
6299 * (unlocalized) value of @c "Select a file" as titles.
6301 * @note It will only take any effect if the file selector
6302 * button widget is @b not under "inwin mode".
6304 * @see elm_fileselector_button_window_title_get()
6306 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6309 * Get the title set for a given file selector button widget's
6312 * @param obj The file selector button widget
6313 * @return Title of the file selector button's window
6315 * @see elm_fileselector_button_window_title_get() for more details
6317 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6320 * Set the size of a given file selector button widget's window,
6321 * holding the file selector itself.
6323 * @param obj The file selector button widget
6324 * @param width The window's width
6325 * @param height The window's height
6327 * @note it will only take any effect if the file selector button
6328 * widget is @b not under "inwin mode". The default size for the
6329 * window (when applicable) is 400x400 pixels.
6331 * @see elm_fileselector_button_window_size_get()
6333 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6336 * Get the size of a given file selector button widget's window,
6337 * holding the file selector itself.
6339 * @param obj The file selector button widget
6340 * @param width Pointer into which to store the width value
6341 * @param height Pointer into which to store the height value
6343 * @note Use @c NULL pointers on the size values you're not
6344 * interested in: they'll be ignored by the function.
6346 * @see elm_fileselector_button_window_size_set(), for more details
6348 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6351 * Set the initial file system path for a given file selector
6354 * @param obj The file selector button widget
6355 * @param path The path string
6357 * It must be a <b>directory</b> path, which will have the contents
6358 * displayed initially in the file selector's view, when invoked
6359 * from @p obj. The default initial path is the @c "HOME"
6360 * environment variable's value.
6362 * @see elm_fileselector_button_path_get()
6364 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6367 * Get the initial file system path set for a given file selector
6370 * @param obj The file selector button widget
6371 * @return path The path string
6373 * @see elm_fileselector_button_path_set() for more details
6375 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6378 * Enable/disable a tree view in the given file selector button
6379 * widget's internal file selector
6381 * @param obj The file selector button widget
6382 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6385 * This has the same effect as elm_fileselector_expandable_set(),
6386 * but now applied to a file selector button's internal file
6389 * @note There's no way to put a file selector button's internal
6390 * file selector in "grid mode", as one may do with "pure" file
6393 * @see elm_fileselector_expandable_get()
6395 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6398 * Get whether tree view is enabled for the given file selector
6399 * button widget's internal file selector
6401 * @param obj The file selector button widget
6402 * @return @c EINA_TRUE if @p obj widget's internal file selector
6403 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6405 * @see elm_fileselector_expandable_set() for more details
6407 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6410 * Set whether a given file selector button widget's internal file
6411 * selector is to display folders only or the directory contents,
6414 * @param obj The file selector button widget
6415 * @param only @c EINA_TRUE to make @p obj widget's internal file
6416 * selector only display directories, @c EINA_FALSE to make files
6417 * to be displayed in it too
6419 * This has the same effect as elm_fileselector_folder_only_set(),
6420 * but now applied to a file selector button's internal file
6423 * @see elm_fileselector_folder_only_get()
6425 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6428 * Get whether a given file selector button widget's internal file
6429 * selector is displaying folders only or the directory contents,
6432 * @param obj The file selector button widget
6433 * @return @c EINA_TRUE if @p obj widget's internal file
6434 * selector is only displaying directories, @c EINA_FALSE if files
6435 * are being displayed in it too (and on errors)
6437 * @see elm_fileselector_button_folder_only_set() for more details
6439 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6442 * Enable/disable the file name entry box where the user can type
6443 * in a name for a file, in a given file selector button widget's
6444 * internal file selector.
6446 * @param obj The file selector button widget
6447 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6448 * file selector a "saving dialog", @c EINA_FALSE otherwise
6450 * This has the same effect as elm_fileselector_is_save_set(),
6451 * but now applied to a file selector button's internal file
6454 * @see elm_fileselector_is_save_get()
6456 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6459 * Get whether the given file selector button widget's internal
6460 * file selector is in "saving dialog" mode
6462 * @param obj The file selector button widget
6463 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6464 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6467 * @see elm_fileselector_button_is_save_set() for more details
6469 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6472 * Set whether a given file selector button widget's internal file
6473 * selector will raise an Elementary "inner window", instead of a
6474 * dedicated Elementary window. By default, it won't.
6476 * @param obj The file selector button widget
6477 * @param value @c EINA_TRUE to make it use an inner window, @c
6478 * EINA_TRUE to make it use a dedicated window
6480 * @see elm_win_inwin_add() for more information on inner windows
6481 * @see elm_fileselector_button_inwin_mode_get()
6483 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6486 * Get whether a given file selector button widget's internal file
6487 * selector will raise an Elementary "inner window", instead of a
6488 * dedicated Elementary window.
6490 * @param obj The file selector button widget
6491 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6492 * if it will use a dedicated window
6494 * @see elm_fileselector_button_inwin_mode_set() for more details
6496 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6503 * @defgroup File_Selector_Entry File Selector Entry
6505 * @image html img/widget/fileselector_entry/preview-00.png
6506 * @image latex img/widget/fileselector_entry/preview-00.eps
6508 * This is an entry made to be filled with or display a <b>file
6509 * system path string</b>. Besides the entry itself, the widget has
6510 * a @ref File_Selector_Button "file selector button" on its side,
6511 * which will raise an internal @ref Fileselector "file selector widget",
6512 * when clicked, for path selection aided by file system
6515 * This file selector may appear in an Elementary window or in an
6516 * inner window. When a file is chosen from it, the (inner) window
6517 * is closed and the selected file's path string is exposed both as
6518 * an smart event and as the new text on the entry.
6520 * This widget encapsulates operations on its internal file
6521 * selector on its own API. There is less control over its file
6522 * selector than that one would have instatiating one directly.
6524 * Smart callbacks one can register to:
6525 * - @c "changed" - The text within the entry was changed
6526 * - @c "activated" - The entry has had editing finished and
6527 * changes are to be "committed"
6528 * - @c "press" - The entry has been clicked
6529 * - @c "longpressed" - The entry has been clicked (and held) for a
6531 * - @c "clicked" - The entry has been clicked
6532 * - @c "clicked,double" - The entry has been double clicked
6533 * - @c "focused" - The entry has received focus
6534 * - @c "unfocused" - The entry has lost focus
6535 * - @c "selection,paste" - A paste action has occurred on the
6537 * - @c "selection,copy" - A copy action has occurred on the entry
6538 * - @c "selection,cut" - A cut action has occurred on the entry
6539 * - @c "unpressed" - The file selector entry's button was released
6540 * after being pressed.
6541 * - @c "file,chosen" - The user has selected a path via the file
6542 * selector entry's internal file selector, whose string pointer
6543 * comes as the @c event_info data (a stringshared string)
6545 * Here is an example on its usage:
6546 * @li @ref fileselector_entry_example
6548 * @see @ref File_Selector_Button for a similar widget.
6553 * Add a new file selector entry widget to the given parent
6554 * Elementary (container) object
6556 * @param parent The parent object
6557 * @return a new file selector entry widget handle or @c NULL, on
6560 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6563 * Set the label for a given file selector entry widget's button
6565 * @param obj The file selector entry widget
6566 * @param label The text label to be displayed on @p obj widget's
6569 * @deprecated use elm_object_text_set() instead.
6571 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6574 * Get the label set for a given file selector entry widget's button
6576 * @param obj The file selector entry widget
6577 * @return The widget button's label
6579 * @deprecated use elm_object_text_set() instead.
6581 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6584 * Set the icon on a given file selector entry widget's button
6586 * @param obj The file selector entry widget
6587 * @param icon The icon object for the entry's button
6589 * Once the icon object is set, a previously set one will be
6590 * deleted. If you want to keep the latter, use the
6591 * elm_fileselector_entry_button_icon_unset() function.
6593 * @see elm_fileselector_entry_button_icon_get()
6595 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6598 * Get the icon set for a given file selector entry widget's button
6600 * @param obj The file selector entry widget
6601 * @return The icon object currently set on @p obj widget's button
6602 * or @c NULL, if none is
6604 * @see elm_fileselector_entry_button_icon_set()
6606 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6609 * Unset the icon used in a given file selector entry widget's
6612 * @param obj The file selector entry widget
6613 * @return The icon object that was being used on @p obj widget's
6614 * button or @c NULL, on errors
6616 * Unparent and return the icon object which was set for this
6619 * @see elm_fileselector_entry_button_icon_set()
6621 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6624 * Set the title for a given file selector entry widget's window
6626 * @param obj The file selector entry widget
6627 * @param title The title string
6629 * This will change the window's title, when the file selector pops
6630 * out after a click on the entry's button. Those windows have the
6631 * default (unlocalized) value of @c "Select a file" as titles.
6633 * @note It will only take any effect if the file selector
6634 * entry widget is @b not under "inwin mode".
6636 * @see elm_fileselector_entry_window_title_get()
6638 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6641 * Get the title set for a given file selector entry widget's
6644 * @param obj The file selector entry widget
6645 * @return Title of the file selector entry's window
6647 * @see elm_fileselector_entry_window_title_get() for more details
6649 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6652 * Set the size of a given file selector entry widget's window,
6653 * holding the file selector itself.
6655 * @param obj The file selector entry widget
6656 * @param width The window's width
6657 * @param height The window's height
6659 * @note it will only take any effect if the file selector entry
6660 * widget is @b not under "inwin mode". The default size for the
6661 * window (when applicable) is 400x400 pixels.
6663 * @see elm_fileselector_entry_window_size_get()
6665 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6668 * Get the size of a given file selector entry widget's window,
6669 * holding the file selector itself.
6671 * @param obj The file selector entry widget
6672 * @param width Pointer into which to store the width value
6673 * @param height Pointer into which to store the height value
6675 * @note Use @c NULL pointers on the size values you're not
6676 * interested in: they'll be ignored by the function.
6678 * @see elm_fileselector_entry_window_size_set(), for more details
6680 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6683 * Set the initial file system path and the entry's path string for
6684 * a given file selector entry widget
6686 * @param obj The file selector entry widget
6687 * @param path The path string
6689 * It must be a <b>directory</b> path, which will have the contents
6690 * displayed initially in the file selector's view, when invoked
6691 * from @p obj. The default initial path is the @c "HOME"
6692 * environment variable's value.
6694 * @see elm_fileselector_entry_path_get()
6696 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6699 * Get the entry's path string for a given file selector entry
6702 * @param obj The file selector entry widget
6703 * @return path The path string
6705 * @see elm_fileselector_entry_path_set() for more details
6707 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6710 * Enable/disable a tree view in the given file selector entry
6711 * widget's internal file selector
6713 * @param obj The file selector entry widget
6714 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6717 * This has the same effect as elm_fileselector_expandable_set(),
6718 * but now applied to a file selector entry's internal file
6721 * @note There's no way to put a file selector entry's internal
6722 * file selector in "grid mode", as one may do with "pure" file
6725 * @see elm_fileselector_expandable_get()
6727 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6730 * Get whether tree view is enabled for the given file selector
6731 * entry widget's internal file selector
6733 * @param obj The file selector entry widget
6734 * @return @c EINA_TRUE if @p obj widget's internal file selector
6735 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6737 * @see elm_fileselector_expandable_set() for more details
6739 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6742 * Set whether a given file selector entry widget's internal file
6743 * selector is to display folders only or the directory contents,
6746 * @param obj The file selector entry widget
6747 * @param only @c EINA_TRUE to make @p obj widget's internal file
6748 * selector only display directories, @c EINA_FALSE to make files
6749 * to be displayed in it too
6751 * This has the same effect as elm_fileselector_folder_only_set(),
6752 * but now applied to a file selector entry's internal file
6755 * @see elm_fileselector_folder_only_get()
6757 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6760 * Get whether a given file selector entry widget's internal file
6761 * selector is displaying folders only or the directory contents,
6764 * @param obj The file selector entry widget
6765 * @return @c EINA_TRUE if @p obj widget's internal file
6766 * selector is only displaying directories, @c EINA_FALSE if files
6767 * are being displayed in it too (and on errors)
6769 * @see elm_fileselector_entry_folder_only_set() for more details
6771 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6774 * Enable/disable the file name entry box where the user can type
6775 * in a name for a file, in a given file selector entry widget's
6776 * internal file selector.
6778 * @param obj The file selector entry widget
6779 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6780 * file selector a "saving dialog", @c EINA_FALSE otherwise
6782 * This has the same effect as elm_fileselector_is_save_set(),
6783 * but now applied to a file selector entry's internal file
6786 * @see elm_fileselector_is_save_get()
6788 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6791 * Get whether the given file selector entry widget's internal
6792 * file selector is in "saving dialog" mode
6794 * @param obj The file selector entry widget
6795 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6796 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6799 * @see elm_fileselector_entry_is_save_set() for more details
6801 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6804 * Set whether a given file selector entry widget's internal file
6805 * selector will raise an Elementary "inner window", instead of a
6806 * dedicated Elementary window. By default, it won't.
6808 * @param obj The file selector entry widget
6809 * @param value @c EINA_TRUE to make it use an inner window, @c
6810 * EINA_TRUE to make it use a dedicated window
6812 * @see elm_win_inwin_add() for more information on inner windows
6813 * @see elm_fileselector_entry_inwin_mode_get()
6815 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6818 * Get whether a given file selector entry widget's internal file
6819 * selector will raise an Elementary "inner window", instead of a
6820 * dedicated Elementary window.
6822 * @param obj The file selector entry widget
6823 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6824 * if it will use a dedicated window
6826 * @see elm_fileselector_entry_inwin_mode_set() for more details
6828 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6831 * Set the initial file system path for a given file selector entry
6834 * @param obj The file selector entry widget
6835 * @param path The path string
6837 * It must be a <b>directory</b> path, which will have the contents
6838 * displayed initially in the file selector's view, when invoked
6839 * from @p obj. The default initial path is the @c "HOME"
6840 * environment variable's value.
6842 * @see elm_fileselector_entry_path_get()
6844 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6847 * Get the parent directory's path to the latest file selection on
6848 * a given filer selector entry widget
6850 * @param obj The file selector object
6851 * @return The (full) path of the directory of the last selection
6852 * on @p obj widget, a @b stringshared string
6854 * @see elm_fileselector_entry_path_set()
6856 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6863 * @defgroup Scroller Scroller
6865 * A scroller holds a single object and "scrolls it around". This means that
6866 * it allows the user to use a scrollbar (or a finger) to drag the viewable
6867 * region around, allowing to move through a much larger object that is
6868 * contained in the scroller. The scroiller will always have a small minimum
6869 * size by default as it won't be limited by the contents of the scroller.
6871 * Signals that you can add callbacks for are:
6872 * @li "edge,left" - the left edge of the content has been reached
6873 * @li "edge,right" - the right edge of the content has been reached
6874 * @li "edge,top" - the top edge of the content has been reached
6875 * @li "edge,bottom" - the bottom edge of the content has been reached
6876 * @li "scroll" - the content has been scrolled (moved)
6877 * @li "scroll,anim,start" - scrolling animation has started
6878 * @li "scroll,anim,stop" - scrolling animation has stopped
6879 * @li "scroll,drag,start" - dragging the contents around has started
6880 * @li "scroll,drag,stop" - dragging the contents around has stopped
6881 * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
6884 * @note When Elemementary is in embedded mode the scrollbars will not be
6885 * dragable, they appear merely as indicators of how much has been scrolled.
6886 * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
6887 * fingerscroll) won't work.
6889 * In @ref tutorial_scroller you'll find an example of how to use most of
6894 * @brief Type that controls when scrollbars should appear.
6896 * @see elm_scroller_policy_set()
6898 typedef enum _Elm_Scroller_Policy
6900 ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
6901 ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
6902 ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
6903 ELM_SCROLLER_POLICY_LAST
6904 } Elm_Scroller_Policy;
6906 * @brief Add a new scroller to the parent
6908 * @param parent The parent object
6909 * @return The new object or NULL if it cannot be created
6911 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6913 * @brief Set the content of the scroller widget (the object to be scrolled around).
6915 * @param obj The scroller object
6916 * @param content The new content object
6918 * Once the content object is set, a previously set one will be deleted.
6919 * If you want to keep that old content object, use the
6920 * elm_scroller_content_unset() function.
6922 EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
6924 * @brief Get the content of the scroller widget
6926 * @param obj The slider object
6927 * @return The content that is being used
6929 * Return the content object which is set for this widget
6931 * @see elm_scroller_content_set()
6933 EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6935 * @brief Unset the content of the scroller widget
6937 * @param obj The slider object
6938 * @return The content that was being used
6940 * Unparent and return the content object which was set for this widget
6942 * @see elm_scroller_content_set()
6944 EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6946 * @brief Set custom theme elements for the scroller
6948 * @param obj The scroller object
6949 * @param widget The widget name to use (default is "scroller")
6950 * @param base The base name to use (default is "base")
6952 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
6954 * @brief Make the scroller minimum size limited to the minimum size of the content
6956 * @param obj The scroller object
6957 * @param w Enable limiting minimum size horizontally
6958 * @param h Enable limiting minimum size vertically
6960 * By default the scroller will be as small as its design allows,
6961 * irrespective of its content. This will make the scroller minimum size the
6962 * right size horizontally and/or vertically to perfectly fit its content in
6965 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
6967 * @brief Show a specific virtual region within the scroller content object
6969 * @param obj The scroller object
6970 * @param x X coordinate of the region
6971 * @param y Y coordinate of the region
6972 * @param w Width of the region
6973 * @param h Height of the region
6975 * This will ensure all (or part if it does not fit) of the designated
6976 * region in the virtual content object (0, 0 starting at the top-left of the
6977 * virtual content object) is shown within the scroller.
6979 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);
6981 * @brief Set the scrollbar visibility policy
6983 * @param obj The scroller object
6984 * @param policy_h Horizontal scrollbar policy
6985 * @param policy_v Vertical scrollbar policy
6987 * This sets the scrollbar visibility policy for the given scroller.
6988 * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
6989 * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
6990 * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
6991 * respectively for the horizontal and vertical scrollbars.
6993 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
6995 * @brief Gets scrollbar visibility policy
6997 * @param obj The scroller object
6998 * @param policy_h Horizontal scrollbar policy
6999 * @param policy_v Vertical scrollbar policy
7001 * @see elm_scroller_policy_set()
7003 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
7005 * @brief Get the currently visible content region
7007 * @param obj The scroller object
7008 * @param x X coordinate of the region
7009 * @param y Y coordinate of the region
7010 * @param w Width of the region
7011 * @param h Height of the region
7013 * This gets the current region in the content object that is visible through
7014 * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
7015 * w, @p h values pointed to.
7017 * @note All coordinates are relative to the content.
7019 * @see elm_scroller_region_show()
7021 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);
7023 * @brief Get the size of the content object
7025 * @param obj The scroller object
7026 * @param w Width return
7027 * @param h Height return
7029 * This gets the size of the content object of the scroller.
7031 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7033 * @brief Set bouncing behavior
7035 * @param obj The scroller object
7036 * @param h_bounce Will the scroller bounce horizontally or not
7037 * @param v_bounce Will the scroller bounce vertically or not
7039 * When scrolling, the scroller may "bounce" when reaching an edge of the
7040 * content object. This is a visual way to indicate the end has been reached.
7041 * This is enabled by default for both axis. This will set if it is enabled
7042 * for that axis with the boolean parameters for each axis.
7044 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7046 * @brief Get the bounce mode
7048 * @param obj The Scroller object
7049 * @param h_bounce Allow bounce horizontally
7050 * @param v_bounce Allow bounce vertically
7052 * @see elm_scroller_bounce_set()
7054 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7056 * @brief Set scroll page size relative to viewport size.
7058 * @param obj The scroller object
7059 * @param h_pagerel The horizontal page relative size
7060 * @param v_pagerel The vertical page relative size
7062 * The scroller is capable of limiting scrolling by the user to "pages". That
7063 * is to jump by and only show a "whole page" at a time as if the continuous
7064 * area of the scroller content is split into page sized pieces. This sets
7065 * the size of a page relative to the viewport of the scroller. 1.0 is "1
7066 * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7067 * axis. This is mutually exclusive with page size
7068 * (see elm_scroller_page_size_set() for more information). Likewise 0.5
7069 * is "half a viewport". Sane usable valus are normally between 0.0 and 1.0
7070 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7073 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7075 * @brief Set scroll page size.
7077 * @param obj The scroller object
7078 * @param h_pagesize The horizontal page size
7079 * @param v_pagesize The vertical page size
7081 * This sets the page size to an absolute fixed value, with 0 turning it off
7084 * @see elm_scroller_page_relative_set()
7086 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7088 * @brief Get scroll current page number.
7090 * @param obj The scroller object
7091 * @param h_pagenumber The horizontal page number
7092 * @param v_pagenumber The vertical page number
7094 * The page number starts from 0. 0 is the first page.
7095 * Current page means the page which meet the top-left of the viewport.
7096 * If there are two or more pages in the viewport, it returns the number of page
7097 * which meet the top-left of the viewport.
7099 * @see elm_scroller_last_page_get()
7100 * @see elm_scroller_page_show()
7101 * @see elm_scroller_page_brint_in()
7103 EAPI void elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7105 * @brief Get scroll last page number.
7107 * @param obj The scroller object
7108 * @param h_pagenumber The horizontal page number
7109 * @param v_pagenumber The vertical page number
7111 * The page number starts from 0. 0 is the first page.
7112 * This returns the last page number among the pages.
7114 * @see elm_scroller_current_page_get()
7115 * @see elm_scroller_page_show()
7116 * @see elm_scroller_page_brint_in()
7118 EAPI void elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7120 * Show a specific virtual region within the scroller content object by page number.
7122 * @param obj The scroller object
7123 * @param h_pagenumber The horizontal page number
7124 * @param v_pagenumber The vertical page number
7126 * 0, 0 of the indicated page is located at the top-left of the viewport.
7127 * This will jump to the page directly without animation.
7132 * sc = elm_scroller_add(win);
7133 * elm_scroller_content_set(sc, content);
7134 * elm_scroller_page_relative_set(sc, 1, 0);
7135 * elm_scroller_current_page_get(sc, &h_page, &v_page);
7136 * elm_scroller_page_show(sc, h_page + 1, v_page);
7139 * @see elm_scroller_page_bring_in()
7141 EAPI void elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7143 * Show a specific virtual region within the scroller content object by page number.
7145 * @param obj The scroller object
7146 * @param h_pagenumber The horizontal page number
7147 * @param v_pagenumber The vertical page number
7149 * 0, 0 of the indicated page is located at the top-left of the viewport.
7150 * This will slide to the page with animation.
7155 * sc = elm_scroller_add(win);
7156 * elm_scroller_content_set(sc, content);
7157 * elm_scroller_page_relative_set(sc, 1, 0);
7158 * elm_scroller_last_page_get(sc, &h_page, &v_page);
7159 * elm_scroller_page_bring_in(sc, h_page, v_page);
7162 * @see elm_scroller_page_show()
7164 EAPI void elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7166 * @brief Show a specific virtual region within the scroller content object.
7168 * @param obj The scroller object
7169 * @param x X coordinate of the region
7170 * @param y Y coordinate of the region
7171 * @param w Width of the region
7172 * @param h Height of the region
7174 * This will ensure all (or part if it does not fit) of the designated
7175 * region in the virtual content object (0, 0 starting at the top-left of the
7176 * virtual content object) is shown within the scroller. Unlike
7177 * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7178 * to this location (if configuration in general calls for transitions). It
7179 * may not jump immediately to the new location and make take a while and
7180 * show other content along the way.
7182 * @see elm_scroller_region_show()
7184 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);
7186 * @brief Set event propagation on a scroller
7188 * @param obj The scroller object
7189 * @param propagation If propagation is enabled or not
7191 * This enables or disabled event propagation from the scroller content to
7192 * the scroller and its parent. By default event propagation is disabled.
7194 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
7196 * @brief Get event propagation for a scroller
7198 * @param obj The scroller object
7199 * @return The propagation state
7201 * This gets the event propagation for a scroller.
7203 * @see elm_scroller_propagate_events_set()
7205 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj);
7211 * @defgroup Label Label
7213 * @image html img/widget/label/preview-00.png
7214 * @image latex img/widget/label/preview-00.eps
7216 * @brief Widget to display text, with simple html-like markup.
7218 * The Label widget @b doesn't allow text to overflow its boundaries, if the
7219 * text doesn't fit the geometry of the label it will be ellipsized or be
7220 * cut. Elementary provides several themes for this widget:
7221 * @li default - No animation
7222 * @li marker - Centers the text in the label and make it bold by default
7223 * @li slide_long - The entire text appears from the right of the screen and
7224 * slides until it disappears in the left of the screen(reappering on the
7226 * @li slide_short - The text appears in the left of the label and slides to
7227 * the right to show the overflow. When all of the text has been shown the
7228 * position is reset.
7229 * @li slide_bounce - The text appears in the left of the label and slides to
7230 * the right to show the overflow. When all of the text has been shown the
7231 * animation reverses, moving the text to the left.
7233 * Custom themes can of course invent new markup tags and style them any way
7236 * See @ref tutorial_label for a demonstration of how to use a label widget.
7240 * @brief Add a new label to the parent
7242 * @param parent The parent object
7243 * @return The new object or NULL if it cannot be created
7245 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7247 * @brief Set the label on the label object
7249 * @param obj The label object
7250 * @param label The label will be used on the label object
7251 * @deprecated See elm_object_text_set()
7253 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 */
7255 * @brief Get the label used on the label object
7257 * @param obj The label object
7258 * @return The string inside the label
7259 * @deprecated See elm_object_text_get()
7261 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7263 * @brief Set the wrapping behavior of the label
7265 * @param obj The label object
7266 * @param wrap To wrap text or not
7268 * By default no wrapping is done. Possible values for @p wrap are:
7269 * @li ELM_WRAP_NONE - No wrapping
7270 * @li ELM_WRAP_CHAR - wrap between characters
7271 * @li ELM_WRAP_WORD - wrap between words
7272 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7274 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7276 * @brief Get the wrapping behavior of the label
7278 * @param obj The label object
7281 * @see elm_label_line_wrap_set()
7283 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7285 * @brief Set wrap width of the label
7287 * @param obj The label object
7288 * @param w The wrap width in pixels at a minimum where words need to wrap
7290 * This function sets the maximum width size hint of the label.
7292 * @warning This is only relevant if the label is inside a container.
7294 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7296 * @brief Get wrap width of the label
7298 * @param obj The label object
7299 * @return The wrap width in pixels at a minimum where words need to wrap
7301 * @see elm_label_wrap_width_set()
7303 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7305 * @brief Set wrap height of the label
7307 * @param obj The label object
7308 * @param h The wrap height in pixels at a minimum where words need to wrap
7310 * This function sets the maximum height size hint of the label.
7312 * @warning This is only relevant if the label is inside a container.
7314 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7316 * @brief get wrap width of the label
7318 * @param obj The label object
7319 * @return The wrap height in pixels at a minimum where words need to wrap
7321 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7323 * @brief Set the font size on the label object.
7325 * @param obj The label object
7326 * @param size font size
7328 * @warning NEVER use this. It is for hyper-special cases only. use styles
7329 * instead. e.g. "big", "medium", "small" - or better name them by use:
7330 * "title", "footnote", "quote" etc.
7332 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7334 * @brief Set the text color on the label object
7336 * @param obj The label object
7337 * @param r Red property background color of The label object
7338 * @param g Green property background color of The label object
7339 * @param b Blue property background color of The label object
7340 * @param a Alpha property background color of The label object
7342 * @warning NEVER use this. It is for hyper-special cases only. use styles
7343 * instead. e.g. "big", "medium", "small" - or better name them by use:
7344 * "title", "footnote", "quote" etc.
7346 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);
7348 * @brief Set the text align on the label object
7350 * @param obj The label object
7351 * @param align align mode ("left", "center", "right")
7353 * @warning NEVER use this. It is for hyper-special cases only. use styles
7354 * instead. e.g. "big", "medium", "small" - or better name them by use:
7355 * "title", "footnote", "quote" etc.
7357 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7359 * @brief Set background color of the label
7361 * @param obj The label object
7362 * @param r Red property background color of The label object
7363 * @param g Green property background color of The label object
7364 * @param b Blue property background color of The label object
7365 * @param a Alpha property background alpha of The label object
7367 * @warning NEVER use this. It is for hyper-special cases only. use styles
7368 * instead. e.g. "big", "medium", "small" - or better name them by use:
7369 * "title", "footnote", "quote" etc.
7371 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);
7373 * @brief Set the ellipsis behavior of the label
7375 * @param obj The label object
7376 * @param ellipsis To ellipsis text or not
7378 * If set to true and the text doesn't fit in the label an ellipsis("...")
7379 * will be shown at the end of the widget.
7381 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7382 * choosen wrap method was ELM_WRAP_WORD.
7384 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7386 * @brief Set the text slide of the label
7388 * @param obj The label object
7389 * @param slide To start slide or stop
7391 * If set to true the text of the label will slide throught the length of
7394 * @warning This only work with the themes "slide_short", "slide_long" and
7397 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7399 * @brief Get the text slide mode of the label
7401 * @param obj The label object
7402 * @return slide slide mode value
7404 * @see elm_label_slide_set()
7406 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7408 * @brief Set the slide duration(speed) of the label
7410 * @param obj The label object
7411 * @return The duration in seconds in moving text from slide begin position
7412 * to slide end position
7414 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7416 * @brief Get the slide duration(speed) of the label
7418 * @param obj The label object
7419 * @return The duration time in moving text from slide begin position to slide end position
7421 * @see elm_label_slide_duration_set()
7423 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7429 * @defgroup Toggle Toggle
7431 * @image html img/widget/toggle/preview-00.png
7432 * @image latex img/widget/toggle/preview-00.eps
7434 * @brief A toggle is a slider which can be used to toggle between
7435 * two values. It has two states: on and off.
7437 * Signals that you can add callbacks for are:
7438 * @li "changed" - Whenever the toggle value has been changed. Is not called
7439 * until the toggle is released by the cursor (assuming it
7440 * has been triggered by the cursor in the first place).
7442 * @ref tutorial_toggle show how to use a toggle.
7446 * @brief Add a toggle to @p parent.
7448 * @param parent The parent object
7450 * @return The toggle object
7452 EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7454 * @brief Sets the label to be displayed with the toggle.
7456 * @param obj The toggle object
7457 * @param label The label to be displayed
7459 * @deprecated use elm_object_text_set() instead.
7461 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7463 * @brief Gets the label of the toggle
7465 * @param obj toggle object
7466 * @return The label of the toggle
7468 * @deprecated use elm_object_text_get() instead.
7470 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7472 * @brief Set the icon used for the toggle
7474 * @param obj The toggle object
7475 * @param icon The icon object for the button
7477 * Once the icon object is set, a previously set one will be deleted
7478 * If you want to keep that old content object, use the
7479 * elm_toggle_icon_unset() function.
7481 EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7483 * @brief Get the icon used for the toggle
7485 * @param obj The toggle object
7486 * @return The icon object that is being used
7488 * Return the icon object which is set for this widget.
7490 * @see elm_toggle_icon_set()
7492 EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7494 * @brief Unset the icon used for the toggle
7496 * @param obj The toggle object
7497 * @return The icon object that was being used
7499 * Unparent and return the icon object which was set for this widget.
7501 * @see elm_toggle_icon_set()
7503 EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7505 * @brief Sets the labels to be associated with the on and off states of the toggle.
7507 * @param obj The toggle object
7508 * @param onlabel The label displayed when the toggle is in the "on" state
7509 * @param offlabel The label displayed when the toggle is in the "off" state
7511 EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7513 * @brief Gets the labels associated with the on and off states of the toggle.
7515 * @param obj The toggle object
7516 * @param onlabel A char** to place the onlabel of @p obj into
7517 * @param offlabel A char** to place the offlabel of @p obj into
7519 EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7521 * @brief Sets the state of the toggle to @p state.
7523 * @param obj The toggle object
7524 * @param state The state of @p obj
7526 EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7528 * @brief Gets the state of the toggle to @p state.
7530 * @param obj The toggle object
7531 * @return The state of @p obj
7533 EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7535 * @brief Sets the state pointer of the toggle to @p statep.
7537 * @param obj The toggle object
7538 * @param statep The state pointer of @p obj
7540 EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7546 * @defgroup Frame Frame
7548 * @image html img/widget/frame/preview-00.png
7549 * @image latex img/widget/frame/preview-00.eps
7551 * @brief Frame is a widget that holds some content and has a title.
7553 * The default look is a frame with a title, but Frame supports multple
7561 * @li outdent_bottom
7563 * Of all this styles only default shows the title. Frame emits no signals.
7565 * For a detailed example see the @ref tutorial_frame.
7570 * @brief Add a new frame to the parent
7572 * @param parent The parent object
7573 * @return The new object or NULL if it cannot be created
7575 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7577 * @brief Set the frame label
7579 * @param obj The frame object
7580 * @param label The label of this frame object
7582 * @deprecated use elm_object_text_set() instead.
7584 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7586 * @brief Get the frame label
7588 * @param obj The frame object
7590 * @return The label of this frame objet or NULL if unable to get frame
7592 * @deprecated use elm_object_text_get() instead.
7594 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7596 * @brief Set the content of the frame widget
7598 * Once the content object is set, a previously set one will be deleted.
7599 * If you want to keep that old content object, use the
7600 * elm_frame_content_unset() function.
7602 * @param obj The frame object
7603 * @param content The content will be filled in this frame object
7605 EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7607 * @brief Get the content of the frame widget
7609 * Return the content object which is set for this widget
7611 * @param obj The frame object
7612 * @return The content that is being used
7614 EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7616 * @brief Unset the content of the frame widget
7618 * Unparent and return the content object which was set for this widget
7620 * @param obj The frame object
7621 * @return The content that was being used
7623 EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7629 * @defgroup Table Table
7631 * A container widget to arrange other widgets in a table where items can
7632 * also span multiple columns or rows - even overlap (and then be raised or
7633 * lowered accordingly to adjust stacking if they do overlap).
7635 * The followin are examples of how to use a table:
7636 * @li @ref tutorial_table_01
7637 * @li @ref tutorial_table_02
7642 * @brief Add a new table to the parent
7644 * @param parent The parent object
7645 * @return The new object or NULL if it cannot be created
7647 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7649 * @brief Set the homogeneous layout in the table
7651 * @param obj The layout object
7652 * @param homogeneous A boolean to set if the layout is homogeneous in the
7653 * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7655 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7657 * @brief Get the current table homogeneous mode.
7659 * @param obj The table object
7660 * @return A boolean to indicating if the layout is homogeneous in the table
7661 * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7663 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7665 * @warning <b>Use elm_table_homogeneous_set() instead</b>
7667 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7669 * @warning <b>Use elm_table_homogeneous_get() instead</b>
7671 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7673 * @brief Set padding between cells.
7675 * @param obj The layout object.
7676 * @param horizontal set the horizontal padding.
7677 * @param vertical set the vertical padding.
7679 * Default value is 0.
7681 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7683 * @brief Get padding between cells.
7685 * @param obj The layout object.
7686 * @param horizontal set the horizontal padding.
7687 * @param vertical set the vertical padding.
7689 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7691 * @brief Add a subobject on the table with the coordinates passed
7693 * @param obj The table object
7694 * @param subobj The subobject to be added to the table
7695 * @param x Row number
7696 * @param y Column number
7700 * @note All positioning inside the table is relative to rows and columns, so
7701 * a value of 0 for x and y, means the top left cell of the table, and a
7702 * value of 1 for w and h means @p subobj only takes that 1 cell.
7704 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7706 * @brief Remove child from table.
7708 * @param obj The table object
7709 * @param subobj The subobject
7711 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
7713 * @brief Faster way to remove all child objects from a table object.
7715 * @param obj The table object
7716 * @param clear If true, will delete children, else just remove from table.
7718 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
7720 * @brief Set the packing location of an existing child of the table
7722 * @param subobj The subobject to be modified in the table
7723 * @param x Row number
7724 * @param y Column number
7728 * Modifies the position of an object already in the table.
7730 * @note All positioning inside the table is relative to rows and columns, so
7731 * a value of 0 for x and y, means the top left cell of the table, and a
7732 * value of 1 for w and h means @p subobj only takes that 1 cell.
7734 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7736 * @brief Get the packing location of an existing child of the table
7738 * @param subobj The subobject to be modified in the table
7739 * @param x Row number
7740 * @param y Column number
7744 * @see elm_table_pack_set()
7746 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
7752 * @defgroup Gengrid Gengrid (Generic grid)
7754 * This widget aims to position objects in a grid layout while
7755 * actually creating and rendering only the visible ones, using the
7756 * same idea as the @ref Genlist "genlist": the user defines a @b
7757 * class for each item, specifying functions that will be called at
7758 * object creation, deletion, etc. When those items are selected by
7759 * the user, a callback function is issued. Users may interact with
7760 * a gengrid via the mouse (by clicking on items to select them and
7761 * clicking on the grid's viewport and swiping to pan the whole
7762 * view) or via the keyboard, navigating through item with the
7765 * @section Gengrid_Layouts Gengrid layouts
7767 * Gengrids may layout its items in one of two possible layouts:
7771 * When in "horizontal mode", items will be placed in @b columns,
7772 * from top to bottom and, when the space for a column is filled,
7773 * another one is started on the right, thus expanding the grid
7774 * horizontally, making for horizontal scrolling. When in "vertical
7775 * mode" , though, items will be placed in @b rows, from left to
7776 * right and, when the space for a row is filled, another one is
7777 * started below, thus expanding the grid vertically (and making
7778 * for vertical scrolling).
7780 * @section Gengrid_Items Gengrid items
7782 * An item in a gengrid can have 0 or more text labels (they can be
7783 * regular text or textblock Evas objects - that's up to the style
7784 * to determine), 0 or more icons (which are simply objects
7785 * swallowed into the gengrid item's theming Edje object) and 0 or
7786 * more <b>boolean states</b>, which have the behavior left to the
7787 * user to define. The Edje part names for each of these properties
7788 * will be looked up, in the theme file for the gengrid, under the
7789 * Edje (string) data items named @c "labels", @c "icons" and @c
7790 * "states", respectively. For each of those properties, if more
7791 * than one part is provided, they must have names listed separated
7792 * by spaces in the data fields. For the default gengrid item
7793 * theme, we have @b one label part (@c "elm.text"), @b two icon
7794 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
7797 * A gengrid item may be at one of several styles. Elementary
7798 * provides one by default - "default", but this can be extended by
7799 * system or application custom themes/overlays/extensions (see
7800 * @ref Theme "themes" for more details).
7802 * @section Gengrid_Item_Class Gengrid item classes
7804 * In order to have the ability to add and delete items on the fly,
7805 * gengrid implements a class (callback) system where the
7806 * application provides a structure with information about that
7807 * type of item (gengrid may contain multiple different items with
7808 * different classes, states and styles). Gengrid will call the
7809 * functions in this struct (methods) when an item is "realized"
7810 * (i.e., created dynamically, while the user is scrolling the
7811 * grid). All objects will simply be deleted when no longer needed
7812 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
7813 * contains the following members:
7814 * - @c item_style - This is a constant string and simply defines
7815 * the name of the item style. It @b must be specified and the
7816 * default should be @c "default".
7817 * - @c func.label_get - This function is called when an item
7818 * object is actually created. The @c data parameter will point to
7819 * the same data passed to elm_gengrid_item_append() and related
7820 * item creation functions. The @c obj parameter is the gengrid
7821 * object itself, while the @c part one is the name string of one
7822 * of the existing text parts in the Edje group implementing the
7823 * item's theme. This function @b must return a strdup'()ed string,
7824 * as the caller will free() it when done. See
7825 * #Elm_Gengrid_Item_Label_Get_Cb.
7826 * - @c func.icon_get - This function is called when an item object
7827 * is actually created. The @c data parameter will point to the
7828 * same data passed to elm_gengrid_item_append() and related item
7829 * creation functions. The @c obj parameter is the gengrid object
7830 * itself, while the @c part one is the name string of one of the
7831 * existing (icon) swallow parts in the Edje group implementing the
7832 * item's theme. It must return @c NULL, when no icon is desired,
7833 * or a valid object handle, otherwise. The object will be deleted
7834 * by the gengrid on its deletion or when the item is "unrealized".
7835 * See #Elm_Gengrid_Item_Icon_Get_Cb.
7836 * - @c func.state_get - This function is called when an item
7837 * object is actually created. The @c data parameter will point to
7838 * the same data passed to elm_gengrid_item_append() and related
7839 * item creation functions. The @c obj parameter is the gengrid
7840 * object itself, while the @c part one is the name string of one
7841 * of the state parts in the Edje group implementing the item's
7842 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
7843 * true/on. Gengrids will emit a signal to its theming Edje object
7844 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
7845 * "source" arguments, respectively, when the state is true (the
7846 * default is false), where @c XXX is the name of the (state) part.
7847 * See #Elm_Gengrid_Item_State_Get_Cb.
7848 * - @c func.del - This is called when elm_gengrid_item_del() is
7849 * called on an item or elm_gengrid_clear() is called on the
7850 * gengrid. This is intended for use when gengrid items are
7851 * deleted, so any data attached to the item (e.g. its data
7852 * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
7854 * @section Gengrid_Usage_Hints Usage hints
7856 * If the user wants to have multiple items selected at the same
7857 * time, elm_gengrid_multi_select_set() will permit it. If the
7858 * gengrid is single-selection only (the default), then
7859 * elm_gengrid_select_item_get() will return the selected item or
7860 * @c NULL, if none is selected. If the gengrid is under
7861 * multi-selection, then elm_gengrid_selected_items_get() will
7862 * return a list (that is only valid as long as no items are
7863 * modified (added, deleted, selected or unselected) of child items
7866 * If an item changes (internal (boolean) state, label or icon
7867 * changes), then use elm_gengrid_item_update() to have gengrid
7868 * update the item with the new state. A gengrid will re-"realize"
7869 * the item, thus calling the functions in the
7870 * #Elm_Gengrid_Item_Class set for that item.
7872 * To programmatically (un)select an item, use
7873 * elm_gengrid_item_selected_set(). To get its selected state use
7874 * elm_gengrid_item_selected_get(). To make an item disabled
7875 * (unable to be selected and appear differently) use
7876 * elm_gengrid_item_disabled_set() to set this and
7877 * elm_gengrid_item_disabled_get() to get the disabled state.
7879 * Grid cells will only have their selection smart callbacks called
7880 * when firstly getting selected. Any further clicks will do
7881 * nothing, unless you enable the "always select mode", with
7882 * elm_gengrid_always_select_mode_set(), thus making every click to
7883 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
7884 * turn off the ability to select items entirely in the widget and
7885 * they will neither appear selected nor call the selection smart
7888 * Remember that you can create new styles and add your own theme
7889 * augmentation per application with elm_theme_extension_add(). If
7890 * you absolutely must have a specific style that overrides any
7891 * theme the user or system sets up you can use
7892 * elm_theme_overlay_add() to add such a file.
7894 * @section Gengrid_Smart_Events Gengrid smart events
7896 * Smart events that you can add callbacks for are:
7897 * - @c "activated" - The user has double-clicked or pressed
7898 * (enter|return|spacebar) on an item. The @c event_info parameter
7899 * is the gengrid item that was activated.
7900 * - @c "clicked,double" - The user has double-clicked an item.
7901 * The @c event_info parameter is the gengrid item that was double-clicked.
7902 * - @c "longpressed" - This is called when the item is pressed for a certain
7903 * amount of time. By default it's 1 second.
7904 * - @c "selected" - The user has made an item selected. The
7905 * @c event_info parameter is the gengrid item that was selected.
7906 * - @c "unselected" - The user has made an item unselected. The
7907 * @c event_info parameter is the gengrid item that was unselected.
7908 * - @c "realized" - This is called when the item in the gengrid
7909 * has its implementing Evas object instantiated, de facto. @c
7910 * event_info is the gengrid item that was created. The object
7911 * may be deleted at any time, so it is highly advised to the
7912 * caller @b not to use the object pointer returned from
7913 * elm_gengrid_item_object_get(), because it may point to freed
7915 * - @c "unrealized" - This is called when the implementing Evas
7916 * object for this item is deleted. @c event_info is the gengrid
7917 * item that was deleted.
7918 * - @c "changed" - Called when an item is added, removed, resized
7919 * or moved and when the gengrid is resized or gets "horizontal"
7921 * - @c "scroll,anim,start" - This is called when scrolling animation has
7923 * - @c "scroll,anim,stop" - This is called when scrolling animation has
7925 * - @c "drag,start,up" - Called when the item in the gengrid has
7926 * been dragged (not scrolled) up.
7927 * - @c "drag,start,down" - Called when the item in the gengrid has
7928 * been dragged (not scrolled) down.
7929 * - @c "drag,start,left" - Called when the item in the gengrid has
7930 * been dragged (not scrolled) left.
7931 * - @c "drag,start,right" - Called when the item in the gengrid has
7932 * been dragged (not scrolled) right.
7933 * - @c "drag,stop" - Called when the item in the gengrid has
7934 * stopped being dragged.
7935 * - @c "drag" - Called when the item in the gengrid is being
7937 * - @c "scroll" - called when the content has been scrolled
7939 * - @c "scroll,drag,start" - called when dragging the content has
7941 * - @c "scroll,drag,stop" - called when dragging the content has
7943 * - @c "scroll,edge,top" - This is called when the gengrid is scrolled until
7945 * - @c "scroll,edge,bottom" - This is called when the gengrid is scrolled
7946 * until the bottom edge.
7947 * - @c "scroll,edge,left" - This is called when the gengrid is scrolled
7948 * until the left edge.
7949 * - @c "scroll,edge,right" - This is called when the gengrid is scrolled
7950 * until the right edge.
7952 * List of gengrid examples:
7953 * @li @ref gengrid_example
7957 * @addtogroup Gengrid
7961 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
7962 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
7963 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
7964 typedef char *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
7965 typedef Evas_Object *(*Elm_Gengrid_Item_Icon_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Icon fetching class function for gengrid item classes. */
7966 typedef Eina_Bool (*Elm_Gengrid_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for gengrid item classes. */
7967 typedef void (*Elm_Gengrid_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
7969 typedef char *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Label_Get_Cb. */
7970 typedef Evas_Object *(*GridItemIconGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Icon_Get_Cb. */
7971 typedef Eina_Bool (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_State_Get_Cb. */
7972 typedef void (*GridItemDelFunc) (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Del_Cb. */
7975 * @struct _Elm_Gengrid_Item_Class
7977 * Gengrid item class definition. See @ref Gengrid_Item_Class for
7980 struct _Elm_Gengrid_Item_Class
7982 const char *item_style;
7983 struct _Elm_Gengrid_Item_Class_Func
7985 Elm_Gengrid_Item_Label_Get_Cb label_get;
7986 Elm_Gengrid_Item_Icon_Get_Cb icon_get;
7987 Elm_Gengrid_Item_State_Get_Cb state_get;
7988 Elm_Gengrid_Item_Del_Cb del;
7990 }; /**< #Elm_Gengrid_Item_Class member definitions */
7993 * Add a new gengrid widget to the given parent Elementary
7994 * (container) object
7996 * @param parent The parent object
7997 * @return a new gengrid widget handle or @c NULL, on errors
7999 * This function inserts a new gengrid widget on the canvas.
8001 * @see elm_gengrid_item_size_set()
8002 * @see elm_gengrid_group_item_size_set()
8003 * @see elm_gengrid_horizontal_set()
8004 * @see elm_gengrid_item_append()
8005 * @see elm_gengrid_item_del()
8006 * @see elm_gengrid_clear()
8010 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8013 * Set the size for the items of a given gengrid widget
8015 * @param obj The gengrid object.
8016 * @param w The items' width.
8017 * @param h The items' height;
8019 * A gengrid, after creation, has still no information on the size
8020 * to give to each of its cells. So, you most probably will end up
8021 * with squares one @ref Fingers "finger" wide, the default
8022 * size. Use this function to force a custom size for you items,
8023 * making them as big as you wish.
8025 * @see elm_gengrid_item_size_get()
8029 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8032 * Get the size set for the items of a given gengrid widget
8034 * @param obj The gengrid object.
8035 * @param w Pointer to a variable where to store the items' width.
8036 * @param h Pointer to a variable where to store the items' height.
8038 * @note Use @c NULL pointers on the size values you're not
8039 * interested in: they'll be ignored by the function.
8041 * @see elm_gengrid_item_size_get() for more details
8045 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8048 * Set the size for the group items of a given gengrid widget
8050 * @param obj The gengrid object.
8051 * @param w The group items' width.
8052 * @param h The group items' height;
8054 * A gengrid, after creation, has still no information on the size
8055 * to give to each of its cells. So, you most probably will end up
8056 * with squares one @ref Fingers "finger" wide, the default
8057 * size. Use this function to force a custom size for you group items,
8058 * making them as big as you wish.
8060 * @see elm_gengrid_group_item_size_get()
8064 EAPI void elm_gengrid_group_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8067 * Get the size set for the group items of a given gengrid widget
8069 * @param obj The gengrid object.
8070 * @param w Pointer to a variable where to store the group items' width.
8071 * @param h Pointer to a variable where to store the group items' height.
8073 * @note Use @c NULL pointers on the size values you're not
8074 * interested in: they'll be ignored by the function.
8076 * @see elm_gengrid_group_item_size_get() for more details
8080 EAPI void elm_gengrid_group_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8083 * Set the items grid's alignment within a given gengrid widget
8085 * @param obj The gengrid object.
8086 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8087 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8089 * This sets the alignment of the whole grid of items of a gengrid
8090 * within its given viewport. By default, those values are both
8091 * 0.5, meaning that the gengrid will have its items grid placed
8092 * exactly in the middle of its viewport.
8094 * @note If given alignment values are out of the cited ranges,
8095 * they'll be changed to the nearest boundary values on the valid
8098 * @see elm_gengrid_align_get()
8102 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8105 * Get the items grid's alignment values within a given gengrid
8108 * @param obj The gengrid object.
8109 * @param align_x Pointer to a variable where to store the
8110 * horizontal alignment.
8111 * @param align_y Pointer to a variable where to store the vertical
8114 * @note Use @c NULL pointers on the alignment values you're not
8115 * interested in: they'll be ignored by the function.
8117 * @see elm_gengrid_align_set() for more details
8121 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8124 * Set whether a given gengrid widget is or not able have items
8127 * @param obj The gengrid object
8128 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8129 * @c EINA_FALSE to turn it off
8131 * If a gengrid is set to allow reordering, a click held for more
8132 * than 0.5 over a given item will highlight it specially,
8133 * signalling the gengrid has entered the reordering state. From
8134 * that time on, the user will be able to, while still holding the
8135 * mouse button down, move the item freely in the gengrid's
8136 * viewport, replacing to said item to the locations it goes to.
8137 * The replacements will be animated and, whenever the user
8138 * releases the mouse button, the item being replaced gets a new
8139 * definitive place in the grid.
8141 * @see elm_gengrid_reorder_mode_get()
8145 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8148 * Get whether a given gengrid widget is or not able have items
8151 * @param obj The gengrid object
8152 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8155 * @see elm_gengrid_reorder_mode_set() for more details
8159 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8162 * Append a new item in a given gengrid widget.
8164 * @param obj The gengrid object.
8165 * @param gic The item class for the item.
8166 * @param data The item data.
8167 * @param func Convenience function called when the item is
8169 * @param func_data Data to be passed to @p func.
8170 * @return A handle to the item added or @c NULL, on errors.
8172 * This adds an item to the beginning of the gengrid.
8174 * @see elm_gengrid_item_prepend()
8175 * @see elm_gengrid_item_insert_before()
8176 * @see elm_gengrid_item_insert_after()
8177 * @see elm_gengrid_item_del()
8181 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);
8184 * Prepend a new item in a given gengrid widget.
8186 * @param obj The gengrid object.
8187 * @param gic The item class for the item.
8188 * @param data The item data.
8189 * @param func Convenience function called when the item is
8191 * @param func_data Data to be passed to @p func.
8192 * @return A handle to the item added or @c NULL, on errors.
8194 * This adds an item to the end of the gengrid.
8196 * @see elm_gengrid_item_append()
8197 * @see elm_gengrid_item_insert_before()
8198 * @see elm_gengrid_item_insert_after()
8199 * @see elm_gengrid_item_del()
8203 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);
8206 * Insert an item before another in a gengrid widget
8208 * @param obj The gengrid object.
8209 * @param gic The item class for the item.
8210 * @param data The item data.
8211 * @param relative The item to place this new one before.
8212 * @param func Convenience function called when the item is
8214 * @param func_data Data to be passed to @p func.
8215 * @return A handle to the item added or @c NULL, on errors.
8217 * This inserts an item before another in the gengrid.
8219 * @see elm_gengrid_item_append()
8220 * @see elm_gengrid_item_prepend()
8221 * @see elm_gengrid_item_insert_after()
8222 * @see elm_gengrid_item_del()
8226 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);
8229 * Insert an item after another in a gengrid widget
8231 * @param obj The gengrid object.
8232 * @param gic The item class for the item.
8233 * @param data The item data.
8234 * @param relative The item to place this new one after.
8235 * @param func Convenience function called when the item is
8237 * @param func_data Data to be passed to @p func.
8238 * @return A handle to the item added or @c NULL, on errors.
8240 * This inserts an item after another in the gengrid.
8242 * @see elm_gengrid_item_append()
8243 * @see elm_gengrid_item_prepend()
8244 * @see elm_gengrid_item_insert_after()
8245 * @see elm_gengrid_item_del()
8249 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);
8251 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);
8253 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);
8256 * Set whether items on a given gengrid widget are to get their
8257 * selection callbacks issued for @b every subsequent selection
8258 * click on them or just for the first click.
8260 * @param obj The gengrid object
8261 * @param always_select @c EINA_TRUE to make items "always
8262 * selected", @c EINA_FALSE, otherwise
8264 * By default, grid items will only call their selection callback
8265 * function when firstly getting selected, any subsequent further
8266 * clicks will do nothing. With this call, you make those
8267 * subsequent clicks also to issue the selection callbacks.
8269 * @note <b>Double clicks</b> will @b always be reported on items.
8271 * @see elm_gengrid_always_select_mode_get()
8275 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8278 * Get whether items on a given gengrid widget have their selection
8279 * callbacks issued for @b every subsequent selection click on them
8280 * or just for the first click.
8282 * @param obj The gengrid object.
8283 * @return @c EINA_TRUE if the gengrid items are "always selected",
8284 * @c EINA_FALSE, otherwise
8286 * @see elm_gengrid_always_select_mode_set() for more details
8290 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8293 * Set whether items on a given gengrid widget can be selected or not.
8295 * @param obj The gengrid object
8296 * @param no_select @c EINA_TRUE to make items selectable,
8297 * @c EINA_FALSE otherwise
8299 * This will make items in @p obj selectable or not. In the latter
8300 * case, any user interaction on the gengrid items will neither make
8301 * them appear selected nor them call their selection callback
8304 * @see elm_gengrid_no_select_mode_get()
8308 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8311 * Get whether items on a given gengrid widget can be selected or
8314 * @param obj The gengrid object
8315 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8318 * @see elm_gengrid_no_select_mode_set() for more details
8322 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8325 * Enable or disable multi-selection in a given gengrid widget
8327 * @param obj The gengrid object.
8328 * @param multi @c EINA_TRUE, to enable multi-selection,
8329 * @c EINA_FALSE to disable it.
8331 * Multi-selection is the ability for one to have @b more than one
8332 * item selected, on a given gengrid, simultaneously. When it is
8333 * enabled, a sequence of clicks on different items will make them
8334 * all selected, progressively. A click on an already selected item
8335 * will unselect it. If interecting via the keyboard,
8336 * multi-selection is enabled while holding the "Shift" key.
8338 * @note By default, multi-selection is @b disabled on gengrids
8340 * @see elm_gengrid_multi_select_get()
8344 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8347 * Get whether multi-selection is enabled or disabled for a given
8350 * @param obj The gengrid object.
8351 * @return @c EINA_TRUE, if multi-selection is enabled, @c
8352 * EINA_FALSE otherwise
8354 * @see elm_gengrid_multi_select_set() for more details
8358 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8361 * Enable or disable bouncing effect for a given gengrid widget
8363 * @param obj The gengrid object
8364 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8365 * @c EINA_FALSE to disable it
8366 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8367 * @c EINA_FALSE to disable it
8369 * The bouncing effect occurs whenever one reaches the gengrid's
8370 * edge's while panning it -- it will scroll past its limits a
8371 * little bit and return to the edge again, in a animated for,
8374 * @note By default, gengrids have bouncing enabled on both axis
8376 * @see elm_gengrid_bounce_get()
8380 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8383 * Get whether bouncing effects are enabled or disabled, for a
8384 * given gengrid widget, on each axis
8386 * @param obj The gengrid object
8387 * @param h_bounce Pointer to a variable where to store the
8388 * horizontal bouncing flag.
8389 * @param v_bounce Pointer to a variable where to store the
8390 * vertical bouncing flag.
8392 * @see elm_gengrid_bounce_set() for more details
8396 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8399 * Set a given gengrid widget's scrolling page size, relative to
8400 * its viewport size.
8402 * @param obj The gengrid object
8403 * @param h_pagerel The horizontal page (relative) size
8404 * @param v_pagerel The vertical page (relative) size
8406 * The gengrid's scroller is capable of binding scrolling by the
8407 * user to "pages". It means that, while scrolling and, specially
8408 * after releasing the mouse button, the grid will @b snap to the
8409 * nearest displaying page's area. When page sizes are set, the
8410 * grid's continuous content area is split into (equal) page sized
8413 * This function sets the size of a page <b>relatively to the
8414 * viewport dimensions</b> of the gengrid, for each axis. A value
8415 * @c 1.0 means "the exact viewport's size", in that axis, while @c
8416 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8417 * a viewport". Sane usable values are, than, between @c 0.0 and @c
8418 * 1.0. Values beyond those will make it behave behave
8419 * inconsistently. If you only want one axis to snap to pages, use
8420 * the value @c 0.0 for the other one.
8422 * There is a function setting page size values in @b absolute
8423 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8424 * is mutually exclusive to this one.
8426 * @see elm_gengrid_page_relative_get()
8430 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8433 * Get a given gengrid widget's scrolling page size, relative to
8434 * its viewport size.
8436 * @param obj The gengrid object
8437 * @param h_pagerel Pointer to a variable where to store the
8438 * horizontal page (relative) size
8439 * @param v_pagerel Pointer to a variable where to store the
8440 * vertical page (relative) size
8442 * @see elm_gengrid_page_relative_set() for more details
8446 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8449 * Set a given gengrid widget's scrolling page size
8451 * @param obj The gengrid object
8452 * @param h_pagerel The horizontal page size, in pixels
8453 * @param v_pagerel The vertical page size, in pixels
8455 * The gengrid's scroller is capable of binding scrolling by the
8456 * user to "pages". It means that, while scrolling and, specially
8457 * after releasing the mouse button, the grid will @b snap to the
8458 * nearest displaying page's area. When page sizes are set, the
8459 * grid's continuous content area is split into (equal) page sized
8462 * This function sets the size of a page of the gengrid, in pixels,
8463 * for each axis. Sane usable values are, between @c 0 and the
8464 * dimensions of @p obj, for each axis. Values beyond those will
8465 * make it behave behave inconsistently. If you only want one axis
8466 * to snap to pages, use the value @c 0 for the other one.
8468 * There is a function setting page size values in @b relative
8469 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8470 * use is mutually exclusive to this one.
8474 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8477 * @brief Get gengrid current page number.
8479 * @param obj The gengrid object
8480 * @param h_pagenumber The horizontal page number
8481 * @param v_pagenumber The vertical page number
8483 * The page number starts from 0. 0 is the first page.
8484 * Current page means the page which meet the top-left of the viewport.
8485 * If there are two or more pages in the viewport, it returns the number of page
8486 * which meet the top-left of the viewport.
8488 * @see elm_gengrid_last_page_get()
8489 * @see elm_gengrid_page_show()
8490 * @see elm_gengrid_page_brint_in()
8492 EAPI void elm_gengrid_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8495 * @brief Get scroll last page number.
8497 * @param obj The gengrid object
8498 * @param h_pagenumber The horizontal page number
8499 * @param v_pagenumber The vertical page number
8501 * The page number starts from 0. 0 is the first page.
8502 * This returns the last page number among the pages.
8504 * @see elm_gengrid_current_page_get()
8505 * @see elm_gengrid_page_show()
8506 * @see elm_gengrid_page_brint_in()
8508 EAPI void elm_gengrid_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8511 * Show a specific virtual region within the gengrid content object by page number.
8513 * @param obj The gengrid object
8514 * @param h_pagenumber The horizontal page number
8515 * @param v_pagenumber The vertical page number
8517 * 0, 0 of the indicated page is located at the top-left of the viewport.
8518 * This will jump to the page directly without animation.
8523 * sc = elm_gengrid_add(win);
8524 * elm_gengrid_content_set(sc, content);
8525 * elm_gengrid_page_relative_set(sc, 1, 0);
8526 * elm_gengrid_current_page_get(sc, &h_page, &v_page);
8527 * elm_gengrid_page_show(sc, h_page + 1, v_page);
8530 * @see elm_gengrid_page_bring_in()
8532 EAPI void elm_gengrid_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8535 * Show a specific virtual region within the gengrid content object by page number.
8537 * @param obj The gengrid object
8538 * @param h_pagenumber The horizontal page number
8539 * @param v_pagenumber The vertical page number
8541 * 0, 0 of the indicated page is located at the top-left of the viewport.
8542 * This will slide to the page with animation.
8547 * sc = elm_gengrid_add(win);
8548 * elm_gengrid_content_set(sc, content);
8549 * elm_gengrid_page_relative_set(sc, 1, 0);
8550 * elm_gengrid_last_page_get(sc, &h_page, &v_page);
8551 * elm_gengrid_page_bring_in(sc, h_page, v_page);
8554 * @see elm_gengrid_page_show()
8556 EAPI void elm_gengrid_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8559 * Set for what direction a given gengrid widget will expand while
8560 * placing its items.
8562 * @param obj The gengrid object.
8563 * @param setting @c EINA_TRUE to make the gengrid expand
8564 * horizontally, @c EINA_FALSE to expand vertically.
8566 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8567 * in @b columns, from top to bottom and, when the space for a
8568 * column is filled, another one is started on the right, thus
8569 * expanding the grid horizontally. When in "vertical mode"
8570 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8571 * to right and, when the space for a row is filled, another one is
8572 * started below, thus expanding the grid vertically.
8574 * @see elm_gengrid_horizontal_get()
8578 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8581 * Get for what direction a given gengrid widget will expand while
8582 * placing its items.
8584 * @param obj The gengrid object.
8585 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8586 * @c EINA_FALSE if it's set to expand vertically.
8588 * @see elm_gengrid_horizontal_set() for more detais
8592 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8595 * Get the first item in a given gengrid widget
8597 * @param obj The gengrid object
8598 * @return The first item's handle or @c NULL, if there are no
8599 * items in @p obj (and on errors)
8601 * This returns the first item in the @p obj's internal list of
8604 * @see elm_gengrid_last_item_get()
8608 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8611 * Get the last item in a given gengrid widget
8613 * @param obj The gengrid object
8614 * @return The last item's handle or @c NULL, if there are no
8615 * items in @p obj (and on errors)
8617 * This returns the last item in the @p obj's internal list of
8620 * @see elm_gengrid_first_item_get()
8624 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8627 * Get the @b next item in a gengrid widget's internal list of items,
8628 * given a handle to one of those items.
8630 * @param item The gengrid item to fetch next from
8631 * @return The item after @p item, or @c NULL if there's none (and
8634 * This returns the item placed after the @p item, on the container
8637 * @see elm_gengrid_item_prev_get()
8641 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8644 * Get the @b previous item in a gengrid widget's internal list of items,
8645 * given a handle to one of those items.
8647 * @param item The gengrid item to fetch previous from
8648 * @return The item before @p item, or @c NULL if there's none (and
8651 * This returns the item placed before the @p item, on the container
8654 * @see elm_gengrid_item_next_get()
8658 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8661 * Get the gengrid object's handle which contains a given gengrid
8664 * @param item The item to fetch the container from
8665 * @return The gengrid (parent) object
8667 * This returns the gengrid object itself that an item belongs to.
8671 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8674 * Remove a gengrid item from the its parent, deleting it.
8676 * @param item The item to be removed.
8677 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8679 * @see elm_gengrid_clear(), to remove all items in a gengrid at
8684 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8687 * Update the contents of a given gengrid item
8689 * @param item The gengrid item
8691 * This updates an item by calling all the item class functions
8692 * again to get the icons, labels and states. Use this when the
8693 * original item data has changed and you want thta changes to be
8698 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8699 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8700 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
8703 * Return the data associated to a given gengrid item
8705 * @param item The gengrid item.
8706 * @return the data associated to this item.
8708 * This returns the @c data value passed on the
8709 * elm_gengrid_item_append() and related item addition calls.
8711 * @see elm_gengrid_item_append()
8712 * @see elm_gengrid_item_data_set()
8716 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8719 * Set the data associated to a given gengrid item
8721 * @param item The gengrid item
8722 * @param data The new data pointer to set on it
8724 * This @b overrides the @c data value passed on the
8725 * elm_gengrid_item_append() and related item addition calls. This
8726 * function @b won't call elm_gengrid_item_update() automatically,
8727 * so you'd issue it afterwards if you want to hove the item
8728 * updated to reflect the that new data.
8730 * @see elm_gengrid_item_data_get()
8734 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
8737 * Get a given gengrid item's position, relative to the whole
8738 * gengrid's grid area.
8740 * @param item The Gengrid item.
8741 * @param x Pointer to variable where to store the item's <b>row
8743 * @param y Pointer to variable where to store the item's <b>column
8746 * This returns the "logical" position of the item whithin the
8747 * gengrid. For example, @c (0, 1) would stand for first row,
8752 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
8755 * Set whether a given gengrid item is selected or not
8757 * @param item The gengrid item
8758 * @param selected Use @c EINA_TRUE, to make it selected, @c
8759 * EINA_FALSE to make it unselected
8761 * This sets the selected state of an item. If multi selection is
8762 * not enabled on the containing gengrid and @p selected is @c
8763 * EINA_TRUE, any other previously selected items will get
8764 * unselected in favor of this new one.
8766 * @see elm_gengrid_item_selected_get()
8770 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
8773 * Get whether a given gengrid item is selected or not
8775 * @param item The gengrid item
8776 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
8778 * @see elm_gengrid_item_selected_set() for more details
8782 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8785 * Get the real Evas object created to implement the view of a
8786 * given gengrid item
8788 * @param item The gengrid item.
8789 * @return the Evas object implementing this item's view.
8791 * This returns the actual Evas object used to implement the
8792 * specified gengrid item's view. This may be @c NULL, as it may
8793 * not have been created or may have been deleted, at any time, by
8794 * the gengrid. <b>Do not modify this object</b> (move, resize,
8795 * show, hide, etc.), as the gengrid is controlling it. This
8796 * function is for querying, emitting custom signals or hooking
8797 * lower level callbacks for events on that object. Do not delete
8798 * this object under any circumstances.
8800 * @see elm_gengrid_item_data_get()
8804 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8807 * Show the portion of a gengrid's internal grid containing a given
8808 * item, @b immediately.
8810 * @param item The item to display
8812 * This causes gengrid to @b redraw its viewport's contents to the
8813 * region contining the given @p item item, if it is not fully
8816 * @see elm_gengrid_item_bring_in()
8820 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8823 * Animatedly bring in, to the visible are of a gengrid, a given
8826 * @param item The gengrid item to display
8828 * This causes gengrig to jump to the given @p item item and show
8829 * it (by scrolling), if it is not fully visible. This will use
8830 * animation to do so and take a period of time to complete.
8832 * @see elm_gengrid_item_show()
8836 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8839 * Set whether a given gengrid item is disabled or not.
8841 * @param item The gengrid item
8842 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
8843 * to enable it back.
8845 * A disabled item cannot be selected or unselected. It will also
8846 * change its appearance, to signal the user it's disabled.
8848 * @see elm_gengrid_item_disabled_get()
8852 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
8855 * Get whether a given gengrid item is disabled or not.
8857 * @param item The gengrid item
8858 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
8861 * @see elm_gengrid_item_disabled_set() for more details
8865 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8868 * Set the text to be shown in a given gengrid item's tooltips.
8870 * @param item The gengrid item
8871 * @param text The text to set in the content
8873 * This call will setup the text to be used as tooltip to that item
8874 * (analogous to elm_object_tooltip_text_set(), but being item
8875 * tooltips with higher precedence than object tooltips). It can
8876 * have only one tooltip at a time, so any previous tooltip data
8881 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
8884 * Set the content to be shown in a given gengrid item's tooltips
8886 * @param item The gengrid item.
8887 * @param func The function returning the tooltip contents.
8888 * @param data What to provide to @a func as callback data/context.
8889 * @param del_cb Called when data is not needed anymore, either when
8890 * another callback replaces @p func, the tooltip is unset with
8891 * elm_gengrid_item_tooltip_unset() or the owner @p item
8892 * dies. This callback receives as its first parameter the
8893 * given @p data, being @c event_info the item handle.
8895 * This call will setup the tooltip's contents to @p item
8896 * (analogous to elm_object_tooltip_content_cb_set(), but being
8897 * item tooltips with higher precedence than object tooltips). It
8898 * can have only one tooltip at a time, so any previous tooltip
8899 * content will get removed. @p func (with @p data) will be called
8900 * every time Elementary needs to show the tooltip and it should
8901 * return a valid Evas object, which will be fully managed by the
8902 * tooltip system, getting deleted when the tooltip is gone.
8906 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);
8909 * Unset a tooltip from a given gengrid item
8911 * @param item gengrid item to remove a previously set tooltip from.
8913 * This call removes any tooltip set on @p item. The callback
8914 * provided as @c del_cb to
8915 * elm_gengrid_item_tooltip_content_cb_set() will be called to
8916 * notify it is not used anymore (and have resources cleaned, if
8919 * @see elm_gengrid_item_tooltip_content_cb_set()
8923 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8926 * Set a different @b style for a given gengrid item's tooltip.
8928 * @param item gengrid item with tooltip set
8929 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
8930 * "default", @c "transparent", etc)
8932 * Tooltips can have <b>alternate styles</b> to be displayed on,
8933 * which are defined by the theme set on Elementary. This function
8934 * works analogously as elm_object_tooltip_style_set(), but here
8935 * applied only to gengrid item objects. The default style for
8936 * tooltips is @c "default".
8938 * @note before you set a style you should define a tooltip with
8939 * elm_gengrid_item_tooltip_content_cb_set() or
8940 * elm_gengrid_item_tooltip_text_set()
8942 * @see elm_gengrid_item_tooltip_style_get()
8946 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
8949 * Get the style set a given gengrid item's tooltip.
8951 * @param item gengrid item with tooltip already set on.
8952 * @return style the theme style in use, which defaults to
8953 * "default". If the object does not have a tooltip set,
8954 * then @c NULL is returned.
8956 * @see elm_gengrid_item_tooltip_style_set() for more details
8960 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8962 * @brief Disable size restrictions on an object's tooltip
8963 * @param item The tooltip's anchor object
8964 * @param disable If EINA_TRUE, size restrictions are disabled
8965 * @return EINA_FALSE on failure, EINA_TRUE on success
8967 * This function allows a tooltip to expand beyond its parant window's canvas.
8968 * It will instead be limited only by the size of the display.
8970 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
8972 * @brief Retrieve size restriction state of an object's tooltip
8973 * @param item The tooltip's anchor object
8974 * @return If EINA_TRUE, size restrictions are disabled
8976 * This function returns whether a tooltip is allowed to expand beyond
8977 * its parant window's canvas.
8978 * It will instead be limited only by the size of the display.
8980 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
8982 * Set the type of mouse pointer/cursor decoration to be shown,
8983 * when the mouse pointer is over the given gengrid widget item
8985 * @param item gengrid item to customize cursor on
8986 * @param cursor the cursor type's name
8988 * This function works analogously as elm_object_cursor_set(), but
8989 * here the cursor's changing area is restricted to the item's
8990 * area, and not the whole widget's. Note that that item cursors
8991 * have precedence over widget cursors, so that a mouse over @p
8992 * item will always show cursor @p type.
8994 * If this function is called twice for an object, a previously set
8995 * cursor will be unset on the second call.
8997 * @see elm_object_cursor_set()
8998 * @see elm_gengrid_item_cursor_get()
8999 * @see elm_gengrid_item_cursor_unset()
9003 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
9006 * Get the type of mouse pointer/cursor decoration set to be shown,
9007 * when the mouse pointer is over the given gengrid widget item
9009 * @param item gengrid item with custom cursor set
9010 * @return the cursor type's name or @c NULL, if no custom cursors
9011 * were set to @p item (and on errors)
9013 * @see elm_object_cursor_get()
9014 * @see elm_gengrid_item_cursor_set() for more details
9015 * @see elm_gengrid_item_cursor_unset()
9019 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9022 * Unset any custom mouse pointer/cursor decoration set to be
9023 * shown, when the mouse pointer is over the given gengrid widget
9024 * item, thus making it show the @b default cursor again.
9026 * @param item a gengrid item
9028 * Use this call to undo any custom settings on this item's cursor
9029 * decoration, bringing it back to defaults (no custom style set).
9031 * @see elm_object_cursor_unset()
9032 * @see elm_gengrid_item_cursor_set() for more details
9036 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9039 * Set a different @b style for a given custom cursor set for a
9042 * @param item gengrid item with custom cursor set
9043 * @param style the <b>theme style</b> to use (e.g. @c "default",
9044 * @c "transparent", etc)
9046 * This function only makes sense when one is using custom mouse
9047 * cursor decorations <b>defined in a theme file</b> , which can
9048 * have, given a cursor name/type, <b>alternate styles</b> on
9049 * it. It works analogously as elm_object_cursor_style_set(), but
9050 * here applied only to gengrid item objects.
9052 * @warning Before you set a cursor style you should have defined a
9053 * custom cursor previously on the item, with
9054 * elm_gengrid_item_cursor_set()
9056 * @see elm_gengrid_item_cursor_engine_only_set()
9057 * @see elm_gengrid_item_cursor_style_get()
9061 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9064 * Get the current @b style set for a given gengrid item's custom
9067 * @param item gengrid item with custom cursor set.
9068 * @return style the cursor style in use. If the object does not
9069 * have a cursor set, then @c NULL is returned.
9071 * @see elm_gengrid_item_cursor_style_set() for more details
9075 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9078 * Set if the (custom) cursor for a given gengrid item should be
9079 * searched in its theme, also, or should only rely on the
9082 * @param item item with custom (custom) cursor already set on
9083 * @param engine_only Use @c EINA_TRUE to have cursors looked for
9084 * only on those provided by the rendering engine, @c EINA_FALSE to
9085 * have them searched on the widget's theme, as well.
9087 * @note This call is of use only if you've set a custom cursor
9088 * for gengrid items, with elm_gengrid_item_cursor_set().
9090 * @note By default, cursors will only be looked for between those
9091 * provided by the rendering engine.
9095 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9098 * Get if the (custom) cursor for a given gengrid item is being
9099 * searched in its theme, also, or is only relying on the rendering
9102 * @param item a gengrid item
9103 * @return @c EINA_TRUE, if cursors are being looked for only on
9104 * those provided by the rendering engine, @c EINA_FALSE if they
9105 * are being searched on the widget's theme, as well.
9107 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
9111 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9114 * Remove all items from a given gengrid widget
9116 * @param obj The gengrid object.
9118 * This removes (and deletes) all items in @p obj, leaving it
9121 * @see elm_gengrid_item_del(), to remove just one item.
9125 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9128 * Get the selected item in a given gengrid widget
9130 * @param obj The gengrid object.
9131 * @return The selected item's handleor @c NULL, if none is
9132 * selected at the moment (and on errors)
9134 * This returns the selected item in @p obj. If multi selection is
9135 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
9136 * the first item in the list is selected, which might not be very
9137 * useful. For that case, see elm_gengrid_selected_items_get().
9141 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9144 * Get <b>a list</b> of selected items in a given gengrid
9146 * @param obj The gengrid object.
9147 * @return The list of selected items or @c NULL, if none is
9148 * selected at the moment (and on errors)
9150 * This returns a list of the selected items, in the order that
9151 * they appear in the grid. This list is only valid as long as no
9152 * more items are selected or unselected (or unselected implictly
9153 * by deletion). The list contains #Elm_Gengrid_Item pointers as
9156 * @see elm_gengrid_selected_item_get()
9160 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9167 * @defgroup Clock Clock
9169 * @image html img/widget/clock/preview-00.png
9170 * @image latex img/widget/clock/preview-00.eps
9172 * This is a @b digital clock widget. In its default theme, it has a
9173 * vintage "flipping numbers clock" appearance, which will animate
9174 * sheets of individual algarisms individually as time goes by.
9176 * A newly created clock will fetch system's time (already
9177 * considering local time adjustments) to start with, and will tick
9178 * accondingly. It may or may not show seconds.
9180 * Clocks have an @b edition mode. When in it, the sheets will
9181 * display extra arrow indications on the top and bottom and the
9182 * user may click on them to raise or lower the time values. After
9183 * it's told to exit edition mode, it will keep ticking with that
9184 * new time set (it keeps the difference from local time).
9186 * Also, when under edition mode, user clicks on the cited arrows
9187 * which are @b held for some time will make the clock to flip the
9188 * sheet, thus editing the time, continuosly and automatically for
9189 * the user. The interval between sheet flips will keep growing in
9190 * time, so that it helps the user to reach a time which is distant
9193 * The time display is, by default, in military mode (24h), but an
9194 * am/pm indicator may be optionally shown, too, when it will
9197 * Smart callbacks one can register to:
9198 * - "changed" - the clock's user changed the time
9200 * Here is an example on its usage:
9201 * @li @ref clock_example
9210 * Identifiers for which clock digits should be editable, when a
9211 * clock widget is in edition mode. Values may be ORed together to
9212 * make a mask, naturally.
9214 * @see elm_clock_edit_set()
9215 * @see elm_clock_digit_edit_set()
9217 typedef enum _Elm_Clock_Digedit
9219 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9220 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9221 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
9222 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9223 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
9224 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9225 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
9226 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
9227 } Elm_Clock_Digedit;
9230 * Add a new clock widget to the given parent Elementary
9231 * (container) object
9233 * @param parent The parent object
9234 * @return a new clock widget handle or @c NULL, on errors
9236 * This function inserts a new clock widget on the canvas.
9240 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9243 * Set a clock widget's time, programmatically
9245 * @param obj The clock widget object
9246 * @param hrs The hours to set
9247 * @param min The minutes to set
9248 * @param sec The secondes to set
9250 * This function updates the time that is showed by the clock
9253 * Values @b must be set within the following ranges:
9254 * - 0 - 23, for hours
9255 * - 0 - 59, for minutes
9256 * - 0 - 59, for seconds,
9258 * even if the clock is not in "military" mode.
9260 * @warning The behavior for values set out of those ranges is @b
9265 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9268 * Get a clock widget's time values
9270 * @param obj The clock object
9271 * @param[out] hrs Pointer to the variable to get the hours value
9272 * @param[out] min Pointer to the variable to get the minutes value
9273 * @param[out] sec Pointer to the variable to get the seconds value
9275 * This function gets the time set for @p obj, returning
9276 * it on the variables passed as the arguments to function
9278 * @note Use @c NULL pointers on the time values you're not
9279 * interested in: they'll be ignored by the function.
9283 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9286 * Set whether a given clock widget is under <b>edition mode</b> or
9287 * under (default) displaying-only mode.
9289 * @param obj The clock object
9290 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9291 * put it back to "displaying only" mode
9293 * This function makes a clock's time to be editable or not <b>by
9294 * user interaction</b>. When in edition mode, clocks @b stop
9295 * ticking, until one brings them back to canonical mode. The
9296 * elm_clock_digit_edit_set() function will influence which digits
9297 * of the clock will be editable. By default, all of them will be
9298 * (#ELM_CLOCK_NONE).
9300 * @note am/pm sheets, if being shown, will @b always be editable
9301 * under edition mode.
9303 * @see elm_clock_edit_get()
9307 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9310 * Retrieve whether a given clock widget is under <b>edition
9311 * mode</b> or under (default) displaying-only mode.
9313 * @param obj The clock object
9314 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9317 * This function retrieves whether the clock's time can be edited
9318 * or not by user interaction.
9320 * @see elm_clock_edit_set() for more details
9324 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9327 * Set what digits of the given clock widget should be editable
9328 * when in edition mode.
9330 * @param obj The clock object
9331 * @param digedit Bit mask indicating the digits to be editable
9332 * (values in #Elm_Clock_Digedit).
9334 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9335 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9338 * @see elm_clock_digit_edit_get()
9342 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9345 * Retrieve what digits of the given clock widget should be
9346 * editable when in edition mode.
9348 * @param obj The clock object
9349 * @return Bit mask indicating the digits to be editable
9350 * (values in #Elm_Clock_Digedit).
9352 * @see elm_clock_digit_edit_set() for more details
9356 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9359 * Set if the given clock widget must show hours in military or
9362 * @param obj The clock object
9363 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9366 * This function sets if the clock must show hours in military or
9367 * am/pm mode. In some countries like Brazil the military mode
9368 * (00-24h-format) is used, in opposition to the USA, where the
9369 * am/pm mode is more commonly used.
9371 * @see elm_clock_show_am_pm_get()
9375 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9378 * Get if the given clock widget shows hours in military or am/pm
9381 * @param obj The clock object
9382 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9385 * This function gets if the clock shows hours in military or am/pm
9388 * @see elm_clock_show_am_pm_set() for more details
9392 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9395 * Set if the given clock widget must show time with seconds or not
9397 * @param obj The clock object
9398 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9400 * This function sets if the given clock must show or not elapsed
9401 * seconds. By default, they are @b not shown.
9403 * @see elm_clock_show_seconds_get()
9407 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9410 * Get whether the given clock widget is showing time with seconds
9413 * @param obj The clock object
9414 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9416 * This function gets whether @p obj is showing or not the elapsed
9419 * @see elm_clock_show_seconds_set()
9423 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9426 * Set the interval on time updates for an user mouse button hold
9427 * on clock widgets' time edition.
9429 * @param obj The clock object
9430 * @param interval The (first) interval value in seconds
9432 * This interval value is @b decreased while the user holds the
9433 * mouse pointer either incrementing or decrementing a given the
9434 * clock digit's value.
9436 * This helps the user to get to a given time distant from the
9437 * current one easier/faster, as it will start to flip quicker and
9438 * quicker on mouse button holds.
9440 * The calculation for the next flip interval value, starting from
9441 * the one set with this call, is the previous interval divided by
9442 * 1.05, so it decreases a little bit.
9444 * The default starting interval value for automatic flips is
9447 * @see elm_clock_interval_get()
9451 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9454 * Get the interval on time updates for an user mouse button hold
9455 * on clock widgets' time edition.
9457 * @param obj The clock object
9458 * @return The (first) interval value, in seconds, set on it
9460 * @see elm_clock_interval_set() for more details
9464 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9471 * @defgroup Layout Layout
9473 * @image html img/widget/layout/preview-00.png
9474 * @image latex img/widget/layout/preview-00.eps width=\textwidth
9476 * @image html img/layout-predefined.png
9477 * @image latex img/layout-predefined.eps width=\textwidth
9479 * This is a container widget that takes a standard Edje design file and
9480 * wraps it very thinly in a widget.
9482 * An Edje design (theme) file has a very wide range of possibilities to
9483 * describe the behavior of elements added to the Layout. Check out the Edje
9484 * documentation and the EDC reference to get more information about what can
9485 * be done with Edje.
9487 * Just like @ref List, @ref Box, and other container widgets, any
9488 * object added to the Layout will become its child, meaning that it will be
9489 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9491 * The Layout widget can contain as many Contents, Boxes or Tables as
9492 * described in its theme file. For instance, objects can be added to
9493 * different Tables by specifying the respective Table part names. The same
9494 * is valid for Content and Box.
9496 * The objects added as child of the Layout will behave as described in the
9497 * part description where they were added. There are 3 possible types of
9498 * parts where a child can be added:
9500 * @section secContent Content (SWALLOW part)
9502 * Only one object can be added to the @c SWALLOW part (but you still can
9503 * have many @c SWALLOW parts and one object on each of them). Use the @c
9504 * elm_layout_content_* set of functions to set, retrieve and unset objects
9505 * as content of the @c SWALLOW. After being set to this part, the object
9506 * size, position, visibility, clipping and other description properties
9507 * will be totally controled by the description of the given part (inside
9508 * the Edje theme file).
9510 * One can use @c evas_object_size_hint_* functions on the child to have some
9511 * kind of control over its behavior, but the resulting behavior will still
9512 * depend heavily on the @c SWALLOW part description.
9514 * The Edje theme also can change the part description, based on signals or
9515 * scripts running inside the theme. This change can also be animated. All of
9516 * this will affect the child object set as content accordingly. The object
9517 * size will be changed if the part size is changed, it will animate move if
9518 * the part is moving, and so on.
9520 * The following picture demonstrates a Layout widget with a child object
9521 * added to its @c SWALLOW:
9523 * @image html layout_swallow.png
9524 * @image latex layout_swallow.eps width=\textwidth
9526 * @section secBox Box (BOX part)
9528 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9529 * allows one to add objects to the box and have them distributed along its
9530 * area, accordingly to the specified @a layout property (now by @a layout we
9531 * mean the chosen layouting design of the Box, not the Layout widget
9534 * A similar effect for having a box with its position, size and other things
9535 * controled by the Layout theme would be to create an Elementary @ref Box
9536 * widget and add it as a Content in the @c SWALLOW part.
9538 * The main difference of using the Layout Box is that its behavior, the box
9539 * properties like layouting format, padding, align, etc. will be all
9540 * controled by the theme. This means, for example, that a signal could be
9541 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9542 * handled the signal by changing the box padding, or align, or both. Using
9543 * the Elementary @ref Box widget is not necessarily harder or easier, it
9544 * just depends on the circunstances and requirements.
9546 * The Layout Box can be used through the @c elm_layout_box_* set of
9549 * The following picture demonstrates a Layout widget with many child objects
9550 * added to its @c BOX part:
9552 * @image html layout_box.png
9553 * @image latex layout_box.eps width=\textwidth
9555 * @section secTable Table (TABLE part)
9557 * Just like the @ref secBox, the Layout Table is very similar to the
9558 * Elementary @ref Table widget. It allows one to add objects to the Table
9559 * specifying the row and column where the object should be added, and any
9560 * column or row span if necessary.
9562 * Again, we could have this design by adding a @ref Table widget to the @c
9563 * SWALLOW part using elm_layout_content_set(). The same difference happens
9564 * here when choosing to use the Layout Table (a @c TABLE part) instead of
9565 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9567 * The Layout Table can be used through the @c elm_layout_table_* set of
9570 * The following picture demonstrates a Layout widget with many child objects
9571 * added to its @c TABLE part:
9573 * @image html layout_table.png
9574 * @image latex layout_table.eps width=\textwidth
9576 * @section secPredef Predefined Layouts
9578 * Another interesting thing about the Layout widget is that it offers some
9579 * predefined themes that come with the default Elementary theme. These
9580 * themes can be set by the call elm_layout_theme_set(), and provide some
9581 * basic functionality depending on the theme used.
9583 * Most of them already send some signals, some already provide a toolbar or
9584 * back and next buttons.
9586 * These are available predefined theme layouts. All of them have class = @c
9587 * layout, group = @c application, and style = one of the following options:
9589 * @li @c toolbar-content - application with toolbar and main content area
9590 * @li @c toolbar-content-back - application with toolbar and main content
9591 * area with a back button and title area
9592 * @li @c toolbar-content-back-next - application with toolbar and main
9593 * content area with a back and next buttons and title area
9594 * @li @c content-back - application with a main content area with a back
9595 * button and title area
9596 * @li @c content-back-next - application with a main content area with a
9597 * back and next buttons and title area
9598 * @li @c toolbar-vbox - application with toolbar and main content area as a
9600 * @li @c toolbar-table - application with toolbar and main content area as a
9603 * @section secExamples Examples
9605 * Some examples of the Layout widget can be found here:
9606 * @li @ref layout_example_01
9607 * @li @ref layout_example_02
9608 * @li @ref layout_example_03
9609 * @li @ref layout_example_edc
9614 * Add a new layout to the parent
9616 * @param parent The parent object
9617 * @return The new object or NULL if it cannot be created
9619 * @see elm_layout_file_set()
9620 * @see elm_layout_theme_set()
9624 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9626 * Set the file that will be used as layout
9628 * @param obj The layout object
9629 * @param file The path to file (edj) that will be used as layout
9630 * @param group The group that the layout belongs in edje file
9632 * @return (1 = success, 0 = error)
9636 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9638 * Set the edje group from the elementary theme that will be used as layout
9640 * @param obj The layout object
9641 * @param clas the clas of the group
9642 * @param group the group
9643 * @param style the style to used
9645 * @return (1 = success, 0 = error)
9649 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9651 * Set the layout content.
9653 * @param obj The layout object
9654 * @param swallow The swallow part name in the edje file
9655 * @param content The child that will be added in this layout object
9657 * Once the content object is set, a previously set one will be deleted.
9658 * If you want to keep that old content object, use the
9659 * elm_layout_content_unset() function.
9661 * @note In an Edje theme, the part used as a content container is called @c
9662 * SWALLOW. This is why the parameter name is called @p swallow, but it is
9663 * expected to be a part name just like the second parameter of
9664 * elm_layout_box_append().
9666 * @see elm_layout_box_append()
9667 * @see elm_layout_content_get()
9668 * @see elm_layout_content_unset()
9673 EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9675 * Get the child object in the given content part.
9677 * @param obj The layout object
9678 * @param swallow The SWALLOW part to get its content
9680 * @return The swallowed object or NULL if none or an error occurred
9682 * @see elm_layout_content_set()
9686 EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9688 * Unset the layout content.
9690 * @param obj The layout object
9691 * @param swallow The swallow part name in the edje file
9692 * @return The content that was being used
9694 * Unparent and return the content object which was set for this part.
9696 * @see elm_layout_content_set()
9700 EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9702 * Set the text of the given part
9704 * @param obj The layout object
9705 * @param part The TEXT part where to set the text
9706 * @param text The text to set
9709 * @deprecated use elm_object_text_* instead.
9711 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
9713 * Get the text set in the given part
9715 * @param obj The layout object
9716 * @param part The TEXT part to retrieve the text off
9718 * @return The text set in @p part
9721 * @deprecated use elm_object_text_* instead.
9723 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
9725 * Append child to layout box part.
9727 * @param obj the layout object
9728 * @param part the box part to which the object will be appended.
9729 * @param child the child object to append to box.
9731 * Once the object is appended, it will become child of the layout. Its
9732 * lifetime will be bound to the layout, whenever the layout dies the child
9733 * will be deleted automatically. One should use elm_layout_box_remove() to
9734 * make this layout forget about the object.
9736 * @see elm_layout_box_prepend()
9737 * @see elm_layout_box_insert_before()
9738 * @see elm_layout_box_insert_at()
9739 * @see elm_layout_box_remove()
9743 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9745 * Prepend child to layout box part.
9747 * @param obj the layout object
9748 * @param part the box part to prepend.
9749 * @param child the child object to prepend to box.
9751 * Once the object is prepended, it will become child of the layout. Its
9752 * lifetime will be bound to the layout, whenever the layout dies the child
9753 * will be deleted automatically. One should use elm_layout_box_remove() to
9754 * make this layout forget about the object.
9756 * @see elm_layout_box_append()
9757 * @see elm_layout_box_insert_before()
9758 * @see elm_layout_box_insert_at()
9759 * @see elm_layout_box_remove()
9763 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9765 * Insert child to layout box part before a reference object.
9767 * @param obj the layout object
9768 * @param part the box part to insert.
9769 * @param child the child object to insert into box.
9770 * @param reference another reference object to insert before in box.
9772 * Once the object is inserted, it will become child of the layout. Its
9773 * lifetime will be bound to the layout, whenever the layout dies the child
9774 * will be deleted automatically. One should use elm_layout_box_remove() to
9775 * make this layout forget about the object.
9777 * @see elm_layout_box_append()
9778 * @see elm_layout_box_prepend()
9779 * @see elm_layout_box_insert_before()
9780 * @see elm_layout_box_remove()
9784 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
9786 * Insert child to layout box part at a given position.
9788 * @param obj the layout object
9789 * @param part the box part to insert.
9790 * @param child the child object to insert into box.
9791 * @param pos the numeric position >=0 to insert the child.
9793 * Once the object is inserted, it will become child of the layout. Its
9794 * lifetime will be bound to the layout, whenever the layout dies the child
9795 * will be deleted automatically. One should use elm_layout_box_remove() to
9796 * make this layout forget about the object.
9798 * @see elm_layout_box_append()
9799 * @see elm_layout_box_prepend()
9800 * @see elm_layout_box_insert_before()
9801 * @see elm_layout_box_remove()
9805 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
9807 * Remove a child of the given part box.
9809 * @param obj The layout object
9810 * @param part The box part name to remove child.
9811 * @param child The object to remove from box.
9812 * @return The object that was being used, or NULL if not found.
9814 * The object will be removed from the box part and its lifetime will
9815 * not be handled by the layout anymore. This is equivalent to
9816 * elm_layout_content_unset() for box.
9818 * @see elm_layout_box_append()
9819 * @see elm_layout_box_remove_all()
9823 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
9825 * Remove all child of the given part box.
9827 * @param obj The layout object
9828 * @param part The box part name to remove child.
9829 * @param clear If EINA_TRUE, then all objects will be deleted as
9830 * well, otherwise they will just be removed and will be
9831 * dangling on the canvas.
9833 * The objects will be removed from the box part and their lifetime will
9834 * not be handled by the layout anymore. This is equivalent to
9835 * elm_layout_box_remove() for all box children.
9837 * @see elm_layout_box_append()
9838 * @see elm_layout_box_remove()
9842 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9844 * Insert child to layout table part.
9846 * @param obj the layout object
9847 * @param part the box part to pack child.
9848 * @param child_obj the child object to pack into table.
9849 * @param col the column to which the child should be added. (>= 0)
9850 * @param row the row to which the child should be added. (>= 0)
9851 * @param colspan how many columns should be used to store this object. (>=
9853 * @param rowspan how many rows should be used to store this object. (>= 1)
9855 * Once the object is inserted, it will become child of the table. Its
9856 * lifetime will be bound to the layout, and whenever the layout dies the
9857 * child will be deleted automatically. One should use
9858 * elm_layout_table_remove() to make this layout forget about the object.
9860 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
9861 * more space than a single cell. For instance, the following code:
9863 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
9866 * Would result in an object being added like the following picture:
9868 * @image html layout_colspan.png
9869 * @image latex layout_colspan.eps width=\textwidth
9871 * @see elm_layout_table_unpack()
9872 * @see elm_layout_table_clear()
9876 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);
9878 * Unpack (remove) a child of the given part table.
9880 * @param obj The layout object
9881 * @param part The table part name to remove child.
9882 * @param child_obj The object to remove from table.
9883 * @return The object that was being used, or NULL if not found.
9885 * The object will be unpacked from the table part and its lifetime
9886 * will not be handled by the layout anymore. This is equivalent to
9887 * elm_layout_content_unset() for table.
9889 * @see elm_layout_table_pack()
9890 * @see elm_layout_table_clear()
9894 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
9896 * Remove all child of the given part table.
9898 * @param obj The layout object
9899 * @param part The table part name to remove child.
9900 * @param clear If EINA_TRUE, then all objects will be deleted as
9901 * well, otherwise they will just be removed and will be
9902 * dangling on the canvas.
9904 * The objects will be removed from the table part and their lifetime will
9905 * not be handled by the layout anymore. This is equivalent to
9906 * elm_layout_table_unpack() for all table children.
9908 * @see elm_layout_table_pack()
9909 * @see elm_layout_table_unpack()
9913 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9915 * Get the edje layout
9917 * @param obj The layout object
9919 * @return A Evas_Object with the edje layout settings loaded
9920 * with function elm_layout_file_set
9922 * This returns the edje object. It is not expected to be used to then
9923 * swallow objects via edje_object_part_swallow() for example. Use
9924 * elm_layout_content_set() instead so child object handling and sizing is
9927 * @note This function should only be used if you really need to call some
9928 * low level Edje function on this edje object. All the common stuff (setting
9929 * text, emitting signals, hooking callbacks to signals, etc.) can be done
9930 * with proper elementary functions.
9932 * @see elm_object_signal_callback_add()
9933 * @see elm_object_signal_emit()
9934 * @see elm_object_text_part_set()
9935 * @see elm_layout_content_set()
9936 * @see elm_layout_box_append()
9937 * @see elm_layout_table_pack()
9938 * @see elm_layout_data_get()
9942 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9944 * Get the edje data from the given layout
9946 * @param obj The layout object
9947 * @param key The data key
9949 * @return The edje data string
9951 * This function fetches data specified inside the edje theme of this layout.
9952 * This function return NULL if data is not found.
9954 * In EDC this comes from a data block within the group block that @p
9955 * obj was loaded from. E.g.
9962 * item: "key1" "value1";
9963 * item: "key2" "value2";
9971 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
9975 * @param obj The layout object
9977 * Manually forces a sizing re-evaluation. This is useful when the minimum
9978 * size required by the edje theme of this layout has changed. The change on
9979 * the minimum size required by the edje theme is not immediately reported to
9980 * the elementary layout, so one needs to call this function in order to tell
9981 * the widget (layout) that it needs to reevaluate its own size.
9983 * The minimum size of the theme is calculated based on minimum size of
9984 * parts, the size of elements inside containers like box and table, etc. All
9985 * of this can change due to state changes, and that's when this function
9988 * Also note that a standard signal of "size,eval" "elm" emitted from the
9989 * edje object will cause this to happen too.
9993 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
9996 * Sets a specific cursor for an edje part.
9998 * @param obj The layout object.
9999 * @param part_name a part from loaded edje group.
10000 * @param cursor cursor name to use, see Elementary_Cursor.h
10002 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10003 * part not exists or it has "mouse_events: 0".
10007 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
10010 * Get the cursor to be shown when mouse is over an edje part
10012 * @param obj The layout object.
10013 * @param part_name a part from loaded edje group.
10014 * @return the cursor name.
10018 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10021 * Unsets a cursor previously set with elm_layout_part_cursor_set().
10023 * @param obj The layout object.
10024 * @param part_name a part from loaded edje group, that had a cursor set
10025 * with elm_layout_part_cursor_set().
10029 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10032 * Sets a specific cursor style for an edje part.
10034 * @param obj The layout object.
10035 * @param part_name a part from loaded edje group.
10036 * @param style the theme style to use (default, transparent, ...)
10038 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10039 * part not exists or it did not had a cursor set.
10043 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
10046 * Gets a specific cursor style for an edje part.
10048 * @param obj The layout object.
10049 * @param part_name a part from loaded edje group.
10051 * @return the theme style in use, defaults to "default". If the
10052 * object does not have a cursor set, then NULL is returned.
10056 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10059 * Sets if the cursor set should be searched on the theme or should use
10060 * the provided by the engine, only.
10062 * @note before you set if should look on theme you should define a
10063 * cursor with elm_layout_part_cursor_set(). By default it will only
10064 * look for cursors provided by the engine.
10066 * @param obj The layout object.
10067 * @param part_name a part from loaded edje group.
10068 * @param engine_only if cursors should be just provided by the engine
10069 * or should also search on widget's theme as well
10071 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10072 * part not exists or it did not had a cursor set.
10076 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);
10079 * Gets a specific cursor engine_only for an edje part.
10081 * @param obj The layout object.
10082 * @param part_name a part from loaded edje group.
10084 * @return whenever the cursor is just provided by engine or also from theme.
10088 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10091 * @def elm_layout_icon_set
10092 * Convienience macro to set the icon object in a layout that follows the
10093 * Elementary naming convention for its parts.
10097 #define elm_layout_icon_set(_ly, _obj) \
10100 elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
10101 if ((_obj)) sig = "elm,state,icon,visible"; \
10102 else sig = "elm,state,icon,hidden"; \
10103 elm_object_signal_emit((_ly), sig, "elm"); \
10107 * @def elm_layout_icon_get
10108 * Convienience macro to get the icon object from a layout that follows the
10109 * Elementary naming convention for its parts.
10113 #define elm_layout_icon_get(_ly) \
10114 elm_layout_content_get((_ly), "elm.swallow.icon")
10117 * @def elm_layout_end_set
10118 * Convienience macro to set the end object in a layout that follows the
10119 * Elementary naming convention for its parts.
10123 #define elm_layout_end_set(_ly, _obj) \
10126 elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
10127 if ((_obj)) sig = "elm,state,end,visible"; \
10128 else sig = "elm,state,end,hidden"; \
10129 elm_object_signal_emit((_ly), sig, "elm"); \
10133 * @def elm_layout_end_get
10134 * Convienience macro to get the end object in a layout that follows the
10135 * Elementary naming convention for its parts.
10139 #define elm_layout_end_get(_ly) \
10140 elm_layout_content_get((_ly), "elm.swallow.end")
10143 * @def elm_layout_label_set
10144 * Convienience macro to set the label in a layout that follows the
10145 * Elementary naming convention for its parts.
10148 * @deprecated use elm_object_text_* instead.
10150 #define elm_layout_label_set(_ly, _txt) \
10151 elm_layout_text_set((_ly), "elm.text", (_txt))
10154 * @def elm_layout_label_get
10155 * Convienience macro to get the label in a layout that follows the
10156 * Elementary naming convention for its parts.
10159 * @deprecated use elm_object_text_* instead.
10161 #define elm_layout_label_get(_ly) \
10162 elm_layout_text_get((_ly), "elm.text")
10164 /* smart callbacks called:
10165 * "theme,changed" - when elm theme is changed.
10169 * @defgroup Notify Notify
10171 * @image html img/widget/notify/preview-00.png
10172 * @image latex img/widget/notify/preview-00.eps
10174 * Display a container in a particular region of the parent(top, bottom,
10175 * etc. A timeout can be set to automatically hide the notify. This is so
10176 * that, after an evas_object_show() on a notify object, if a timeout was set
10177 * on it, it will @b automatically get hidden after that time.
10179 * Signals that you can add callbacks for are:
10180 * @li "timeout" - when timeout happens on notify and it's hidden
10181 * @li "block,clicked" - when a click outside of the notify happens
10183 * @ref tutorial_notify show usage of the API.
10188 * @brief Possible orient values for notify.
10190 * This values should be used in conjunction to elm_notify_orient_set() to
10191 * set the position in which the notify should appear(relative to its parent)
10192 * and in conjunction with elm_notify_orient_get() to know where the notify
10195 typedef enum _Elm_Notify_Orient
10197 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
10198 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
10199 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
10200 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
10201 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
10202 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
10203 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
10204 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
10205 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10206 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10207 } Elm_Notify_Orient;
10209 * @brief Add a new notify to the parent
10211 * @param parent The parent object
10212 * @return The new object or NULL if it cannot be created
10214 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10216 * @brief Set the content of the notify widget
10218 * @param obj The notify object
10219 * @param content The content will be filled in this notify object
10221 * Once the content object is set, a previously set one will be deleted. If
10222 * you want to keep that old content object, use the
10223 * elm_notify_content_unset() function.
10225 EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10227 * @brief Unset the content of the notify widget
10229 * @param obj The notify object
10230 * @return The content that was being used
10232 * Unparent and return the content object which was set for this widget
10234 * @see elm_notify_content_set()
10236 EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10238 * @brief Return the content of the notify widget
10240 * @param obj The notify object
10241 * @return The content that is being used
10243 * @see elm_notify_content_set()
10245 EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10247 * @brief Set the notify parent
10249 * @param obj The notify object
10250 * @param content The new parent
10252 * Once the parent object is set, a previously set one will be disconnected
10255 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10257 * @brief Get the notify parent
10259 * @param obj The notify object
10260 * @return The parent
10262 * @see elm_notify_parent_set()
10264 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10266 * @brief Set the orientation
10268 * @param obj The notify object
10269 * @param orient The new orientation
10271 * Sets the position in which the notify will appear in its parent.
10273 * @see @ref Elm_Notify_Orient for possible values.
10275 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10277 * @brief Return the orientation
10278 * @param obj The notify object
10279 * @return The orientation of the notification
10281 * @see elm_notify_orient_set()
10282 * @see Elm_Notify_Orient
10284 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10286 * @brief Set the time interval after which the notify window is going to be
10289 * @param obj The notify object
10290 * @param time The timeout in seconds
10292 * This function sets a timeout and starts the timer controlling when the
10293 * notify is hidden. Since calling evas_object_show() on a notify restarts
10294 * the timer controlling when the notify is hidden, setting this before the
10295 * notify is shown will in effect mean starting the timer when the notify is
10298 * @note Set a value <= 0.0 to disable a running timer.
10300 * @note If the value > 0.0 and the notify is previously visible, the
10301 * timer will be started with this value, canceling any running timer.
10303 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10305 * @brief Return the timeout value (in seconds)
10306 * @param obj the notify object
10308 * @see elm_notify_timeout_set()
10310 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10312 * @brief Sets whether events should be passed to by a click outside
10315 * @param obj The notify object
10316 * @param repeats EINA_TRUE Events are repeats, else no
10318 * When true if the user clicks outside the window the events will be caught
10319 * by the others widgets, else the events are blocked.
10321 * @note The default value is EINA_TRUE.
10323 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10325 * @brief Return true if events are repeat below the notify object
10326 * @param obj the notify object
10328 * @see elm_notify_repeat_events_set()
10330 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10336 * @defgroup Hover Hover
10338 * @image html img/widget/hover/preview-00.png
10339 * @image latex img/widget/hover/preview-00.eps
10341 * A Hover object will hover over its @p parent object at the @p target
10342 * location. Anything in the background will be given a darker coloring to
10343 * indicate that the hover object is on top (at the default theme). When the
10344 * hover is clicked it is dismissed(hidden), if the contents of the hover are
10345 * clicked that @b doesn't cause the hover to be dismissed.
10347 * @note The hover object will take up the entire space of @p target
10350 * Elementary has the following styles for the hover widget:
10354 * @li hoversel_vertical
10356 * The following are the available position for content:
10368 * Signals that you can add callbacks for are:
10369 * @li "clicked" - the user clicked the empty space in the hover to dismiss
10370 * @li "smart,changed" - a content object placed under the "smart"
10371 * policy was replaced to a new slot direction.
10373 * See @ref tutorial_hover for more information.
10377 typedef enum _Elm_Hover_Axis
10379 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10380 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10381 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10382 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10385 * @brief Adds a hover object to @p parent
10387 * @param parent The parent object
10388 * @return The hover object or NULL if one could not be created
10390 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10392 * @brief Sets the target object for the hover.
10394 * @param obj The hover object
10395 * @param target The object to center the hover onto. The hover
10397 * This function will cause the hover to be centered on the target object.
10399 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10401 * @brief Gets the target object for the hover.
10403 * @param obj The hover object
10404 * @param parent The object to locate the hover over.
10406 * @see elm_hover_target_set()
10408 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10410 * @brief Sets the parent object for the hover.
10412 * @param obj The hover object
10413 * @param parent The object to locate the hover over.
10415 * This function will cause the hover to take up the entire space that the
10416 * parent object fills.
10418 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10420 * @brief Gets the parent object for the hover.
10422 * @param obj The hover object
10423 * @return The parent object to locate the hover over.
10425 * @see elm_hover_parent_set()
10427 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10429 * @brief Sets the content of the hover object and the direction in which it
10432 * @param obj The hover object
10433 * @param swallow The direction that the object will be displayed
10434 * at. Accepted values are "left", "top-left", "top", "top-right",
10435 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10437 * @param content The content to place at @p swallow
10439 * Once the content object is set for a given direction, a previously
10440 * set one (on the same direction) will be deleted. If you want to
10441 * keep that old content object, use the elm_hover_content_unset()
10444 * All directions may have contents at the same time, except for
10445 * "smart". This is a special placement hint and its use case
10446 * independs of the calculations coming from
10447 * elm_hover_best_content_location_get(). Its use is for cases when
10448 * one desires only one hover content, but with a dinamic special
10449 * placement within the hover area. The content's geometry, whenever
10450 * it changes, will be used to decide on a best location not
10451 * extrapolating the hover's parent object view to show it in (still
10452 * being the hover's target determinant of its medium part -- move and
10453 * resize it to simulate finger sizes, for example). If one of the
10454 * directions other than "smart" are used, a previously content set
10455 * using it will be deleted, and vice-versa.
10457 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10459 * @brief Get the content of the hover object, in a given direction.
10461 * Return the content object which was set for this widget in the
10462 * @p swallow direction.
10464 * @param obj The hover object
10465 * @param swallow The direction that the object was display at.
10466 * @return The content that was being used
10468 * @see elm_hover_content_set()
10470 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10472 * @brief Unset the content of the hover object, in a given direction.
10474 * Unparent and return the content object set at @p swallow direction.
10476 * @param obj The hover object
10477 * @param swallow The direction that the object was display at.
10478 * @return The content that was being used.
10480 * @see elm_hover_content_set()
10482 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10484 * @brief Returns the best swallow location for content in the hover.
10486 * @param obj The hover object
10487 * @param pref_axis The preferred orientation axis for the hover object to use
10488 * @return The edje location to place content into the hover or @c
10491 * Best is defined here as the location at which there is the most available
10494 * @p pref_axis may be one of
10495 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10496 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10497 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10498 * - @c ELM_HOVER_AXIS_BOTH -- both
10500 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10501 * nescessarily be along the horizontal axis("left" or "right"). If
10502 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10503 * be along the vertical axis("top" or "bottom"). Chossing
10504 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10505 * returned position may be in either axis.
10507 * @see elm_hover_content_set()
10509 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10516 * @defgroup Entry Entry
10518 * @image html img/widget/entry/preview-00.png
10519 * @image latex img/widget/entry/preview-00.eps width=\textwidth
10520 * @image html img/widget/entry/preview-01.png
10521 * @image latex img/widget/entry/preview-01.eps width=\textwidth
10522 * @image html img/widget/entry/preview-02.png
10523 * @image latex img/widget/entry/preview-02.eps width=\textwidth
10524 * @image html img/widget/entry/preview-03.png
10525 * @image latex img/widget/entry/preview-03.eps width=\textwidth
10527 * An entry is a convenience widget which shows a box that the user can
10528 * enter text into. Entries by default don't scroll, so they grow to
10529 * accomodate the entire text, resizing the parent window as needed. This
10530 * can be changed with the elm_entry_scrollable_set() function.
10532 * They can also be single line or multi line (the default) and when set
10533 * to multi line mode they support text wrapping in any of the modes
10534 * indicated by #Elm_Wrap_Type.
10536 * Other features include password mode, filtering of inserted text with
10537 * elm_entry_text_filter_append() and related functions, inline "items" and
10538 * formatted markup text.
10540 * @section entry-markup Formatted text
10542 * The markup tags supported by the Entry are defined by the theme, but
10543 * even when writing new themes or extensions it's a good idea to stick to
10544 * a sane default, to maintain coherency and avoid application breakages.
10545 * Currently defined by the default theme are the following tags:
10546 * @li \<br\>: Inserts a line break.
10547 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10549 * @li \<tab\>: Inserts a tab.
10550 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10552 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10553 * @li \<link\>...\</link\>: Underlines the enclosed text.
10554 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10556 * @section entry-special Special markups
10558 * Besides those used to format text, entries support two special markup
10559 * tags used to insert clickable portions of text or items inlined within
10562 * @subsection entry-anchors Anchors
10564 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10565 * \</a\> tags and an event will be generated when this text is clicked,
10569 * This text is outside <a href=anc-01>but this one is an anchor</a>
10572 * The @c href attribute in the opening tag gives the name that will be
10573 * used to identify the anchor and it can be any valid utf8 string.
10575 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10576 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10577 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10578 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10581 * @subsection entry-items Items
10583 * Inlined in the text, any other @c Evas_Object can be inserted by using
10584 * \<item\> tags this way:
10587 * <item size=16x16 vsize=full href=emoticon/haha></item>
10590 * Just like with anchors, the @c href identifies each item, but these need,
10591 * in addition, to indicate their size, which is done using any one of
10592 * @c size, @c absize or @c relsize attributes. These attributes take their
10593 * value in the WxH format, where W is the width and H the height of the
10596 * @li absize: Absolute pixel size for the item. Whatever value is set will
10597 * be the item's size regardless of any scale value the object may have
10598 * been set to. The final line height will be adjusted to fit larger items.
10599 * @li size: Similar to @c absize, but it's adjusted to the scale value set
10601 * @li relsize: Size is adjusted for the item to fit within the current
10604 * Besides their size, items are specificed a @c vsize value that affects
10605 * how their final size and position are calculated. The possible values
10607 * @li ascent: Item will be placed within the line's baseline and its
10608 * ascent. That is, the height between the line where all characters are
10609 * positioned and the highest point in the line. For @c size and @c absize
10610 * items, the descent value will be added to the total line height to make
10611 * them fit. @c relsize items will be adjusted to fit within this space.
10612 * @li full: Items will be placed between the descent and ascent, or the
10613 * lowest point in the line and its highest.
10615 * The next image shows different configurations of items and how they
10616 * are the previously mentioned options affect their sizes. In all cases,
10617 * the green line indicates the ascent, blue for the baseline and red for
10620 * @image html entry_item.png
10621 * @image latex entry_item.eps width=\textwidth
10623 * And another one to show how size differs from absize. In the first one,
10624 * the scale value is set to 1.0, while the second one is using one of 2.0.
10626 * @image html entry_item_scale.png
10627 * @image latex entry_item_scale.eps width=\textwidth
10629 * After the size for an item is calculated, the entry will request an
10630 * object to place in its space. For this, the functions set with
10631 * elm_entry_item_provider_append() and related functions will be called
10632 * in order until one of them returns a @c non-NULL value. If no providers
10633 * are available, or all of them return @c NULL, then the entry falls back
10634 * to one of the internal defaults, provided the name matches with one of
10637 * All of the following are currently supported:
10640 * - emoticon/angry-shout
10641 * - emoticon/crazy-laugh
10642 * - emoticon/evil-laugh
10644 * - emoticon/goggle-smile
10645 * - emoticon/grumpy
10646 * - emoticon/grumpy-smile
10647 * - emoticon/guilty
10648 * - emoticon/guilty-smile
10650 * - emoticon/half-smile
10651 * - emoticon/happy-panting
10653 * - emoticon/indifferent
10655 * - emoticon/knowing-grin
10657 * - emoticon/little-bit-sorry
10658 * - emoticon/love-lots
10660 * - emoticon/minimal-smile
10661 * - emoticon/not-happy
10662 * - emoticon/not-impressed
10664 * - emoticon/opensmile
10667 * - emoticon/squint-laugh
10668 * - emoticon/surprised
10669 * - emoticon/suspicious
10670 * - emoticon/tongue-dangling
10671 * - emoticon/tongue-poke
10673 * - emoticon/unhappy
10674 * - emoticon/very-sorry
10677 * - emoticon/worried
10680 * Alternatively, an item may reference an image by its path, using
10681 * the URI form @c file:///path/to/an/image.png and the entry will then
10682 * use that image for the item.
10684 * @section entry-files Loading and saving files
10686 * Entries have convinience functions to load text from a file and save
10687 * changes back to it after a short delay. The automatic saving is enabled
10688 * by default, but can be disabled with elm_entry_autosave_set() and files
10689 * can be loaded directly as plain text or have any markup in them
10690 * recognized. See elm_entry_file_set() for more details.
10692 * @section entry-signals Emitted signals
10694 * This widget emits the following signals:
10696 * @li "changed": The text within the entry was changed.
10697 * @li "changed,user": The text within the entry was changed because of user interaction.
10698 * @li "activated": The enter key was pressed on a single line entry.
10699 * @li "press": A mouse button has been pressed on the entry.
10700 * @li "longpressed": A mouse button has been pressed and held for a couple
10702 * @li "clicked": The entry has been clicked (mouse press and release).
10703 * @li "clicked,double": The entry has been double clicked.
10704 * @li "clicked,triple": The entry has been triple clicked.
10705 * @li "focused": The entry has received focus.
10706 * @li "unfocused": The entry has lost focus.
10707 * @li "selection,paste": A paste of the clipboard contents was requested.
10708 * @li "selection,copy": A copy of the selected text into the clipboard was
10710 * @li "selection,cut": A cut of the selected text into the clipboard was
10712 * @li "selection,start": A selection has begun and no previous selection
10714 * @li "selection,changed": The current selection has changed.
10715 * @li "selection,cleared": The current selection has been cleared.
10716 * @li "cursor,changed": The cursor has changed position.
10717 * @li "anchor,clicked": An anchor has been clicked. The event_info
10718 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10719 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
10720 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10721 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
10722 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10723 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
10724 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10725 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
10726 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10727 * @li "preedit,changed": The preedit string has changed.
10729 * @section entry-examples
10731 * An overview of the Entry API can be seen in @ref entry_example_01
10736 * @typedef Elm_Entry_Anchor_Info
10738 * The info sent in the callback for the "anchor,clicked" signals emitted
10741 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
10743 * @struct _Elm_Entry_Anchor_Info
10745 * The info sent in the callback for the "anchor,clicked" signals emitted
10748 struct _Elm_Entry_Anchor_Info
10750 const char *name; /**< The name of the anchor, as stated in its href */
10751 int button; /**< The mouse button used to click on it */
10752 Evas_Coord x, /**< Anchor geometry, relative to canvas */
10753 y, /**< Anchor geometry, relative to canvas */
10754 w, /**< Anchor geometry, relative to canvas */
10755 h; /**< Anchor geometry, relative to canvas */
10758 * @typedef Elm_Entry_Filter_Cb
10759 * This callback type is used by entry filters to modify text.
10760 * @param data The data specified as the last param when adding the filter
10761 * @param entry The entry object
10762 * @param text A pointer to the location of the text being filtered. This data can be modified,
10763 * but any additional allocations must be managed by the user.
10764 * @see elm_entry_text_filter_append
10765 * @see elm_entry_text_filter_prepend
10767 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
10770 * This adds an entry to @p parent object.
10772 * By default, entries are:
10776 * @li autosave is enabled
10778 * @param parent The parent object
10779 * @return The new object or NULL if it cannot be created
10781 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10783 * Sets the entry to single line mode.
10785 * In single line mode, entries don't ever wrap when the text reaches the
10786 * edge, and instead they keep growing horizontally. Pressing the @c Enter
10787 * key will generate an @c "activate" event instead of adding a new line.
10789 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
10790 * and pressing enter will break the text into a different line
10791 * without generating any events.
10793 * @param obj The entry object
10794 * @param single_line If true, the text in the entry
10795 * will be on a single line.
10797 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
10799 * Gets whether the entry is set to be single line.
10801 * @param obj The entry object
10802 * @return single_line If true, the text in the entry is set to display
10803 * on a single line.
10805 * @see elm_entry_single_line_set()
10807 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10809 * Sets the entry to password mode.
10811 * In password mode, entries are implicitly single line and the display of
10812 * any text in them is replaced with asterisks (*).
10814 * @param obj The entry object
10815 * @param password If true, password mode is enabled.
10817 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
10819 * Gets whether the entry is set to password mode.
10821 * @param obj The entry object
10822 * @return If true, the entry is set to display all characters
10823 * as asterisks (*).
10825 * @see elm_entry_password_set()
10827 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10829 * This sets the text displayed within the entry to @p entry.
10831 * @param obj The entry object
10832 * @param entry The text to be displayed
10834 * @deprecated Use elm_object_text_set() instead.
10836 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10838 * This returns the text currently shown in object @p entry.
10839 * See also elm_entry_entry_set().
10841 * @param obj The entry object
10842 * @return The currently displayed text or NULL on failure
10844 * @deprecated Use elm_object_text_get() instead.
10846 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10848 * Appends @p entry to the text of the entry.
10850 * Adds the text in @p entry to the end of any text already present in the
10853 * The appended text is subject to any filters set for the widget.
10855 * @param obj The entry object
10856 * @param entry The text to be displayed
10858 * @see elm_entry_text_filter_append()
10860 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10862 * Gets whether the entry is empty.
10864 * Empty means no text at all. If there are any markup tags, like an item
10865 * tag for which no provider finds anything, and no text is displayed, this
10866 * function still returns EINA_FALSE.
10868 * @param obj The entry object
10869 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
10871 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10873 * Gets any selected text within the entry.
10875 * If there's any selected text in the entry, this function returns it as
10876 * a string in markup format. NULL is returned if no selection exists or
10877 * if an error occurred.
10879 * The returned value points to an internal string and should not be freed
10880 * or modified in any way. If the @p entry object is deleted or its
10881 * contents are changed, the returned pointer should be considered invalid.
10883 * @param obj The entry object
10884 * @return The selected text within the entry or NULL on failure
10886 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10888 * Inserts the given text into the entry at the current cursor position.
10890 * This inserts text at the cursor position as if it was typed
10891 * by the user (note that this also allows markup which a user
10892 * can't just "type" as it would be converted to escaped text, so this
10893 * call can be used to insert things like emoticon items or bold push/pop
10894 * tags, other font and color change tags etc.)
10896 * If any selection exists, it will be replaced by the inserted text.
10898 * The inserted text is subject to any filters set for the widget.
10900 * @param obj The entry object
10901 * @param entry The text to insert
10903 * @see elm_entry_text_filter_append()
10905 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10907 * Set the line wrap type to use on multi-line entries.
10909 * Sets the wrap type used by the entry to any of the specified in
10910 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
10911 * line (without inserting a line break or paragraph separator) when it
10912 * reaches the far edge of the widget.
10914 * Note that this only makes sense for multi-line entries. A widget set
10915 * to be single line will never wrap.
10917 * @param obj The entry object
10918 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
10920 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
10922 * Gets the wrap mode the entry was set to use.
10924 * @param obj The entry object
10925 * @return Wrap type
10927 * @see also elm_entry_line_wrap_set()
10929 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10931 * Sets if the entry is to be editable or not.
10933 * By default, entries are editable and when focused, any text input by the
10934 * user will be inserted at the current cursor position. But calling this
10935 * function with @p editable as EINA_FALSE will prevent the user from
10936 * inputting text into the entry.
10938 * The only way to change the text of a non-editable entry is to use
10939 * elm_object_text_set(), elm_entry_entry_insert() and other related
10942 * @param obj The entry object
10943 * @param editable If EINA_TRUE, user input will be inserted in the entry,
10944 * if not, the entry is read-only and no user input is allowed.
10946 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
10948 * Gets whether the entry is editable or not.
10950 * @param obj The entry object
10951 * @return If true, the entry is editable by the user.
10952 * If false, it is not editable by the user
10954 * @see elm_entry_editable_set()
10956 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10958 * This drops any existing text selection within the entry.
10960 * @param obj The entry object
10962 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
10964 * This selects all text within the entry.
10966 * @param obj The entry object
10968 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
10970 * This moves the cursor one place to the right within the entry.
10972 * @param obj The entry object
10973 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10975 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
10977 * This moves the cursor one place to the left within the entry.
10979 * @param obj The entry object
10980 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10982 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
10984 * This moves the cursor one line up within the entry.
10986 * @param obj The entry object
10987 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10989 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
10991 * This moves the cursor one line down within the entry.
10993 * @param obj The entry object
10994 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10996 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
10998 * This moves the cursor to the beginning of the entry.
11000 * @param obj The entry object
11002 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11004 * This moves the cursor to the end of the entry.
11006 * @param obj The entry object
11008 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11010 * This moves the cursor to the beginning of the current line.
11012 * @param obj The entry object
11014 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11016 * This moves the cursor to the end of the current line.
11018 * @param obj The entry object
11020 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11022 * This begins a selection within the entry as though
11023 * the user were holding down the mouse button to make a selection.
11025 * @param obj The entry object
11027 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
11029 * This ends a selection within the entry as though
11030 * the user had just released the mouse button while making a selection.
11032 * @param obj The entry object
11034 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11036 * Gets whether a format node exists at the current cursor position.
11038 * A format node is anything that defines how the text is rendered. It can
11039 * be a visible format node, such as a line break or a paragraph separator,
11040 * or an invisible one, such as bold begin or end tag.
11041 * This function returns whether any format node exists at the current
11044 * @param obj The entry object
11045 * @return EINA_TRUE if the current cursor position contains a format node,
11046 * EINA_FALSE otherwise.
11048 * @see elm_entry_cursor_is_visible_format_get()
11050 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11052 * Gets if the current cursor position holds a visible format node.
11054 * @param obj The entry object
11055 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
11056 * if it's an invisible one or no format exists.
11058 * @see elm_entry_cursor_is_format_get()
11060 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11062 * Gets the character pointed by the cursor at its current position.
11064 * This function returns a string with the utf8 character stored at the
11065 * current cursor position.
11066 * Only the text is returned, any format that may exist will not be part
11067 * of the return value.
11069 * @param obj The entry object
11070 * @return The text pointed by the cursors.
11072 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11074 * This function returns the geometry of the cursor.
11076 * It's useful if you want to draw something on the cursor (or where it is),
11077 * or for example in the case of scrolled entry where you want to show the
11080 * @param obj The entry object
11081 * @param x returned geometry
11082 * @param y returned geometry
11083 * @param w returned geometry
11084 * @param h returned geometry
11085 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11087 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);
11089 * Sets the cursor position in the entry to the given value
11091 * The value in @p pos is the index of the character position within the
11092 * contents of the string as returned by elm_entry_cursor_pos_get().
11094 * @param obj The entry object
11095 * @param pos The position of the cursor
11097 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
11099 * Retrieves the current position of the cursor in the entry
11101 * @param obj The entry object
11102 * @return The cursor position
11104 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11106 * This executes a "cut" action on the selected text in the entry.
11108 * @param obj The entry object
11110 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
11112 * This executes a "copy" action on the selected text in the entry.
11114 * @param obj The entry object
11116 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
11118 * This executes a "paste" action in the entry.
11120 * @param obj The entry object
11122 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
11124 * This clears and frees the items in a entry's contextual (longpress)
11127 * @param obj The entry object
11129 * @see elm_entry_context_menu_item_add()
11131 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11133 * This adds an item to the entry's contextual menu.
11135 * A longpress on an entry will make the contextual menu show up, if this
11136 * hasn't been disabled with elm_entry_context_menu_disabled_set().
11137 * By default, this menu provides a few options like enabling selection mode,
11138 * which is useful on embedded devices that need to be explicit about it,
11139 * and when a selection exists it also shows the copy and cut actions.
11141 * With this function, developers can add other options to this menu to
11142 * perform any action they deem necessary.
11144 * @param obj The entry object
11145 * @param label The item's text label
11146 * @param icon_file The item's icon file
11147 * @param icon_type The item's icon type
11148 * @param func The callback to execute when the item is clicked
11149 * @param data The data to associate with the item for related functions
11151 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);
11153 * This disables the entry's contextual (longpress) menu.
11155 * @param obj The entry object
11156 * @param disabled If true, the menu is disabled
11158 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11160 * This returns whether the entry's contextual (longpress) menu is
11163 * @param obj The entry object
11164 * @return If true, the menu is disabled
11166 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11168 * This appends a custom item provider to the list for that entry
11170 * This appends the given callback. The list is walked from beginning to end
11171 * with each function called given the item href string in the text. If the
11172 * function returns an object handle other than NULL (it should create an
11173 * object to do this), then this object is used to replace that item. If
11174 * not the next provider is called until one provides an item object, or the
11175 * default provider in entry does.
11177 * @param obj The entry object
11178 * @param func The function called to provide the item object
11179 * @param data The data passed to @p func
11181 * @see @ref entry-items
11183 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);
11185 * This prepends a custom item provider to the list for that entry
11187 * This prepends the given callback. See elm_entry_item_provider_append() for
11190 * @param obj The entry object
11191 * @param func The function called to provide the item object
11192 * @param data The data passed to @p func
11194 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);
11196 * This removes a custom item provider to the list for that entry
11198 * This removes the given callback. See elm_entry_item_provider_append() for
11201 * @param obj The entry object
11202 * @param func The function called to provide the item object
11203 * @param data The data passed to @p func
11205 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);
11207 * Append a filter function for text inserted in the entry
11209 * Append the given callback to the list. This functions will be called
11210 * whenever any text is inserted into the entry, with the text to be inserted
11211 * as a parameter. The callback function is free to alter the text in any way
11212 * it wants, but it must remember to free the given pointer and update it.
11213 * If the new text is to be discarded, the function can free it and set its
11214 * text parameter to NULL. This will also prevent any following filters from
11217 * @param obj The entry object
11218 * @param func The function to use as text filter
11219 * @param data User data to pass to @p func
11221 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11223 * Prepend a filter function for text insdrted in the entry
11225 * Prepend the given callback to the list. See elm_entry_text_filter_append()
11226 * for more information
11228 * @param obj The entry object
11229 * @param func The function to use as text filter
11230 * @param data User data to pass to @p func
11232 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11234 * Remove a filter from the list
11236 * Removes the given callback from the filter list. See
11237 * elm_entry_text_filter_append() for more information.
11239 * @param obj The entry object
11240 * @param func The filter function to remove
11241 * @param data The user data passed when adding the function
11243 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11245 * This converts a markup (HTML-like) string into UTF-8.
11247 * The returned string is a malloc'ed buffer and it should be freed when
11248 * not needed anymore.
11250 * @param s The string (in markup) to be converted
11251 * @return The converted string (in UTF-8). It should be freed.
11253 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11255 * This converts a UTF-8 string into markup (HTML-like).
11257 * The returned string is a malloc'ed buffer and it should be freed when
11258 * not needed anymore.
11260 * @param s The string (in UTF-8) to be converted
11261 * @return The converted string (in markup). It should be freed.
11263 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11265 * This sets the file (and implicitly loads it) for the text to display and
11266 * then edit. All changes are written back to the file after a short delay if
11267 * the entry object is set to autosave (which is the default).
11269 * If the entry had any other file set previously, any changes made to it
11270 * will be saved if the autosave feature is enabled, otherwise, the file
11271 * will be silently discarded and any non-saved changes will be lost.
11273 * @param obj The entry object
11274 * @param file The path to the file to load and save
11275 * @param format The file format
11277 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11279 * Gets the file being edited by the entry.
11281 * This function can be used to retrieve any file set on the entry for
11282 * edition, along with the format used to load and save it.
11284 * @param obj The entry object
11285 * @param file The path to the file to load and save
11286 * @param format The file format
11288 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11290 * This function writes any changes made to the file set with
11291 * elm_entry_file_set()
11293 * @param obj The entry object
11295 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11297 * This sets the entry object to 'autosave' the loaded text file or not.
11299 * @param obj The entry object
11300 * @param autosave Autosave the loaded file or not
11302 * @see elm_entry_file_set()
11304 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11306 * This gets the entry object's 'autosave' status.
11308 * @param obj The entry object
11309 * @return Autosave the loaded file or not
11311 * @see elm_entry_file_set()
11313 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11315 * Control pasting of text and images for the widget.
11317 * Normally the entry allows both text and images to be pasted. By setting
11318 * textonly to be true, this prevents images from being pasted.
11320 * Note this only changes the behaviour of text.
11322 * @param obj The entry object
11323 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11324 * text+image+other.
11326 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11328 * Getting elm_entry text paste/drop mode.
11330 * In textonly mode, only text may be pasted or dropped into the widget.
11332 * @param obj The entry object
11333 * @return If the widget only accepts text from pastes.
11335 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11337 * Enable or disable scrolling in entry
11339 * Normally the entry is not scrollable unless you enable it with this call.
11341 * @param obj The entry object
11342 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11344 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11346 * Get the scrollable state of the entry
11348 * Normally the entry is not scrollable. This gets the scrollable state
11349 * of the entry. See elm_entry_scrollable_set() for more information.
11351 * @param obj The entry object
11352 * @return The scrollable state
11354 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
11356 * This sets a widget to be displayed to the left of a scrolled entry.
11358 * @param obj The scrolled entry object
11359 * @param icon The widget to display on the left side of the scrolled
11362 * @note A previously set widget will be destroyed.
11363 * @note If the object being set does not have minimum size hints set,
11364 * it won't get properly displayed.
11366 * @see elm_entry_end_set()
11368 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11370 * Gets the leftmost widget of the scrolled entry. This object is
11371 * owned by the scrolled entry and should not be modified.
11373 * @param obj The scrolled entry object
11374 * @return the left widget inside the scroller
11376 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11378 * Unset the leftmost widget of the scrolled entry, unparenting and
11381 * @param obj The scrolled entry object
11382 * @return the previously set icon sub-object of this entry, on
11385 * @see elm_entry_icon_set()
11387 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11389 * Sets the visibility of the left-side widget of the scrolled entry,
11390 * set by elm_entry_icon_set().
11392 * @param obj The scrolled entry object
11393 * @param setting EINA_TRUE if the object should be displayed,
11394 * EINA_FALSE if not.
11396 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11398 * This sets a widget to be displayed to the end of a scrolled entry.
11400 * @param obj The scrolled entry object
11401 * @param end The widget to display on the right side of the scrolled
11404 * @note A previously set widget will be destroyed.
11405 * @note If the object being set does not have minimum size hints set,
11406 * it won't get properly displayed.
11408 * @see elm_entry_icon_set
11410 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11412 * Gets the endmost widget of the scrolled entry. This object is owned
11413 * by the scrolled entry and should not be modified.
11415 * @param obj The scrolled entry object
11416 * @return the right widget inside the scroller
11418 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11420 * Unset the endmost widget of the scrolled entry, unparenting and
11423 * @param obj The scrolled entry object
11424 * @return the previously set icon sub-object of this entry, on
11427 * @see elm_entry_icon_set()
11429 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11431 * Sets the visibility of the end widget of the scrolled entry, set by
11432 * elm_entry_end_set().
11434 * @param obj The scrolled entry object
11435 * @param setting EINA_TRUE if the object should be displayed,
11436 * EINA_FALSE if not.
11438 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11440 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11443 * Setting an entry to single-line mode with elm_entry_single_line_set()
11444 * will automatically disable the display of scrollbars when the entry
11445 * moves inside its scroller.
11447 * @param obj The scrolled entry object
11448 * @param h The horizontal scrollbar policy to apply
11449 * @param v The vertical scrollbar policy to apply
11451 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11453 * This enables/disables bouncing within the entry.
11455 * This function sets whether the entry will bounce when scrolling reaches
11456 * the end of the contained entry.
11458 * @param obj The scrolled entry object
11459 * @param h The horizontal bounce state
11460 * @param v The vertical bounce state
11462 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11464 * Get the bounce mode
11466 * @param obj The Entry object
11467 * @param h_bounce Allow bounce horizontally
11468 * @param v_bounce Allow bounce vertically
11470 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11472 /* pre-made filters for entries */
11474 * @typedef Elm_Entry_Filter_Limit_Size
11476 * Data for the elm_entry_filter_limit_size() entry filter.
11478 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11480 * @struct _Elm_Entry_Filter_Limit_Size
11482 * Data for the elm_entry_filter_limit_size() entry filter.
11484 struct _Elm_Entry_Filter_Limit_Size
11486 int max_char_count; /**< The maximum number of characters allowed. */
11487 int max_byte_count; /**< The maximum number of bytes allowed*/
11490 * Filter inserted text based on user defined character and byte limits
11492 * Add this filter to an entry to limit the characters that it will accept
11493 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11494 * The funtion works on the UTF-8 representation of the string, converting
11495 * it from the set markup, thus not accounting for any format in it.
11497 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11498 * it as data when setting the filter. In it, it's possible to set limits
11499 * by character count or bytes (any of them is disabled if 0), and both can
11500 * be set at the same time. In that case, it first checks for characters,
11503 * The function will cut the inserted text in order to allow only the first
11504 * number of characters that are still allowed. The cut is made in
11505 * characters, even when limiting by bytes, in order to always contain
11506 * valid ones and avoid half unicode characters making it in.
11508 * This filter, like any others, does not apply when setting the entry text
11509 * directly with elm_object_text_set() (or the deprecated
11510 * elm_entry_entry_set()).
11512 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11514 * @typedef Elm_Entry_Filter_Accept_Set
11516 * Data for the elm_entry_filter_accept_set() entry filter.
11518 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11520 * @struct _Elm_Entry_Filter_Accept_Set
11522 * Data for the elm_entry_filter_accept_set() entry filter.
11524 struct _Elm_Entry_Filter_Accept_Set
11526 const char *accepted; /**< Set of characters accepted in the entry. */
11527 const char *rejected; /**< Set of characters rejected from the entry. */
11530 * Filter inserted text based on accepted or rejected sets of characters
11532 * Add this filter to an entry to restrict the set of accepted characters
11533 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11534 * This structure contains both accepted and rejected sets, but they are
11535 * mutually exclusive.
11537 * The @c accepted set takes preference, so if it is set, the filter will
11538 * only work based on the accepted characters, ignoring anything in the
11539 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11541 * In both cases, the function filters by matching utf8 characters to the
11542 * raw markup text, so it can be used to remove formatting tags.
11544 * This filter, like any others, does not apply when setting the entry text
11545 * directly with elm_object_text_set() (or the deprecated
11546 * elm_entry_entry_set()).
11548 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11550 * Set the input panel layout of the entry
11552 * @param obj The entry object
11553 * @param layout layout type
11555 EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
11557 * Get the input panel layout of the entry
11559 * @param obj The entry object
11560 * @return layout type
11562 * @see elm_entry_input_panel_layout_set
11564 EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11569 /* composite widgets - these basically put together basic widgets above
11570 * in convenient packages that do more than basic stuff */
11574 * @defgroup Anchorview Anchorview
11576 * @image html img/widget/anchorview/preview-00.png
11577 * @image latex img/widget/anchorview/preview-00.eps
11579 * Anchorview is for displaying text that contains markup with anchors
11580 * like <c>\<a href=1234\>something\</\></c> in it.
11582 * Besides being styled differently, the anchorview widget provides the
11583 * necessary functionality so that clicking on these anchors brings up a
11584 * popup with user defined content such as "call", "add to contacts" or
11585 * "open web page". This popup is provided using the @ref Hover widget.
11587 * This widget is very similar to @ref Anchorblock, so refer to that
11588 * widget for an example. The only difference Anchorview has is that the
11589 * widget is already provided with scrolling functionality, so if the
11590 * text set to it is too large to fit in the given space, it will scroll,
11591 * whereas the @ref Anchorblock widget will keep growing to ensure all the
11592 * text can be displayed.
11594 * This widget emits the following signals:
11595 * @li "anchor,clicked": will be called when an anchor is clicked. The
11596 * @p event_info parameter on the callback will be a pointer of type
11597 * ::Elm_Entry_Anchorview_Info.
11599 * See @ref Anchorblock for an example on how to use both of them.
11608 * @typedef Elm_Entry_Anchorview_Info
11610 * The info sent in the callback for "anchor,clicked" signals emitted by
11611 * the Anchorview widget.
11613 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
11615 * @struct _Elm_Entry_Anchorview_Info
11617 * The info sent in the callback for "anchor,clicked" signals emitted by
11618 * the Anchorview widget.
11620 struct _Elm_Entry_Anchorview_Info
11622 const char *name; /**< Name of the anchor, as indicated in its href
11624 int button; /**< The mouse button used to click on it */
11625 Evas_Object *hover; /**< The hover object to use for the popup */
11627 Evas_Coord x, y, w, h;
11628 } anchor, /**< Geometry selection of text used as anchor */
11629 hover_parent; /**< Geometry of the object used as parent by the
11631 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
11632 for content on the left side of
11633 the hover. Before calling the
11634 callback, the widget will make the
11635 necessary calculations to check
11636 which sides are fit to be set with
11637 content, based on the position the
11638 hover is activated and its distance
11639 to the edges of its parent object
11641 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
11642 the right side of the hover.
11643 See @ref hover_left */
11644 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
11645 of the hover. See @ref hover_left */
11646 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
11647 below the hover. See @ref
11651 * Add a new Anchorview object
11653 * @param parent The parent object
11654 * @return The new object or NULL if it cannot be created
11656 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11658 * Set the text to show in the anchorview
11660 * Sets the text of the anchorview to @p text. This text can include markup
11661 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
11662 * text that will be specially styled and react to click events, ended with
11663 * either of \</a\> or \</\>. When clicked, the anchor will emit an
11664 * "anchor,clicked" signal that you can attach a callback to with
11665 * evas_object_smart_callback_add(). The name of the anchor given in the
11666 * event info struct will be the one set in the href attribute, in this
11667 * case, anchorname.
11669 * Other markup can be used to style the text in different ways, but it's
11670 * up to the style defined in the theme which tags do what.
11671 * @deprecated use elm_object_text_set() instead.
11673 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11675 * Get the markup text set for the anchorview
11677 * Retrieves the text set on the anchorview, with markup tags included.
11679 * @param obj The anchorview object
11680 * @return The markup text set or @c NULL if nothing was set or an error
11682 * @deprecated use elm_object_text_set() instead.
11684 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11686 * Set the parent of the hover popup
11688 * Sets the parent object to use by the hover created by the anchorview
11689 * when an anchor is clicked. See @ref Hover for more details on this.
11690 * If no parent is set, the same anchorview object will be used.
11692 * @param obj The anchorview object
11693 * @param parent The object to use as parent for the hover
11695 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11697 * Get the parent of the hover popup
11699 * Get the object used as parent for the hover created by the anchorview
11700 * widget. See @ref Hover for more details on this.
11702 * @param obj The anchorview object
11703 * @return The object used as parent for the hover, NULL if none is set.
11705 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11707 * Set the style that the hover should use
11709 * When creating the popup hover, anchorview will request that it's
11710 * themed according to @p style.
11712 * @param obj The anchorview object
11713 * @param style The style to use for the underlying hover
11715 * @see elm_object_style_set()
11717 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11719 * Get the style that the hover should use
11721 * Get the style the hover created by anchorview will use.
11723 * @param obj The anchorview object
11724 * @return The style to use by the hover. NULL means the default is used.
11726 * @see elm_object_style_set()
11728 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11730 * Ends the hover popup in the anchorview
11732 * When an anchor is clicked, the anchorview widget will create a hover
11733 * object to use as a popup with user provided content. This function
11734 * terminates this popup, returning the anchorview to its normal state.
11736 * @param obj The anchorview object
11738 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11740 * Set bouncing behaviour when the scrolled content reaches an edge
11742 * Tell the internal scroller object whether it should bounce or not
11743 * when it reaches the respective edges for each axis.
11745 * @param obj The anchorview object
11746 * @param h_bounce Whether to bounce or not in the horizontal axis
11747 * @param v_bounce Whether to bounce or not in the vertical axis
11749 * @see elm_scroller_bounce_set()
11751 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
11753 * Get the set bouncing behaviour of the internal scroller
11755 * Get whether the internal scroller should bounce when the edge of each
11756 * axis is reached scrolling.
11758 * @param obj The anchorview object
11759 * @param h_bounce Pointer where to store the bounce state of the horizontal
11761 * @param v_bounce Pointer where to store the bounce state of the vertical
11764 * @see elm_scroller_bounce_get()
11766 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
11768 * Appends a custom item provider to the given anchorview
11770 * Appends the given function to the list of items providers. This list is
11771 * called, one function at a time, with the given @p data pointer, the
11772 * anchorview object and, in the @p item parameter, the item name as
11773 * referenced in its href string. Following functions in the list will be
11774 * called in order until one of them returns something different to NULL,
11775 * which should be an Evas_Object which will be used in place of the item
11778 * Items in the markup text take the form \<item relsize=16x16 vsize=full
11779 * href=item/name\>\</item\>
11781 * @param obj The anchorview object
11782 * @param func The function to add to the list of providers
11783 * @param data User data that will be passed to the callback function
11785 * @see elm_entry_item_provider_append()
11787 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);
11789 * Prepend a custom item provider to the given anchorview
11791 * Like elm_anchorview_item_provider_append(), but it adds the function
11792 * @p func to the beginning of the list, instead of the end.
11794 * @param obj The anchorview object
11795 * @param func The function to add to the list of providers
11796 * @param data User data that will be passed to the callback function
11798 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);
11800 * Remove a custom item provider from the list of the given anchorview
11802 * Removes the function and data pairing that matches @p func and @p data.
11803 * That is, unless the same function and same user data are given, the
11804 * function will not be removed from the list. This allows us to add the
11805 * same callback several times, with different @p data pointers and be
11806 * able to remove them later without conflicts.
11808 * @param obj The anchorview object
11809 * @param func The function to remove from the list
11810 * @param data The data matching the function to remove from the list
11812 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);
11819 * @defgroup Anchorblock Anchorblock
11821 * @image html img/widget/anchorblock/preview-00.png
11822 * @image latex img/widget/anchorblock/preview-00.eps
11824 * Anchorblock is for displaying text that contains markup with anchors
11825 * like <c>\<a href=1234\>something\</\></c> in it.
11827 * Besides being styled differently, the anchorblock widget provides the
11828 * necessary functionality so that clicking on these anchors brings up a
11829 * popup with user defined content such as "call", "add to contacts" or
11830 * "open web page". This popup is provided using the @ref Hover widget.
11832 * This widget emits the following signals:
11833 * @li "anchor,clicked": will be called when an anchor is clicked. The
11834 * @p event_info parameter on the callback will be a pointer of type
11835 * ::Elm_Entry_Anchorblock_Info.
11841 * Since examples are usually better than plain words, we might as well
11842 * try @ref tutorial_anchorblock_example "one".
11845 * @addtogroup Anchorblock
11849 * @typedef Elm_Entry_Anchorblock_Info
11851 * The info sent in the callback for "anchor,clicked" signals emitted by
11852 * the Anchorblock widget.
11854 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
11856 * @struct _Elm_Entry_Anchorblock_Info
11858 * The info sent in the callback for "anchor,clicked" signals emitted by
11859 * the Anchorblock widget.
11861 struct _Elm_Entry_Anchorblock_Info
11863 const char *name; /**< Name of the anchor, as indicated in its href
11865 int button; /**< The mouse button used to click on it */
11866 Evas_Object *hover; /**< The hover object to use for the popup */
11868 Evas_Coord x, y, w, h;
11869 } anchor, /**< Geometry selection of text used as anchor */
11870 hover_parent; /**< Geometry of the object used as parent by the
11872 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
11873 for content on the left side of
11874 the hover. Before calling the
11875 callback, the widget will make the
11876 necessary calculations to check
11877 which sides are fit to be set with
11878 content, based on the position the
11879 hover is activated and its distance
11880 to the edges of its parent object
11882 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
11883 the right side of the hover.
11884 See @ref hover_left */
11885 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
11886 of the hover. See @ref hover_left */
11887 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
11888 below the hover. See @ref
11892 * Add a new Anchorblock object
11894 * @param parent The parent object
11895 * @return The new object or NULL if it cannot be created
11897 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11899 * Set the text to show in the anchorblock
11901 * Sets the text of the anchorblock to @p text. This text can include markup
11902 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
11903 * of text that will be specially styled and react to click events, ended
11904 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
11905 * "anchor,clicked" signal that you can attach a callback to with
11906 * evas_object_smart_callback_add(). The name of the anchor given in the
11907 * event info struct will be the one set in the href attribute, in this
11908 * case, anchorname.
11910 * Other markup can be used to style the text in different ways, but it's
11911 * up to the style defined in the theme which tags do what.
11912 * @deprecated use elm_object_text_set() instead.
11914 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11916 * Get the markup text set for the anchorblock
11918 * Retrieves the text set on the anchorblock, with markup tags included.
11920 * @param obj The anchorblock object
11921 * @return The markup text set or @c NULL if nothing was set or an error
11923 * @deprecated use elm_object_text_set() instead.
11925 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11927 * Set the parent of the hover popup
11929 * Sets the parent object to use by the hover created by the anchorblock
11930 * when an anchor is clicked. See @ref Hover for more details on this.
11932 * @param obj The anchorblock object
11933 * @param parent The object to use as parent for the hover
11935 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11937 * Get the parent of the hover popup
11939 * Get the object used as parent for the hover created by the anchorblock
11940 * widget. See @ref Hover for more details on this.
11941 * If no parent is set, the same anchorblock object will be used.
11943 * @param obj The anchorblock object
11944 * @return The object used as parent for the hover, NULL if none is set.
11946 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11948 * Set the style that the hover should use
11950 * When creating the popup hover, anchorblock will request that it's
11951 * themed according to @p style.
11953 * @param obj The anchorblock object
11954 * @param style The style to use for the underlying hover
11956 * @see elm_object_style_set()
11958 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11960 * Get the style that the hover should use
11962 * Get the style the hover created by anchorblock will use.
11964 * @param obj The anchorblock object
11965 * @return The style to use by the hover. NULL means the default is used.
11967 * @see elm_object_style_set()
11969 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11971 * Ends the hover popup in the anchorblock
11973 * When an anchor is clicked, the anchorblock widget will create a hover
11974 * object to use as a popup with user provided content. This function
11975 * terminates this popup, returning the anchorblock to its normal state.
11977 * @param obj The anchorblock object
11979 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11981 * Appends a custom item provider to the given anchorblock
11983 * Appends the given function to the list of items providers. This list is
11984 * called, one function at a time, with the given @p data pointer, the
11985 * anchorblock object and, in the @p item parameter, the item name as
11986 * referenced in its href string. Following functions in the list will be
11987 * called in order until one of them returns something different to NULL,
11988 * which should be an Evas_Object which will be used in place of the item
11991 * Items in the markup text take the form \<item relsize=16x16 vsize=full
11992 * href=item/name\>\</item\>
11994 * @param obj The anchorblock object
11995 * @param func The function to add to the list of providers
11996 * @param data User data that will be passed to the callback function
11998 * @see elm_entry_item_provider_append()
12000 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);
12002 * Prepend a custom item provider to the given anchorblock
12004 * Like elm_anchorblock_item_provider_append(), but it adds the function
12005 * @p func to the beginning of the list, instead of the end.
12007 * @param obj The anchorblock object
12008 * @param func The function to add to the list of providers
12009 * @param data User data that will be passed to the callback function
12011 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);
12013 * Remove a custom item provider from the list of the given anchorblock
12015 * Removes the function and data pairing that matches @p func and @p data.
12016 * That is, unless the same function and same user data are given, the
12017 * function will not be removed from the list. This allows us to add the
12018 * same callback several times, with different @p data pointers and be
12019 * able to remove them later without conflicts.
12021 * @param obj The anchorblock object
12022 * @param func The function to remove from the list
12023 * @param data The data matching the function to remove from the list
12025 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);
12031 * @defgroup Bubble Bubble
12033 * @image html img/widget/bubble/preview-00.png
12034 * @image latex img/widget/bubble/preview-00.eps
12035 * @image html img/widget/bubble/preview-01.png
12036 * @image latex img/widget/bubble/preview-01.eps
12037 * @image html img/widget/bubble/preview-02.png
12038 * @image latex img/widget/bubble/preview-02.eps
12040 * @brief The Bubble is a widget to show text similarly to how speech is
12041 * represented in comics.
12043 * The bubble widget contains 5 important visual elements:
12044 * @li The frame is a rectangle with rounded rectangles and an "arrow".
12045 * @li The @p icon is an image to which the frame's arrow points to.
12046 * @li The @p label is a text which appears to the right of the icon if the
12047 * corner is "top_left" or "bottom_left" and is right aligned to the frame
12049 * @li The @p info is a text which appears to the right of the label. Info's
12050 * font is of a ligther color than label.
12051 * @li The @p content is an evas object that is shown inside the frame.
12053 * The position of the arrow, icon, label and info depends on which corner is
12054 * selected. The four available corners are:
12055 * @li "top_left" - Default
12057 * @li "bottom_left"
12058 * @li "bottom_right"
12060 * Signals that you can add callbacks for are:
12061 * @li "clicked" - This is called when a user has clicked the bubble.
12063 * For an example of using a buble see @ref bubble_01_example_page "this".
12068 * Add a new bubble to the parent
12070 * @param parent The parent object
12071 * @return The new object or NULL if it cannot be created
12073 * This function adds a text bubble to the given parent evas object.
12075 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12077 * Set the label of the bubble
12079 * @param obj The bubble object
12080 * @param label The string to set in the label
12082 * This function sets the title of the bubble. Where this appears depends on
12083 * the selected corner.
12084 * @deprecated use elm_object_text_set() instead.
12086 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12088 * Get the label of the bubble
12090 * @param obj The bubble object
12091 * @return The string of set in the label
12093 * This function gets the title of the bubble.
12094 * @deprecated use elm_object_text_get() instead.
12096 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12098 * Set the info of the bubble
12100 * @param obj The bubble object
12101 * @param info The given info about the bubble
12103 * This function sets the info of the bubble. Where this appears depends on
12104 * the selected corner.
12105 * @deprecated use elm_object_text_part_set() instead. (with "info" as the parameter).
12107 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
12109 * Get the info of the bubble
12111 * @param obj The bubble object
12113 * @return The "info" string of the bubble
12115 * This function gets the info text.
12116 * @deprecated use elm_object_text_part_get() instead. (with "info" as the parameter).
12118 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12120 * Set the content to be shown in the bubble
12122 * Once the content object is set, a previously set one will be deleted.
12123 * If you want to keep the old content object, use the
12124 * elm_bubble_content_unset() function.
12126 * @param obj The bubble object
12127 * @param content The given content of the bubble
12129 * This function sets the content shown on the middle of the bubble.
12131 EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12133 * Get the content shown in the bubble
12135 * Return the content object which is set for this widget.
12137 * @param obj The bubble object
12138 * @return The content that is being used
12140 EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12142 * Unset the content shown in the bubble
12144 * Unparent and return the content object which was set for this widget.
12146 * @param obj The bubble object
12147 * @return The content that was being used
12149 EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12151 * Set the icon of the bubble
12153 * Once the icon object is set, a previously set one will be deleted.
12154 * If you want to keep the old content object, use the
12155 * elm_icon_content_unset() function.
12157 * @param obj The bubble object
12158 * @param icon The given icon for the bubble
12160 EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12162 * Get the icon of the bubble
12164 * @param obj The bubble object
12165 * @return The icon for the bubble
12167 * This function gets the icon shown on the top left of bubble.
12169 EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12171 * Unset the icon of the bubble
12173 * Unparent and return the icon object which was set for this widget.
12175 * @param obj The bubble object
12176 * @return The icon that was being used
12178 EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12180 * Set the corner of the bubble
12182 * @param obj The bubble object.
12183 * @param corner The given corner for the bubble.
12185 * This function sets the corner of the bubble. The corner will be used to
12186 * determine where the arrow in the frame points to and where label, icon and
12189 * Possible values for corner are:
12190 * @li "top_left" - Default
12192 * @li "bottom_left"
12193 * @li "bottom_right"
12195 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
12197 * Get the corner of the bubble
12199 * @param obj The bubble object.
12200 * @return The given corner for the bubble.
12202 * This function gets the selected corner of the bubble.
12204 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12210 * @defgroup Photo Photo
12212 * For displaying the photo of a person (contact). Simple yet
12213 * with a very specific purpose.
12215 * Signals that you can add callbacks for are:
12217 * "clicked" - This is called when a user has clicked the photo
12218 * "drag,start" - Someone started dragging the image out of the object
12219 * "drag,end" - Dragged item was dropped (somewhere)
12225 * Add a new photo to the parent
12227 * @param parent The parent object
12228 * @return The new object or NULL if it cannot be created
12232 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12235 * Set the file that will be used as photo
12237 * @param obj The photo object
12238 * @param file The path to file that will be used as photo
12240 * @return (1 = success, 0 = error)
12244 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12247 * Set the file that will be used as thumbnail in the photo.
12249 * @param obj The photo object.
12250 * @param file The path to file that will be used as thumb.
12251 * @param group The key used in case of an EET file.
12255 EAPI void elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
12258 * Set the size that will be used on the photo
12260 * @param obj The photo object
12261 * @param size The size that the photo will be
12265 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12268 * Set if the photo should be completely visible or not.
12270 * @param obj The photo object
12271 * @param fill if true the photo will be completely visible
12275 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12278 * Set editability of the photo.
12280 * An editable photo can be dragged to or from, and can be cut or
12281 * pasted too. Note that pasting an image or dropping an item on
12282 * the image will delete the existing content.
12284 * @param obj The photo object.
12285 * @param set To set of clear editablity.
12287 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12293 /* gesture layer */
12295 * @defgroup Elm_Gesture_Layer Gesture Layer
12296 * Gesture Layer Usage:
12298 * Use Gesture Layer to detect gestures.
12299 * The advantage is that you don't have to implement
12300 * gesture detection, just set callbacks of gesture state.
12301 * By using gesture layer we make standard interface.
12303 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12304 * with a parent object parameter.
12305 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12306 * call. Usually with same object as target (2nd parameter).
12308 * Now you need to tell gesture layer what gestures you follow.
12309 * This is done with @ref elm_gesture_layer_cb_set call.
12310 * By setting the callback you actually saying to gesture layer:
12311 * I would like to know when the gesture @ref Elm_Gesture_Types
12312 * switches to state @ref Elm_Gesture_State.
12314 * Next, you need to implement the actual action that follows the input
12315 * in your callback.
12317 * Note that if you like to stop being reported about a gesture, just set
12318 * all callbacks referring this gesture to NULL.
12319 * (again with @ref elm_gesture_layer_cb_set)
12321 * The information reported by gesture layer to your callback is depending
12322 * on @ref Elm_Gesture_Types:
12323 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12324 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12325 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12327 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12328 * @ref ELM_GESTURE_MOMENTUM.
12330 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12331 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12332 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12333 * Note that we consider a flick as a line-gesture that should be completed
12334 * in flick-time-limit as defined in @ref Config.
12336 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12338 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12341 * Gesture Layer Tweaks:
12343 * Note that line, flick, gestures can start without the need to remove fingers from surface.
12344 * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
12346 * Setting glayer_continues_enable to false in @ref Config will change this behavior
12347 * so gesture starts when user touches (a *DOWN event) touch-surface
12348 * and ends when no fingers touches surface (a *UP event).
12352 * @enum _Elm_Gesture_Types
12353 * Enum of supported gesture types.
12354 * @ingroup Elm_Gesture_Layer
12356 enum _Elm_Gesture_Types
12358 ELM_GESTURE_FIRST = 0,
12360 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12361 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12362 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12363 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12365 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12367 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12368 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12370 ELM_GESTURE_ZOOM, /**< Zoom */
12371 ELM_GESTURE_ROTATE, /**< Rotate */
12377 * @typedef Elm_Gesture_Types
12378 * gesture types enum
12379 * @ingroup Elm_Gesture_Layer
12381 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12384 * @enum _Elm_Gesture_State
12385 * Enum of gesture states.
12386 * @ingroup Elm_Gesture_Layer
12388 enum _Elm_Gesture_State
12390 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12391 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
12392 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
12393 ELM_GESTURE_STATE_END, /**< Gesture completed */
12394 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
12398 * @typedef Elm_Gesture_State
12399 * gesture states enum
12400 * @ingroup Elm_Gesture_Layer
12402 typedef enum _Elm_Gesture_State Elm_Gesture_State;
12405 * @struct _Elm_Gesture_Taps_Info
12406 * Struct holds taps info for user
12407 * @ingroup Elm_Gesture_Layer
12409 struct _Elm_Gesture_Taps_Info
12411 Evas_Coord x, y; /**< Holds center point between fingers */
12412 unsigned int n; /**< Number of fingers tapped */
12413 unsigned int timestamp; /**< event timestamp */
12417 * @typedef Elm_Gesture_Taps_Info
12418 * holds taps info for user
12419 * @ingroup Elm_Gesture_Layer
12421 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12424 * @struct _Elm_Gesture_Momentum_Info
12425 * Struct holds momentum info for user
12426 * x1 and y1 are not necessarily in sync
12427 * x1 holds x value of x direction starting point
12428 * and same holds for y1.
12429 * This is noticeable when doing V-shape movement
12430 * @ingroup Elm_Gesture_Layer
12432 struct _Elm_Gesture_Momentum_Info
12433 { /* Report line ends, timestamps, and momentum computed */
12434 Evas_Coord x1; /**< Final-swipe direction starting point on X */
12435 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12436 Evas_Coord x2; /**< Final-swipe direction ending point on X */
12437 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
12439 unsigned int tx; /**< Timestamp of start of final x-swipe */
12440 unsigned int ty; /**< Timestamp of start of final y-swipe */
12442 Evas_Coord mx; /**< Momentum on X */
12443 Evas_Coord my; /**< Momentum on Y */
12447 * @typedef Elm_Gesture_Momentum_Info
12448 * holds momentum info for user
12449 * @ingroup Elm_Gesture_Layer
12451 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12454 * @struct _Elm_Gesture_Line_Info
12455 * Struct holds line info for user
12456 * @ingroup Elm_Gesture_Layer
12458 struct _Elm_Gesture_Line_Info
12459 { /* Report line ends, timestamps, and momentum computed */
12460 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12461 unsigned int n; /**< Number of fingers (lines) */
12462 /* FIXME should be radians, bot degrees */
12463 double angle; /**< Angle (direction) of lines */
12467 * @typedef Elm_Gesture_Line_Info
12468 * Holds line info for user
12469 * @ingroup Elm_Gesture_Layer
12471 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12474 * @struct _Elm_Gesture_Zoom_Info
12475 * Struct holds zoom info for user
12476 * @ingroup Elm_Gesture_Layer
12478 struct _Elm_Gesture_Zoom_Info
12480 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12481 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12482 double zoom; /**< Zoom value: 1.0 means no zoom */
12483 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12487 * @typedef Elm_Gesture_Zoom_Info
12488 * Holds zoom info for user
12489 * @ingroup Elm_Gesture_Layer
12491 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12494 * @struct _Elm_Gesture_Rotate_Info
12495 * Struct holds rotation info for user
12496 * @ingroup Elm_Gesture_Layer
12498 struct _Elm_Gesture_Rotate_Info
12500 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12501 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12502 double base_angle; /**< Holds start-angle */
12503 double angle; /**< Rotation value: 0.0 means no rotation */
12504 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12508 * @typedef Elm_Gesture_Rotate_Info
12509 * Holds rotation info for user
12510 * @ingroup Elm_Gesture_Layer
12512 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12515 * @typedef Elm_Gesture_Event_Cb
12516 * User callback used to stream gesture info from gesture layer
12517 * @param data user data
12518 * @param event_info gesture report info
12519 * Returns a flag field to be applied on the causing event.
12520 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12521 * upon the event, in an irreversible way.
12523 * @ingroup Elm_Gesture_Layer
12525 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12528 * Use function to set callbacks to be notified about
12529 * change of state of gesture.
12530 * When a user registers a callback with this function
12531 * this means this gesture has to be tested.
12533 * When ALL callbacks for a gesture are set to NULL
12534 * it means user isn't interested in gesture-state
12535 * and it will not be tested.
12537 * @param obj Pointer to gesture-layer.
12538 * @param idx The gesture you would like to track its state.
12539 * @param cb callback function pointer.
12540 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
12541 * @param data user info to be sent to callback (usually, Smart Data)
12543 * @ingroup Elm_Gesture_Layer
12545 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);
12548 * Call this function to get repeat-events settings.
12550 * @param obj Pointer to gesture-layer.
12552 * @return repeat events settings.
12553 * @see elm_gesture_layer_hold_events_set()
12554 * @ingroup Elm_Gesture_Layer
12556 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12559 * This function called in order to make gesture-layer repeat events.
12560 * Set this of you like to get the raw events only if gestures were not detected.
12561 * Clear this if you like gesture layer to fwd events as testing gestures.
12563 * @param obj Pointer to gesture-layer.
12564 * @param r Repeat: TRUE/FALSE
12566 * @ingroup Elm_Gesture_Layer
12568 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
12571 * This function sets step-value for zoom action.
12572 * Set step to any positive value.
12573 * Cancel step setting by setting to 0.0
12575 * @param obj Pointer to gesture-layer.
12576 * @param s new zoom step value.
12578 * @ingroup Elm_Gesture_Layer
12580 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12583 * This function sets step-value for rotate action.
12584 * Set step to any positive value.
12585 * Cancel step setting by setting to 0.0
12587 * @param obj Pointer to gesture-layer.
12588 * @param s new roatate step value.
12590 * @ingroup Elm_Gesture_Layer
12592 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12595 * This function called to attach gesture-layer to an Evas_Object.
12596 * @param obj Pointer to gesture-layer.
12597 * @param t Pointer to underlying object (AKA Target)
12599 * @return TRUE, FALSE on success, failure.
12601 * @ingroup Elm_Gesture_Layer
12603 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
12606 * Call this function to construct a new gesture-layer object.
12607 * This does not activate the gesture layer. You have to
12608 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
12610 * @param parent the parent object.
12612 * @return Pointer to new gesture-layer object.
12614 * @ingroup Elm_Gesture_Layer
12616 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12619 * @defgroup Thumb Thumb
12621 * @image html img/widget/thumb/preview-00.png
12622 * @image latex img/widget/thumb/preview-00.eps
12624 * A thumb object is used for displaying the thumbnail of an image or video.
12625 * You must have compiled Elementary with Ethumb_Client support and the DBus
12626 * service must be present and auto-activated in order to have thumbnails to
12629 * Once the thumbnail object becomes visible, it will check if there is a
12630 * previously generated thumbnail image for the file set on it. If not, it
12631 * will start generating this thumbnail.
12633 * Different config settings will cause different thumbnails to be generated
12634 * even on the same file.
12636 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
12637 * Ethumb documentation to change this path, and to see other configuration
12640 * Signals that you can add callbacks for are:
12642 * - "clicked" - This is called when a user has clicked the thumb without dragging
12644 * - "clicked,double" - This is called when a user has double-clicked the thumb.
12645 * - "press" - This is called when a user has pressed down the thumb.
12646 * - "generate,start" - The thumbnail generation started.
12647 * - "generate,stop" - The generation process stopped.
12648 * - "generate,error" - The generation failed.
12649 * - "load,error" - The thumbnail image loading failed.
12651 * available styles:
12655 * An example of use of thumbnail:
12657 * - @ref thumb_example_01
12661 * @addtogroup Thumb
12666 * @enum _Elm_Thumb_Animation_Setting
12667 * @typedef Elm_Thumb_Animation_Setting
12669 * Used to set if a video thumbnail is animating or not.
12673 typedef enum _Elm_Thumb_Animation_Setting
12675 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
12676 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
12677 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
12678 ELM_THUMB_ANIMATION_LAST
12679 } Elm_Thumb_Animation_Setting;
12682 * Add a new thumb object to the parent.
12684 * @param parent The parent object.
12685 * @return The new object or NULL if it cannot be created.
12687 * @see elm_thumb_file_set()
12688 * @see elm_thumb_ethumb_client_get()
12692 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12694 * Reload thumbnail if it was generated before.
12696 * @param obj The thumb object to reload
12698 * This is useful if the ethumb client configuration changed, like its
12699 * size, aspect or any other property one set in the handle returned
12700 * by elm_thumb_ethumb_client_get().
12702 * If the options didn't change, the thumbnail won't be generated again, but
12703 * the old one will still be used.
12705 * @see elm_thumb_file_set()
12709 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
12711 * Set the file that will be used as thumbnail.
12713 * @param obj The thumb object.
12714 * @param file The path to file that will be used as thumb.
12715 * @param key The key used in case of an EET file.
12717 * The file can be an image or a video (in that case, acceptable extensions are:
12718 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
12719 * function elm_thumb_animate().
12721 * @see elm_thumb_file_get()
12722 * @see elm_thumb_reload()
12723 * @see elm_thumb_animate()
12727 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
12729 * Get the image or video path and key used to generate the thumbnail.
12731 * @param obj The thumb object.
12732 * @param file Pointer to filename.
12733 * @param key Pointer to key.
12735 * @see elm_thumb_file_set()
12736 * @see elm_thumb_path_get()
12740 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12742 * Get the path and key to the image or video generated by ethumb.
12744 * One just need to make sure that the thumbnail was generated before getting
12745 * its path; otherwise, the path will be NULL. One way to do that is by asking
12746 * for the path when/after the "generate,stop" smart callback is called.
12748 * @param obj The thumb object.
12749 * @param file Pointer to thumb path.
12750 * @param key Pointer to thumb key.
12752 * @see elm_thumb_file_get()
12756 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12758 * Set the animation state for the thumb object. If its content is an animated
12759 * video, you may start/stop the animation or tell it to play continuously and
12762 * @param obj The thumb object.
12763 * @param setting The animation setting.
12765 * @see elm_thumb_file_set()
12769 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
12771 * Get the animation state for the thumb object.
12773 * @param obj The thumb object.
12774 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
12777 * @see elm_thumb_animate_set()
12781 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12783 * Get the ethumb_client handle so custom configuration can be made.
12785 * @return Ethumb_Client instance or NULL.
12787 * This must be called before the objects are created to be sure no object is
12788 * visible and no generation started.
12790 * Example of usage:
12793 * #include <Elementary.h>
12794 * #ifndef ELM_LIB_QUICKLAUNCH
12796 * elm_main(int argc, char **argv)
12798 * Ethumb_Client *client;
12800 * elm_need_ethumb();
12804 * client = elm_thumb_ethumb_client_get();
12807 * ERR("could not get ethumb_client");
12810 * ethumb_client_size_set(client, 100, 100);
12811 * ethumb_client_crop_align_set(client, 0.5, 0.5);
12814 * // Create elm_thumb objects here
12824 * @note There's only one client handle for Ethumb, so once a configuration
12825 * change is done to it, any other request for thumbnails (for any thumbnail
12826 * object) will use that configuration. Thus, this configuration is global.
12830 EAPI void *elm_thumb_ethumb_client_get(void);
12832 * Get the ethumb_client connection state.
12834 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
12837 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
12839 * Make the thumbnail 'editable'.
12841 * @param obj Thumb object.
12842 * @param set Turn on or off editability. Default is @c EINA_FALSE.
12844 * This means the thumbnail is a valid drag target for drag and drop, and can be
12845 * cut or pasted too.
12847 * @see elm_thumb_editable_get()
12851 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
12853 * Make the thumbnail 'editable'.
12855 * @param obj Thumb object.
12856 * @return Editability.
12858 * This means the thumbnail is a valid drag target for drag and drop, and can be
12859 * cut or pasted too.
12861 * @see elm_thumb_editable_set()
12865 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12872 * @defgroup Web Web
12874 * @image html img/widget/web/preview-00.png
12875 * @image latex img/widget/web/preview-00.eps
12877 * A web object is used for displaying web pages (HTML/CSS/JS)
12878 * using WebKit-EFL. You must have compiled Elementary with
12881 * Signals that you can add callbacks for are:
12882 * @li "download,request": A file download has been requested. Event info is
12883 * a pointer to a Elm_Web_Download
12884 * @li "editorclient,contents,changed": Editor client's contents changed
12885 * @li "editorclient,selection,changed": Editor client's selection changed
12886 * @li "frame,created": A new frame was created. Event info is an
12887 * Evas_Object which can be handled with WebKit's ewk_frame API
12888 * @li "icon,received": An icon was received by the main frame
12889 * @li "inputmethod,changed": Input method changed. Event info is an
12890 * Eina_Bool indicating whether it's enabled or not
12891 * @li "js,windowobject,clear": JS window object has been cleared
12892 * @li "link,hover,in": Mouse cursor is hovering over a link. Event info
12893 * is a char *link[2], where the first string contains the URL the link
12894 * points to, and the second one the title of the link
12895 * @li "link,hover,out": Mouse cursor left the link
12896 * @li "load,document,finished": Loading of a document finished. Event info
12897 * is the frame that finished loading
12898 * @li "load,error": Load failed. Event info is a pointer to
12899 * Elm_Web_Frame_Load_Error
12900 * @li "load,finished": Load finished. Event info is NULL on success, on
12901 * error it's a pointer to Elm_Web_Frame_Load_Error
12902 * @li "load,newwindow,show": A new window was created and is ready to be
12904 * @li "load,progress": Overall load progress. Event info is a pointer to
12905 * a double containing a value between 0.0 and 1.0
12906 * @li "load,provisional": Started provisional load
12907 * @li "load,started": Loading of a document started
12908 * @li "menubar,visible,get": Queries if the menubar is visible. Event info
12909 * is a pointer to Eina_Bool where the callback should set EINA_TRUE if
12910 * the menubar is visible, or EINA_FALSE in case it's not
12911 * @li "menubar,visible,set": Informs menubar visibility. Event info is
12912 * an Eina_Bool indicating the visibility
12913 * @li "popup,created": A dropdown widget was activated, requesting its
12914 * popup menu to be created. Event info is a pointer to Elm_Web_Menu
12915 * @li "popup,willdelete": The web object is ready to destroy the popup
12916 * object created. Event info is a pointer to Elm_Web_Menu
12917 * @li "ready": Page is fully loaded
12918 * @li "scrollbars,visible,get": Queries visibility of scrollbars. Event
12919 * info is a pointer to Eina_Bool where the visibility state should be set
12920 * @li "scrollbars,visible,set": Informs scrollbars visibility. Event info
12921 * is an Eina_Bool with the visibility state set
12922 * @li "statusbar,text,set": Text of the statusbar changed. Even info is
12923 * a string with the new text
12924 * @li "statusbar,visible,get": Queries visibility of the status bar.
12925 * Event info is a pointer to Eina_Bool where the visibility state should be
12927 * @li "statusbar,visible,set": Informs statusbar visibility. Event info is
12928 * an Eina_Bool with the visibility value
12929 * @li "title,changed": Title of the main frame changed. Event info is a
12930 * string with the new title
12931 * @li "toolbars,visible,get": Queries visibility of toolbars. Event info
12932 * is a pointer to Eina_Bool where the visibility state should be set
12933 * @li "toolbars,visible,set": Informs the visibility of toolbars. Event
12934 * info is an Eina_Bool with the visibility state
12935 * @li "tooltip,text,set": Show and set text of a tooltip. Event info is
12936 * a string with the text to show
12937 * @li "uri,changed": URI of the main frame changed. Event info is a string
12939 * @li "view,resized": The web object internal's view changed sized
12940 * @li "windows,close,request": A JavaScript request to close the current
12941 * window was requested
12942 * @li "zoom,animated,end": Animated zoom finished
12944 * available styles:
12947 * An example of use of web:
12949 * - @ref web_example_01 TBD
12958 * Structure used to report load errors.
12960 * Load errors are reported as signal by elm_web. All the strings are
12961 * temporary references and should @b not be used after the signal
12962 * callback returns. If it's required, make copies with strdup() or
12963 * eina_stringshare_add() (they are not even guaranteed to be
12964 * stringshared, so must use eina_stringshare_add() and not
12965 * eina_stringshare_ref()).
12967 typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
12969 * Structure used to report load errors.
12971 * Load errors are reported as signal by elm_web. All the strings are
12972 * temporary references and should @b not be used after the signal
12973 * callback returns. If it's required, make copies with strdup() or
12974 * eina_stringshare_add() (they are not even guaranteed to be
12975 * stringshared, so must use eina_stringshare_add() and not
12976 * eina_stringshare_ref()).
12978 struct _Elm_Web_Frame_Load_Error
12980 int code; /**< Numeric error code */
12981 Eina_Bool is_cancellation; /**< Error produced by cancelling a request */
12982 const char *domain; /**< Error domain name */
12983 const char *description; /**< Error description (already localized) */
12984 const char *failing_url; /**< The URL that failed to load */
12985 Evas_Object *frame; /**< Frame object that produced the error */
12989 * The possibles types that the items in a menu can be
12991 typedef enum _Elm_Web_Menu_Item_Type
12993 ELM_WEB_MENU_SEPARATOR,
12994 ELM_WEB_MENU_GROUP,
12995 ELM_WEB_MENU_OPTION
12996 } Elm_Web_Menu_Item_Type;
12999 * Structure describing the items in a menu
13001 typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item;
13003 * Structure describing the items in a menu
13005 struct _Elm_Web_Menu_Item
13007 const char *text; /**< The text for the item */
13008 Elm_Web_Menu_Item_Type type; /**< The type of the item */
13012 * Structure describing the menu of a popup
13014 * This structure will be passed as the @c event_info for the "popup,create"
13015 * signal, which is emitted when a dropdown menu is opened. Users wanting
13016 * to handle these popups by themselves should listen to this signal and
13017 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13018 * property as @c EINA_FALSE means that the user will not handle the popup
13019 * and the default implementation will be used.
13021 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13022 * will be emitted to notify the user that it can destroy any objects and
13023 * free all data related to it.
13025 * @see elm_web_popup_selected_set()
13026 * @see elm_web_popup_destroy()
13028 typedef struct _Elm_Web_Menu Elm_Web_Menu;
13030 * Structure describing the menu of a popup
13032 * This structure will be passed as the @c event_info for the "popup,create"
13033 * signal, which is emitted when a dropdown menu is opened. Users wanting
13034 * to handle these popups by themselves should listen to this signal and
13035 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13036 * property as @c EINA_FALSE means that the user will not handle the popup
13037 * and the default implementation will be used.
13039 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13040 * will be emitted to notify the user that it can destroy any objects and
13041 * free all data related to it.
13043 * @see elm_web_popup_selected_set()
13044 * @see elm_web_popup_destroy()
13046 struct _Elm_Web_Menu
13048 Eina_List *items; /**< List of #Elm_Web_Menu_Item */
13049 int x; /**< The X position of the popup, relative to the elm_web object */
13050 int y; /**< The Y position of the popup, relative to the elm_web object */
13051 int width; /**< Width of the popup menu */
13052 int height; /**< Height of the popup menu */
13054 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. */
13057 typedef struct _Elm_Web_Download Elm_Web_Download;
13058 struct _Elm_Web_Download
13064 * Types of zoom available.
13066 typedef enum _Elm_Web_Zoom_Mode
13068 ELM_WEB_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_web_zoom_set */
13069 ELM_WEB_ZOOM_MODE_AUTO_FIT, /**< Zoom until content fits in web object */
13070 ELM_WEB_ZOOM_MODE_AUTO_FILL, /**< Zoom until content fills web object */
13071 ELM_WEB_ZOOM_MODE_LAST
13072 } Elm_Web_Zoom_Mode;
13074 * Opaque handler containing the features (such as statusbar, menubar, etc)
13075 * that are to be set on a newly requested window.
13077 typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
13079 * Callback type for the create_window hook.
13081 * The function parameters are:
13082 * @li @p data User data pointer set when setting the hook function
13083 * @li @p obj The elm_web object requesting the new window
13084 * @li @p js Set to @c EINA_TRUE if the request was originated from
13085 * JavaScript. @c EINA_FALSE otherwise.
13086 * @li @p window_features A pointer of #Elm_Web_Window_Features indicating
13087 * the features requested for the new window.
13089 * The returned value of the function should be the @c elm_web widget where
13090 * the request will be loaded. That is, if a new window or tab is created,
13091 * the elm_web widget in it should be returned, and @b NOT the window
13093 * Returning @c NULL should cancel the request.
13095 * @see elm_web_window_create_hook_set()
13097 typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
13099 * Callback type for the JS alert hook.
13101 * The function parameters are:
13102 * @li @p data User data pointer set when setting the hook function
13103 * @li @p obj The elm_web object requesting the new window
13104 * @li @p message The message to show in the alert dialog
13106 * The function should return the object representing the alert dialog.
13107 * Elm_Web will run a second main loop to handle the dialog and normal
13108 * flow of the application will be restored when the object is deleted, so
13109 * the user should handle the popup properly in order to delete the object
13110 * when the action is finished.
13111 * If the function returns @c NULL the popup will be ignored.
13113 * @see elm_web_dialog_alert_hook_set()
13115 typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
13117 * Callback type for the JS confirm hook.
13119 * The function parameters are:
13120 * @li @p data User data pointer set when setting the hook function
13121 * @li @p obj The elm_web object requesting the new window
13122 * @li @p message The message to show in the confirm dialog
13123 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13124 * the user selected @c Ok, @c EINA_FALSE otherwise.
13126 * The function should return the object representing the confirm dialog.
13127 * Elm_Web will run a second main loop to handle the dialog and normal
13128 * flow of the application will be restored when the object is deleted, so
13129 * the user should handle the popup properly in order to delete the object
13130 * when the action is finished.
13131 * If the function returns @c NULL the popup will be ignored.
13133 * @see elm_web_dialog_confirm_hook_set()
13135 typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
13137 * Callback type for the JS prompt hook.
13139 * The function parameters are:
13140 * @li @p data User data pointer set when setting the hook function
13141 * @li @p obj The elm_web object requesting the new window
13142 * @li @p message The message to show in the prompt dialog
13143 * @li @p def_value The default value to present the user in the entry
13144 * @li @p value Pointer where to store the value given by the user. Must
13145 * be a malloc'ed string or @c NULL if the user cancelled the popup.
13146 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13147 * the user selected @c Ok, @c EINA_FALSE otherwise.
13149 * The function should return the object representing the prompt dialog.
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_prompt_hook_set()
13158 typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret);
13160 * Callback type for the JS file selector hook.
13162 * The function parameters are:
13163 * @li @p data User data pointer set when setting the hook function
13164 * @li @p obj The elm_web object requesting the new window
13165 * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
13166 * @li @p accept_types Mime types accepted
13167 * @li @p selected Pointer where to store the list of malloc'ed strings
13168 * containing the path to each file selected. Must be @c NULL if the file
13169 * dialog is cancelled
13170 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13171 * the user selected @c Ok, @c EINA_FALSE otherwise.
13173 * The function should return the object representing the file selector
13175 * Elm_Web will run a second main loop to handle the dialog and normal
13176 * flow of the application will be restored when the object is deleted, so
13177 * the user should handle the popup properly in order to delete the object
13178 * when the action is finished.
13179 * If the function returns @c NULL the popup will be ignored.
13181 * @see elm_web_dialog_file selector_hook_set()
13183 typedef Evas_Object *(*Elm_Web_Dialog_File_Selector)(void *data, Evas_Object *obj, Eina_Bool allows_multiple, const char *accept_types, Eina_List **selected, Eina_Bool *ret);
13185 * Callback type for the JS console message hook.
13187 * When a console message is added from JavaScript, any set function to the
13188 * console message hook will be called for the user to handle. There is no
13189 * default implementation of this hook.
13191 * The function parameters are:
13192 * @li @p data User data pointer set when setting the hook function
13193 * @li @p obj The elm_web object that originated the message
13194 * @li @p message The message sent
13195 * @li @p line_number The line number
13196 * @li @p source_id Source id
13198 * @see elm_web_console_message_hook_set()
13200 typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
13202 * Add a new web object to the parent.
13204 * @param parent The parent object.
13205 * @return The new object or NULL if it cannot be created.
13207 * @see elm_web_uri_set()
13208 * @see elm_web_webkit_view_get()
13210 EAPI Evas_Object *elm_web_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13213 * Get internal ewk_view object from web object.
13215 * Elementary may not provide some low level features of EWebKit,
13216 * instead of cluttering the API with proxy methods we opted to
13217 * return the internal reference. Be careful using it as it may
13218 * interfere with elm_web behavior.
13220 * @param obj The web object.
13221 * @return The internal ewk_view object or NULL if it does not
13222 * exist. (Failure to create or Elementary compiled without
13225 * @see elm_web_add()
13227 EAPI Evas_Object *elm_web_webkit_view_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13230 * Sets the function to call when a new window is requested
13232 * This hook will be called when a request to create a new window is
13233 * issued from the web page loaded.
13234 * There is no default implementation for this feature, so leaving this
13235 * unset or passing @c NULL in @p func will prevent new windows from
13238 * @param obj The web object where to set the hook function
13239 * @param func The hook function to be called when a window is requested
13240 * @param data User data
13242 EAPI void elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data);
13244 * Sets the function to call when an alert dialog
13246 * This hook will be called when a JavaScript alert dialog is requested.
13247 * If no function is set or @c NULL is passed in @p func, the default
13248 * implementation will take place.
13250 * @param obj The web object where to set the hook function
13251 * @param func The callback function to be used
13252 * @param data User data
13254 * @see elm_web_inwin_mode_set()
13256 EAPI void elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data);
13258 * Sets the function to call when an confirm dialog
13260 * This hook will be called when a JavaScript confirm dialog is requested.
13261 * If no function is set or @c NULL is passed in @p func, the default
13262 * implementation will take place.
13264 * @param obj The web object where to set the hook function
13265 * @param func The callback function to be used
13266 * @param data User data
13268 * @see elm_web_inwin_mode_set()
13270 EAPI void elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data);
13272 * Sets the function to call when an prompt dialog
13274 * This hook will be called when a JavaScript prompt dialog is requested.
13275 * If no function is set or @c NULL is passed in @p func, the default
13276 * implementation will take place.
13278 * @param obj The web object where to set the hook function
13279 * @param func The callback function to be used
13280 * @param data User data
13282 * @see elm_web_inwin_mode_set()
13284 EAPI void elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data);
13286 * Sets the function to call when an file selector dialog
13288 * This hook will be called when a JavaScript file selector dialog is
13290 * If no function is set or @c NULL is passed in @p func, the default
13291 * implementation will take place.
13293 * @param obj The web object where to set the hook function
13294 * @param func The callback function to be used
13295 * @param data User data
13297 * @see elm_web_inwin_mode_set()
13299 EAPI void elm_web_dialog_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data);
13301 * Sets the function to call when a console message is emitted from JS
13303 * This hook will be called when a console message is emitted from
13304 * JavaScript. There is no default implementation for this feature.
13306 * @param obj The web object where to set the hook function
13307 * @param func The callback function to be used
13308 * @param data User data
13310 EAPI void elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data);
13312 * Gets the status of the tab propagation
13314 * @param obj The web object to query
13315 * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
13317 * @see elm_web_tab_propagate_set()
13319 EAPI Eina_Bool elm_web_tab_propagate_get(const Evas_Object *obj);
13321 * Sets whether to use tab propagation
13323 * If tab propagation is enabled, whenever the user presses the Tab key,
13324 * Elementary will handle it and switch focus to the next widget.
13325 * The default value is disabled, where WebKit will handle the Tab key to
13326 * cycle focus though its internal objects, jumping to the next widget
13327 * only when that cycle ends.
13329 * @param obj The web object
13330 * @param propagate Whether to propagate Tab keys to Elementary or not
13332 EAPI void elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate);
13334 * Sets the URI for the web object
13336 * It must be a full URI, with resource included, in the form
13337 * http://www.enlightenment.org or file:///tmp/something.html
13339 * @param obj The web object
13340 * @param uri The URI to set
13341 * @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
13343 EAPI Eina_Bool elm_web_uri_set(Evas_Object *obj, const char *uri);
13345 * Gets the current URI for the object
13347 * The returned string must not be freed and is guaranteed to be
13350 * @param obj The web object
13351 * @return A stringshared internal string with the current URI, or NULL on
13354 EAPI const char *elm_web_uri_get(const Evas_Object *obj);
13356 * Gets the current title
13358 * The returned string must not be freed and is guaranteed to be
13361 * @param obj The web object
13362 * @return A stringshared internal string with the current title, or NULL on
13365 EAPI const char *elm_web_title_get(const Evas_Object *obj);
13367 * Sets the background color to be used by the web object
13369 * This is the color that will be used by default when the loaded page
13370 * does not set it's own. Color values are pre-multiplied.
13372 * @param obj The web object
13373 * @param r Red component
13374 * @param g Green component
13375 * @param b Blue component
13376 * @param a Alpha component
13378 EAPI void elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a);
13380 * Gets the background color to be used by the web object
13382 * This is the color that will be used by default when the loaded page
13383 * does not set it's own. Color values are pre-multiplied.
13385 * @param obj The web object
13386 * @param r Red component
13387 * @param g Green component
13388 * @param b Blue component
13389 * @param a Alpha component
13391 EAPI void elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
13393 * Gets a copy of the currently selected text
13395 * The string returned must be freed by the user when it's done with it.
13397 * @param obj The web object
13398 * @return A newly allocated string, or NULL if nothing is selected or an
13401 EAPI char *elm_view_selection_get(const Evas_Object *obj);
13403 * Tells the web object which index in the currently open popup was selected
13405 * When the user handles the popup creation from the "popup,created" signal,
13406 * it needs to tell the web object which item was selected by calling this
13407 * function with the index corresponding to the item.
13409 * @param obj The web object
13410 * @param index The index selected
13412 * @see elm_web_popup_destroy()
13414 EAPI void elm_web_popup_selected_set(Evas_Object *obj, int index);
13416 * Dismisses an open dropdown popup
13418 * When the popup from a dropdown widget is to be dismissed, either after
13419 * selecting an option or to cancel it, this function must be called, which
13420 * will later emit an "popup,willdelete" signal to notify the user that
13421 * any memory and objects related to this popup can be freed.
13423 * @param obj The web object
13424 * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE
13425 * if there was no menu to destroy
13427 EAPI Eina_Bool elm_web_popup_destroy(Evas_Object *obj);
13429 * Searches the given string in a document.
13431 * @param obj The web object where to search the text
13432 * @param string String to search
13433 * @param case_sensitive If search should be case sensitive or not
13434 * @param forward If search is from cursor and on or backwards
13435 * @param wrap If search should wrap at the end
13437 * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not
13440 EAPI Eina_Bool elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
13442 * Marks matches of the given string in a document.
13444 * @param obj The web object where to search text
13445 * @param string String to match
13446 * @param case_sensitive If match should be case sensitive or not
13447 * @param highlight If matches should be highlighted
13448 * @param limit Maximum amount of matches, or zero to unlimited
13450 * @return number of matched @a string
13452 EAPI unsigned int elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
13454 * Clears all marked matches in the document
13456 * @param obj The web object
13458 * @return EINA_TRUE on success, EINA_FALSE otherwise
13460 EAPI Eina_Bool elm_web_text_matches_unmark_all(Evas_Object *obj);
13462 * Sets whether to highlight the matched marks
13464 * If enabled, marks set with elm_web_text_matches_mark() will be
13467 * @param obj The web object
13468 * @param highlight Whether to highlight the marks or not
13470 * @return EINA_TRUE on success, EINA_FALSE otherwise
13472 EAPI Eina_Bool elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight);
13474 * Gets whether highlighting marks is enabled
13476 * @param The web object
13478 * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
13481 EAPI Eina_Bool elm_web_text_matches_highlight_get(const Evas_Object *obj);
13483 * Gets the overall loading progress of the page
13485 * Returns the estimated loading progress of the page, with a value between
13486 * 0.0 and 1.0. This is an estimated progress accounting for all the frames
13487 * included in the page.
13489 * @param The web object
13491 * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
13494 EAPI double elm_web_load_progress_get(const Evas_Object *obj);
13496 * Stops loading the current page
13498 * Cancels the loading of the current page in the web object. This will
13499 * cause a "load,error" signal to be emitted, with the is_cancellation
13500 * flag set to EINA_TRUE.
13502 * @param obj The web object
13504 * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
13506 EAPI Eina_Bool elm_web_stop(Evas_Object *obj);
13508 * Requests a reload of the current document in the object
13510 * @param obj The web object
13512 * @return EINA_TRUE on success, EINA_FALSE otherwise
13514 EAPI Eina_Bool elm_web_reload(Evas_Object *obj);
13516 * Requests a reload of the current document, avoiding any existing caches
13518 * @param obj The web object
13520 * @return EINA_TRUE on success, EINA_FALSE otherwise
13522 EAPI Eina_Bool elm_web_reload_full(Evas_Object *obj);
13524 * Goes back one step in the browsing history
13526 * This is equivalent to calling elm_web_object_navigate(obj, -1);
13528 * @param obj The web object
13530 * @return EINA_TRUE on success, EINA_FALSE otherwise
13532 * @see elm_web_history_enable_set()
13533 * @see elm_web_back_possible()
13534 * @see elm_web_forward()
13535 * @see elm_web_navigate()
13537 EAPI Eina_Bool elm_web_back(Evas_Object *obj);
13539 * Goes forward one step in the browsing history
13541 * This is equivalent to calling elm_web_object_navigate(obj, 1);
13543 * @param obj The web object
13545 * @return EINA_TRUE on success, EINA_FALSE otherwise
13547 * @see elm_web_history_enable_set()
13548 * @see elm_web_forward_possible()
13549 * @see elm_web_back()
13550 * @see elm_web_navigate()
13552 EAPI Eina_Bool elm_web_forward(Evas_Object *obj);
13554 * Jumps the given number of steps in the browsing history
13556 * The @p steps value can be a negative integer to back in history, or a
13557 * positive to move forward.
13559 * @param obj The web object
13560 * @param steps The number of steps to jump
13562 * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
13563 * history exists to jump the given number of steps
13565 * @see elm_web_history_enable_set()
13566 * @see elm_web_navigate_possible()
13567 * @see elm_web_back()
13568 * @see elm_web_forward()
13570 EAPI Eina_Bool elm_web_navigate(Evas_Object *obj, int steps);
13572 * Queries whether it's possible to go back in history
13574 * @param obj The web object
13576 * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
13579 EAPI Eina_Bool elm_web_back_possible(Evas_Object *obj);
13581 * Queries whether it's possible to go forward in history
13583 * @param obj The web object
13585 * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
13588 EAPI Eina_Bool elm_web_forward_possible(Evas_Object *obj);
13590 * Queries whether it's possible to jump the given number of steps
13592 * The @p steps value can be a negative integer to back in history, or a
13593 * positive to move forward.
13595 * @param obj The web object
13596 * @param steps The number of steps to check for
13598 * @return EINA_TRUE if enough history exists to perform the given jump,
13599 * EINA_FALSE otherwise
13601 EAPI Eina_Bool elm_web_navigate_possible(Evas_Object *obj, int steps);
13603 * Gets whether browsing history is enabled for the given object
13605 * @param obj The web object
13607 * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
13609 EAPI Eina_Bool elm_web_history_enable_get(const Evas_Object *obj);
13611 * Enables or disables the browsing history
13613 * @param obj The web object
13614 * @param enable Whether to enable or disable the browsing history
13616 EAPI void elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
13618 * Sets the zoom level of the web object
13620 * Zoom level matches the Webkit API, so 1.0 means normal zoom, with higher
13621 * values meaning zoom in and lower meaning zoom out. This function will
13622 * only affect the zoom level if the mode set with elm_web_zoom_mode_set()
13623 * is ::ELM_WEB_ZOOM_MODE_MANUAL.
13625 * @param obj The web object
13626 * @param zoom The zoom level to set
13628 EAPI void elm_web_zoom_set(Evas_Object *obj, double zoom);
13630 * Gets the current zoom level set on the web object
13632 * Note that this is the zoom level set on the web object and not that
13633 * of the underlying Webkit one. In the ::ELM_WEB_ZOOM_MODE_MANUAL mode,
13634 * the two zoom levels should match, but for the other two modes the
13635 * Webkit zoom is calculated internally to match the chosen mode without
13636 * changing the zoom level set for the web object.
13638 * @param obj The web object
13640 * @return The zoom level set on the object
13642 EAPI double elm_web_zoom_get(const Evas_Object *obj);
13644 * Sets the zoom mode to use
13646 * The modes can be any of those defined in ::Elm_Web_Zoom_Mode, except
13647 * ::ELM_WEB_ZOOM_MODE_LAST. The default is ::ELM_WEB_ZOOM_MODE_MANUAL.
13649 * ::ELM_WEB_ZOOM_MODE_MANUAL means the zoom level will be controlled
13650 * with the elm_web_zoom_set() function.
13651 * ::ELM_WEB_ZOOM_MODE_AUTO_FIT will calculate the needed zoom level to
13652 * make sure the entirety of the web object's contents are shown.
13653 * ::ELM_WEB_ZOOM_MODE_AUTO_FILL will calculate the needed zoom level to
13654 * fit the contents in the web object's size, without leaving any space
13657 * @param obj The web object
13658 * @param mode The mode to set
13660 EAPI void elm_web_zoom_mode_set(Evas_Object *obj, Elm_Web_Zoom_Mode mode);
13662 * Gets the currently set zoom mode
13664 * @param obj The web object
13666 * @return The current zoom mode set for the object, or
13667 * ::ELM_WEB_ZOOM_MODE_LAST on error
13669 EAPI Elm_Web_Zoom_Mode elm_web_zoom_mode_get(const Evas_Object *obj);
13671 * Gets whether text-only zoom is set
13673 * @param obj The web object
13675 * @return EINA_TRUE if zoom is set to affect only text, EINA_FALSE
13678 * @see elm_web_zoom_text_only_set()
13680 EAPI Eina_Bool elm_web_zoom_text_only_get(const Evas_Object *obj);
13682 * Enables or disables zoom to affect only text
13684 * If set, then the zoom level set to the page will only be applied on text,
13685 * leaving other objects, such as images, at their original size.
13687 * @param obj The web object
13688 * @param setting EINA_TRUE to use text-only zoom, EINA_FALSE to have zoom
13689 * affect the entire page
13691 EAPI void elm_web_zoom_text_only_set(Evas_Object *obj, Eina_Bool setting);
13693 * Shows the given region in the web object
13695 * @param obj The web object
13696 * @param x The x coordinate of the region to show
13697 * @param y The y coordinate of the region to show
13698 * @param w The width of the region to show
13699 * @param h The height of the region to show
13701 EAPI void elm_web_region_show(Evas_Object *obj, int x, int y, int w, int h);
13703 * Brings in the region to the visible area
13705 * Like elm_web_region_show(), but it animates the scrolling of the object
13708 * @param obj The web object
13709 * @param x The x coordinate of the region to show
13710 * @param y The y coordinate of the region to show
13711 * @param w The width of the region to show
13712 * @param h The height of the region to show
13714 EAPI void elm_web_region_bring_in(Evas_Object *obj, int x, int y, int w, int h);
13716 * Sets the default dialogs to use an Inwin instead of a normal window
13718 * If set, then the default implementation for the JavaScript dialogs and
13719 * file selector will be opened in an Inwin. Otherwise they will use a
13720 * normal separated window.
13722 * @param obj The web object
13723 * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
13725 EAPI void elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
13727 * Gets whether Inwin mode is set for the current object
13729 * @param obj The web object
13731 * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
13733 EAPI Eina_Bool elm_web_inwin_mode_get(const Evas_Object *obj);
13735 EAPI void elm_web_window_features_ref(Elm_Web_Window_Features *wf);
13736 EAPI void elm_web_window_features_unref(Elm_Web_Window_Features *wf);
13737 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);
13738 EAPI void elm_web_window_features_int_property_get(const Elm_Web_Window_Features *wf, int *x, int *y, int *w, int *h);
13745 * @defgroup Hoversel Hoversel
13747 * @image html img/widget/hoversel/preview-00.png
13748 * @image latex img/widget/hoversel/preview-00.eps
13750 * A hoversel is a button that pops up a list of items (automatically
13751 * choosing the direction to display) that have a label and, optionally, an
13752 * icon to select from. It is a convenience widget to avoid the need to do
13753 * all the piecing together yourself. It is intended for a small number of
13754 * items in the hoversel menu (no more than 8), though is capable of many
13757 * Signals that you can add callbacks for are:
13758 * "clicked" - the user clicked the hoversel button and popped up the sel
13759 * "selected" - an item in the hoversel list is selected. event_info is the item
13760 * "dismissed" - the hover is dismissed
13762 * See @ref tutorial_hoversel for an example.
13765 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
13767 * @brief Add a new Hoversel object
13769 * @param parent The parent object
13770 * @return The new object or NULL if it cannot be created
13772 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13774 * @brief This sets the hoversel to expand horizontally.
13776 * @param obj The hoversel object
13777 * @param horizontal If true, the hover will expand horizontally to the
13780 * @note The initial button will display horizontally regardless of this
13783 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
13785 * @brief This returns whether the hoversel is set to expand horizontally.
13787 * @param obj The hoversel object
13788 * @return If true, the hover will expand horizontally to the right.
13790 * @see elm_hoversel_horizontal_set()
13792 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13794 * @brief Set the Hover parent
13796 * @param obj The hoversel object
13797 * @param parent The parent to use
13799 * Sets the hover parent object, the area that will be darkened when the
13800 * hoversel is clicked. Should probably be the window that the hoversel is
13801 * in. See @ref Hover objects for more information.
13803 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
13805 * @brief Get the Hover parent
13807 * @param obj The hoversel object
13808 * @return The used parent
13810 * Gets the hover parent object.
13812 * @see elm_hoversel_hover_parent_set()
13814 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13816 * @brief Set the hoversel button label
13818 * @param obj The hoversel object
13819 * @param label The label text.
13821 * This sets the label of the button that is always visible (before it is
13822 * clicked and expanded).
13824 * @deprecated elm_object_text_set()
13826 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13828 * @brief Get the hoversel button label
13830 * @param obj The hoversel object
13831 * @return The label text.
13833 * @deprecated elm_object_text_get()
13835 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13837 * @brief Set the icon of the hoversel button
13839 * @param obj The hoversel object
13840 * @param icon The icon object
13842 * Sets the icon of the button that is always visible (before it is clicked
13843 * and expanded). Once the icon object is set, a previously set one will be
13844 * deleted, if you want to keep that old content object, use the
13845 * elm_hoversel_icon_unset() function.
13847 * @see elm_button_icon_set()
13849 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
13851 * @brief Get the icon of the hoversel button
13853 * @param obj The hoversel object
13854 * @return The icon object
13856 * Get the icon of the button that is always visible (before it is clicked
13857 * and expanded). Also see elm_button_icon_get().
13859 * @see elm_hoversel_icon_set()
13861 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13863 * @brief Get and unparent the icon of the hoversel button
13865 * @param obj The hoversel object
13866 * @return The icon object that was being used
13868 * Unparent and return the icon of the button that is always visible
13869 * (before it is clicked and expanded).
13871 * @see elm_hoversel_icon_set()
13872 * @see elm_button_icon_unset()
13874 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13876 * @brief This triggers the hoversel popup from code, the same as if the user
13877 * had clicked the button.
13879 * @param obj The hoversel object
13881 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
13883 * @brief This dismisses the hoversel popup as if the user had clicked
13884 * outside the hover.
13886 * @param obj The hoversel object
13888 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
13890 * @brief Returns whether the hoversel is expanded.
13892 * @param obj The hoversel object
13893 * @return This will return EINA_TRUE if the hoversel is expanded or
13894 * EINA_FALSE if it is not expanded.
13896 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13898 * @brief This will remove all the children items from the hoversel.
13900 * @param obj The hoversel object
13902 * @warning Should @b not be called while the hoversel is active; use
13903 * elm_hoversel_expanded_get() to check first.
13905 * @see elm_hoversel_item_del_cb_set()
13906 * @see elm_hoversel_item_del()
13908 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
13910 * @brief Get the list of items within the given hoversel.
13912 * @param obj The hoversel object
13913 * @return Returns a list of Elm_Hoversel_Item*
13915 * @see elm_hoversel_item_add()
13917 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13919 * @brief Add an item to the hoversel button
13921 * @param obj The hoversel object
13922 * @param label The text label to use for the item (NULL if not desired)
13923 * @param icon_file An image file path on disk to use for the icon or standard
13924 * icon name (NULL if not desired)
13925 * @param icon_type The icon type if relevant
13926 * @param func Convenience function to call when this item is selected
13927 * @param data Data to pass to item-related functions
13928 * @return A handle to the item added.
13930 * This adds an item to the hoversel to show when it is clicked. Note: if you
13931 * need to use an icon from an edje file then use
13932 * elm_hoversel_item_icon_set() right after the this function, and set
13933 * icon_file to NULL here.
13935 * For more information on what @p icon_file and @p icon_type are see the
13936 * @ref Icon "icon documentation".
13938 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);
13940 * @brief Delete an item from the hoversel
13942 * @param item The item to delete
13944 * This deletes the item from the hoversel (should not be called while the
13945 * hoversel is active; use elm_hoversel_expanded_get() to check first).
13947 * @see elm_hoversel_item_add()
13948 * @see elm_hoversel_item_del_cb_set()
13950 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
13952 * @brief Set the function to be called when an item from the hoversel is
13955 * @param item The item to set the callback on
13956 * @param func The function called
13958 * That function will receive these parameters:
13959 * @li void *item_data
13960 * @li Evas_Object *the_item_object
13961 * @li Elm_Hoversel_Item *the_object_struct
13963 * @see elm_hoversel_item_add()
13965 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
13967 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
13968 * that will be passed to associated function callbacks.
13970 * @param item The item to get the data from
13971 * @return The data pointer set with elm_hoversel_item_add()
13973 * @see elm_hoversel_item_add()
13975 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
13977 * @brief This returns the label text of the given hoversel item.
13979 * @param item The item to get the label
13980 * @return The label text of the hoversel item
13982 * @see elm_hoversel_item_add()
13984 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
13986 * @brief This sets the icon for the given hoversel item.
13988 * @param item The item to set the icon
13989 * @param icon_file An image file path on disk to use for the icon or standard
13991 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
13992 * to NULL if the icon is not an edje file
13993 * @param icon_type The icon type
13995 * The icon can be loaded from the standard set, from an image file, or from
13998 * @see elm_hoversel_item_add()
14000 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);
14002 * @brief Get the icon object of the hoversel item
14004 * @param item The item to get the icon from
14005 * @param icon_file The image file path on disk used for the icon or standard
14007 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
14008 * if the icon is not an edje file
14009 * @param icon_type The icon type
14011 * @see elm_hoversel_item_icon_set()
14012 * @see elm_hoversel_item_add()
14014 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);
14020 * @defgroup Toolbar Toolbar
14021 * @ingroup Elementary
14023 * @image html img/widget/toolbar/preview-00.png
14024 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
14026 * @image html img/toolbar.png
14027 * @image latex img/toolbar.eps width=\textwidth
14029 * A toolbar is a widget that displays a list of items inside
14030 * a box. It can be scrollable, show a menu with items that don't fit
14031 * to toolbar size or even crop them.
14033 * Only one item can be selected at a time.
14035 * Items can have multiple states, or show menus when selected by the user.
14037 * Smart callbacks one can listen to:
14038 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
14040 * Available styles for it:
14042 * - @c "transparent" - no background or shadow, just show the content
14044 * List of examples:
14045 * @li @ref toolbar_example_01
14046 * @li @ref toolbar_example_02
14047 * @li @ref toolbar_example_03
14051 * @addtogroup Toolbar
14056 * @enum _Elm_Toolbar_Shrink_Mode
14057 * @typedef Elm_Toolbar_Shrink_Mode
14059 * Set toolbar's items display behavior, it can be scrollabel,
14060 * show a menu with exceeding items, or simply hide them.
14062 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
14065 * Values <b> don't </b> work as bitmask, only one can be choosen.
14067 * @see elm_toolbar_mode_shrink_set()
14068 * @see elm_toolbar_mode_shrink_get()
14072 typedef enum _Elm_Toolbar_Shrink_Mode
14074 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
14075 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
14076 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
14077 ELM_TOOLBAR_SHRINK_MENU /**< Inserts a button to pop up a menu with exceeding items. */
14078 } Elm_Toolbar_Shrink_Mode;
14080 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(). */
14082 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(). */
14085 * Add a new toolbar widget to the given parent Elementary
14086 * (container) object.
14088 * @param parent The parent object.
14089 * @return a new toolbar widget handle or @c NULL, on errors.
14091 * This function inserts a new toolbar widget on the canvas.
14095 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14098 * Set the icon size, in pixels, to be used by toolbar items.
14100 * @param obj The toolbar object
14101 * @param icon_size The icon size in pixels
14103 * @note Default value is @c 32. It reads value from elm config.
14105 * @see elm_toolbar_icon_size_get()
14109 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
14112 * Get the icon size, in pixels, to be used by toolbar items.
14114 * @param obj The toolbar object.
14115 * @return The icon size in pixels.
14117 * @see elm_toolbar_icon_size_set() for details.
14121 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14124 * Sets icon lookup order, for toolbar items' icons.
14126 * @param obj The toolbar object.
14127 * @param order The icon lookup order.
14129 * Icons added before calling this function will not be affected.
14130 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
14132 * @see elm_toolbar_icon_order_lookup_get()
14136 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
14139 * Gets the icon lookup order.
14141 * @param obj The toolbar object.
14142 * @return The icon lookup order.
14144 * @see elm_toolbar_icon_order_lookup_set() for details.
14148 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14151 * Set whether the toolbar should always have an item selected.
14153 * @param obj The toolbar object.
14154 * @param wrap @c EINA_TRUE to enable always-select mode or @c EINA_FALSE to
14157 * This will cause the toolbar to always have an item selected, and clicking
14158 * the selected item will not cause a selected event to be emitted. Enabling this mode
14159 * will immediately select the first toolbar item.
14161 * Always-selected is disabled by default.
14163 * @see elm_toolbar_always_select_mode_get().
14167 EAPI void elm_toolbar_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14170 * Get whether the toolbar should always have an item selected.
14172 * @param obj The toolbar object.
14173 * @return @c EINA_TRUE means an item will always be selected, @c EINA_FALSE indicates
14174 * that it is possible to have no items selected. If @p obj is @c NULL, @c EINA_FALSE is returned.
14176 * @see elm_toolbar_always_select_mode_set() for details.
14180 EAPI Eina_Bool elm_toolbar_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14183 * Set whether the toolbar items' should be selected by the user or not.
14185 * @param obj The toolbar object.
14186 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
14189 * This will turn off the ability to select items entirely and they will
14190 * neither appear selected nor emit selected signals. The clicked
14191 * callback function will still be called.
14193 * Selection is enabled by default.
14195 * @see elm_toolbar_no_select_mode_get().
14199 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14202 * Set whether the toolbar items' should be selected by the user or not.
14204 * @param obj The toolbar object.
14205 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
14206 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
14208 * @see elm_toolbar_no_select_mode_set() for details.
14212 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14215 * Append item to the toolbar.
14217 * @param obj The toolbar object.
14218 * @param icon A string with icon name or the absolute path of an image file.
14219 * @param label The label of the item.
14220 * @param func The function to call when the item is clicked.
14221 * @param data The data to associate with the item for related callbacks.
14222 * @return The created item or @c NULL upon failure.
14224 * A new item will be created and appended to the toolbar, i.e., will
14225 * be set as @b last item.
14227 * Items created with this method can be deleted with
14228 * elm_toolbar_item_del().
14230 * Associated @p data can be properly freed when item is deleted if a
14231 * callback function is set with elm_toolbar_item_del_cb_set().
14233 * If a function is passed as argument, it will be called everytime this item
14234 * is selected, i.e., the user clicks over an unselected item.
14235 * If such function isn't needed, just passing
14236 * @c NULL as @p func is enough. The same should be done for @p data.
14238 * Toolbar will load icon image from fdo or current theme.
14239 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14240 * If an absolute path is provided it will load it direct from a file.
14242 * @see elm_toolbar_item_icon_set()
14243 * @see elm_toolbar_item_del()
14244 * @see elm_toolbar_item_del_cb_set()
14248 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);
14251 * Prepend item to the toolbar.
14253 * @param obj The toolbar object.
14254 * @param icon A string with icon name or the absolute path of an image file.
14255 * @param label The label of the item.
14256 * @param func The function to call when the item is clicked.
14257 * @param data The data to associate with the item for related callbacks.
14258 * @return The created item or @c NULL upon failure.
14260 * A new item will be created and prepended to the toolbar, i.e., will
14261 * be set as @b first item.
14263 * Items created with this method can be deleted with
14264 * elm_toolbar_item_del().
14266 * Associated @p data can be properly freed when item is deleted if a
14267 * callback function is set with elm_toolbar_item_del_cb_set().
14269 * If a function is passed as argument, it will be called everytime this item
14270 * is selected, i.e., the user clicks over an unselected item.
14271 * If such function isn't needed, just passing
14272 * @c NULL as @p func is enough. The same should be done for @p data.
14274 * Toolbar will load icon image from fdo or current theme.
14275 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14276 * If an absolute path is provided it will load it direct from a file.
14278 * @see elm_toolbar_item_icon_set()
14279 * @see elm_toolbar_item_del()
14280 * @see elm_toolbar_item_del_cb_set()
14284 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);
14287 * Insert a new item into the toolbar object before item @p before.
14289 * @param obj The toolbar object.
14290 * @param before The toolbar item to insert before.
14291 * @param icon A string with icon name or the absolute path of an image file.
14292 * @param label The label of the item.
14293 * @param func The function to call when the item is clicked.
14294 * @param data The data to associate with the item for related callbacks.
14295 * @return The created item or @c NULL upon failure.
14297 * A new item will be created and added to the toolbar. Its position in
14298 * this toolbar will be just before item @p before.
14300 * Items created with this method can be deleted with
14301 * elm_toolbar_item_del().
14303 * Associated @p data can be properly freed when item is deleted if a
14304 * callback function is set with elm_toolbar_item_del_cb_set().
14306 * If a function is passed as argument, it will be called everytime this item
14307 * is selected, i.e., the user clicks over an unselected item.
14308 * If such function isn't needed, just passing
14309 * @c NULL as @p func is enough. The same should be done for @p data.
14311 * Toolbar will load icon image from fdo or current theme.
14312 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14313 * If an absolute path is provided it will load it direct from a file.
14315 * @see elm_toolbar_item_icon_set()
14316 * @see elm_toolbar_item_del()
14317 * @see elm_toolbar_item_del_cb_set()
14321 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);
14324 * Insert a new item into the toolbar object after item @p after.
14326 * @param obj The toolbar object.
14327 * @param before The toolbar item to insert before.
14328 * @param icon A string with icon name or the absolute path of an image file.
14329 * @param label The label of the item.
14330 * @param func The function to call when the item is clicked.
14331 * @param data The data to associate with the item for related callbacks.
14332 * @return The created item or @c NULL upon failure.
14334 * A new item will be created and added to the toolbar. Its position in
14335 * this toolbar will be just after item @p after.
14337 * Items created with this method can be deleted with
14338 * elm_toolbar_item_del().
14340 * Associated @p data can be properly freed when item is deleted if a
14341 * callback function is set with elm_toolbar_item_del_cb_set().
14343 * If a function is passed as argument, it will be called everytime this item
14344 * is selected, i.e., the user clicks over an unselected item.
14345 * If such function isn't needed, just passing
14346 * @c NULL as @p func is enough. The same should be done for @p data.
14348 * Toolbar will load icon image from fdo or current theme.
14349 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14350 * If an absolute path is provided it will load it direct from a file.
14352 * @see elm_toolbar_item_icon_set()
14353 * @see elm_toolbar_item_del()
14354 * @see elm_toolbar_item_del_cb_set()
14358 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);
14361 * Get the first item in the given toolbar widget's list of
14364 * @param obj The toolbar object
14365 * @return The first item or @c NULL, if it has no items (and on
14368 * @see elm_toolbar_item_append()
14369 * @see elm_toolbar_last_item_get()
14373 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14376 * Get the last item in the given toolbar widget's list of
14379 * @param obj The toolbar object
14380 * @return The last item or @c NULL, if it has no items (and on
14383 * @see elm_toolbar_item_prepend()
14384 * @see elm_toolbar_first_item_get()
14388 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14391 * Get the item after @p item in toolbar.
14393 * @param item The toolbar item.
14394 * @return The item after @p item, or @c NULL if none or on failure.
14396 * @note If it is the last item, @c NULL will be returned.
14398 * @see elm_toolbar_item_append()
14402 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14405 * Get the item before @p item in toolbar.
14407 * @param item The toolbar item.
14408 * @return The item before @p item, or @c NULL if none or on failure.
14410 * @note If it is the first item, @c NULL will be returned.
14412 * @see elm_toolbar_item_prepend()
14416 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14419 * Get the toolbar object from an item.
14421 * @param item The item.
14422 * @return The toolbar object.
14424 * This returns the toolbar object itself that an item belongs to.
14428 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14431 * Set the priority of a toolbar item.
14433 * @param item The toolbar item.
14434 * @param priority The item priority. The default is zero.
14436 * This is used only when the toolbar shrink mode is set to
14437 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
14438 * When space is less than required, items with low priority
14439 * will be removed from the toolbar and added to a dynamically-created menu,
14440 * while items with higher priority will remain on the toolbar,
14441 * with the same order they were added.
14443 * @see elm_toolbar_item_priority_get()
14447 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
14450 * Get the priority of a toolbar item.
14452 * @param item The toolbar item.
14453 * @return The @p item priority, or @c 0 on failure.
14455 * @see elm_toolbar_item_priority_set() for details.
14459 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14462 * Get the label of item.
14464 * @param item The item of toolbar.
14465 * @return The label of item.
14467 * The return value is a pointer to the label associated to @p item when
14468 * it was created, with function elm_toolbar_item_append() or similar,
14470 * with function elm_toolbar_item_label_set. If no label
14471 * was passed as argument, it will return @c NULL.
14473 * @see elm_toolbar_item_label_set() for more details.
14474 * @see elm_toolbar_item_append()
14478 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14481 * Set the label of item.
14483 * @param item The item of toolbar.
14484 * @param text The label of item.
14486 * The label to be displayed by the item.
14487 * Label will be placed at icons bottom (if set).
14489 * If a label was passed as argument on item creation, with function
14490 * elm_toolbar_item_append() or similar, it will be already
14491 * displayed by the item.
14493 * @see elm_toolbar_item_label_get()
14494 * @see elm_toolbar_item_append()
14498 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
14501 * Return the data associated with a given toolbar widget item.
14503 * @param item The toolbar widget item handle.
14504 * @return The data associated with @p item.
14506 * @see elm_toolbar_item_data_set()
14510 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14513 * Set the data associated with a given toolbar widget item.
14515 * @param item The toolbar widget item handle.
14516 * @param data The new data pointer to set to @p item.
14518 * This sets new item data on @p item.
14520 * @warning The old data pointer won't be touched by this function, so
14521 * the user had better to free that old data himself/herself.
14525 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
14528 * Returns a pointer to a toolbar item by its label.
14530 * @param obj The toolbar object.
14531 * @param label The label of the item to find.
14533 * @return The pointer to the toolbar item matching @p label or @c NULL
14538 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14541 * Get whether the @p item is selected or not.
14543 * @param item The toolbar item.
14544 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
14545 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
14547 * @see elm_toolbar_selected_item_set() for details.
14548 * @see elm_toolbar_item_selected_get()
14552 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14555 * Set the selected state of an item.
14557 * @param item The toolbar item
14558 * @param selected The selected state
14560 * This sets the selected state of the given item @p it.
14561 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
14563 * If a new item is selected the previosly selected will be unselected.
14564 * Previoulsy selected item can be get with function
14565 * elm_toolbar_selected_item_get().
14567 * Selected items will be highlighted.
14569 * @see elm_toolbar_item_selected_get()
14570 * @see elm_toolbar_selected_item_get()
14574 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14577 * Get the selected item.
14579 * @param obj The toolbar object.
14580 * @return The selected toolbar item.
14582 * The selected item can be unselected with function
14583 * elm_toolbar_item_selected_set().
14585 * The selected item always will be highlighted on toolbar.
14587 * @see elm_toolbar_selected_items_get()
14591 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14594 * Set the icon associated with @p item.
14596 * @param obj The parent of this item.
14597 * @param item The toolbar item.
14598 * @param icon A string with icon name or the absolute path of an image file.
14600 * Toolbar will load icon image from fdo or current theme.
14601 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14602 * If an absolute path is provided it will load it direct from a file.
14604 * @see elm_toolbar_icon_order_lookup_set()
14605 * @see elm_toolbar_icon_order_lookup_get()
14609 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
14612 * Get the string used to set the icon of @p item.
14614 * @param item The toolbar item.
14615 * @return The string associated with the icon object.
14617 * @see elm_toolbar_item_icon_set() for details.
14621 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14624 * Get the object of @p item.
14626 * @param item The toolbar item.
14627 * @return The object
14631 EAPI Evas_Object *elm_toolbar_item_object_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14634 * Get the icon object of @p item.
14636 * @param item The toolbar item.
14637 * @return The icon object
14639 * @see elm_toolbar_item_icon_set() or elm_toolbar_item_icon_memfile_set() for details.
14643 EAPI Evas_Object *elm_toolbar_item_icon_object_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14646 * Set the icon associated with @p item to an image in a binary buffer.
14648 * @param item The toolbar item.
14649 * @param img The binary data that will be used as an image
14650 * @param size The size of binary data @p img
14651 * @param format Optional format of @p img to pass to the image loader
14652 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
14654 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
14656 * @note The icon image set by this function can be changed by
14657 * elm_toolbar_item_icon_set().
14661 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);
14664 * Delete them item from the toolbar.
14666 * @param item The item of toolbar to be deleted.
14668 * @see elm_toolbar_item_append()
14669 * @see elm_toolbar_item_del_cb_set()
14673 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14676 * Set the function called when a toolbar item is freed.
14678 * @param item The item to set the callback on.
14679 * @param func The function called.
14681 * If there is a @p func, then it will be called prior item's memory release.
14682 * That will be called with the following arguments:
14684 * @li item's Evas object;
14687 * This way, a data associated to a toolbar item could be properly freed.
14691 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14694 * Get a value whether toolbar item is disabled or not.
14696 * @param item The item.
14697 * @return The disabled state.
14699 * @see elm_toolbar_item_disabled_set() for more details.
14703 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14706 * Sets the disabled/enabled state of a toolbar item.
14708 * @param item The item.
14709 * @param disabled The disabled state.
14711 * A disabled item cannot be selected or unselected. It will also
14712 * change its appearance (generally greyed out). This sets the
14713 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
14718 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
14721 * Set or unset item as a separator.
14723 * @param item The toolbar item.
14724 * @param setting @c EINA_TRUE to set item @p item as separator or
14725 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
14727 * Items aren't set as separator by default.
14729 * If set as separator it will display separator theme, so won't display
14732 * @see elm_toolbar_item_separator_get()
14736 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
14739 * Get a value whether item is a separator or not.
14741 * @param item The toolbar item.
14742 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
14743 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
14745 * @see elm_toolbar_item_separator_set() for details.
14749 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14752 * Set the shrink state of toolbar @p obj.
14754 * @param obj The toolbar object.
14755 * @param shrink_mode Toolbar's items display behavior.
14757 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
14758 * but will enforce a minimun size so all the items will fit, won't scroll
14759 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
14760 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
14761 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
14765 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
14768 * Get the shrink mode of toolbar @p obj.
14770 * @param obj The toolbar object.
14771 * @return Toolbar's items display behavior.
14773 * @see elm_toolbar_mode_shrink_set() for details.
14777 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14780 * Enable/disable homogenous mode.
14782 * @param obj The toolbar object
14783 * @param homogeneous Assume the items within the toolbar are of the
14784 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
14786 * This will enable the homogeneous mode where items are of the same size.
14787 * @see elm_toolbar_homogeneous_get()
14791 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
14794 * Get whether the homogenous mode is enabled.
14796 * @param obj The toolbar object.
14797 * @return Assume the items within the toolbar are of the same height
14798 * and width (EINA_TRUE = on, EINA_FALSE = off).
14800 * @see elm_toolbar_homogeneous_set()
14804 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14807 * Enable/disable homogenous mode.
14809 * @param obj The toolbar object
14810 * @param homogeneous Assume the items within the toolbar are of the
14811 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
14813 * This will enable the homogeneous mode where items are of the same size.
14814 * @see elm_toolbar_homogeneous_get()
14816 * @deprecated use elm_toolbar_homogeneous_set() instead.
14820 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
14823 * Get whether the homogenous mode is enabled.
14825 * @param obj The toolbar object.
14826 * @return Assume the items within the toolbar are of the same height
14827 * and width (EINA_TRUE = on, EINA_FALSE = off).
14829 * @see elm_toolbar_homogeneous_set()
14830 * @deprecated use elm_toolbar_homogeneous_get() instead.
14834 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14837 * Set the parent object of the toolbar items' menus.
14839 * @param obj The toolbar object.
14840 * @param parent The parent of the menu objects.
14842 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
14844 * For more details about setting the parent for toolbar menus, see
14845 * elm_menu_parent_set().
14847 * @see elm_menu_parent_set() for details.
14848 * @see elm_toolbar_item_menu_set() for details.
14852 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14855 * Get the parent object of the toolbar items' menus.
14857 * @param obj The toolbar object.
14858 * @return The parent of the menu objects.
14860 * @see elm_toolbar_menu_parent_set() for details.
14864 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14867 * Set the alignment of the items.
14869 * @param obj The toolbar object.
14870 * @param align The new alignment, a float between <tt> 0.0 </tt>
14871 * and <tt> 1.0 </tt>.
14873 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
14874 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
14877 * Centered items by default.
14879 * @see elm_toolbar_align_get()
14883 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
14886 * Get the alignment of the items.
14888 * @param obj The toolbar object.
14889 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
14892 * @see elm_toolbar_align_set() for details.
14896 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14899 * Set whether the toolbar item opens a menu.
14901 * @param item The toolbar item.
14902 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
14904 * A toolbar item can be set to be a menu, using this function.
14906 * Once it is set to be a menu, it can be manipulated through the
14907 * menu-like function elm_toolbar_menu_parent_set() and the other
14908 * elm_menu functions, using the Evas_Object @c menu returned by
14909 * elm_toolbar_item_menu_get().
14911 * So, items to be displayed in this item's menu should be added with
14912 * elm_menu_item_add().
14914 * The following code exemplifies the most basic usage:
14916 * tb = elm_toolbar_add(win)
14917 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
14918 * elm_toolbar_item_menu_set(item, EINA_TRUE);
14919 * elm_toolbar_menu_parent_set(tb, win);
14920 * menu = elm_toolbar_item_menu_get(item);
14921 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
14922 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
14926 * @see elm_toolbar_item_menu_get()
14930 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
14933 * Get toolbar item's menu.
14935 * @param item The toolbar item.
14936 * @return Item's menu object or @c NULL on failure.
14938 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
14939 * this function will set it.
14941 * @see elm_toolbar_item_menu_set() for details.
14945 EAPI Evas_Object *elm_toolbar_item_menu_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14948 * Add a new state to @p item.
14950 * @param item The item.
14951 * @param icon A string with icon name or the absolute path of an image file.
14952 * @param label The label of the new state.
14953 * @param func The function to call when the item is clicked when this
14954 * state is selected.
14955 * @param data The data to associate with the state.
14956 * @return The toolbar item state, or @c NULL upon failure.
14958 * Toolbar will load icon image from fdo or current theme.
14959 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14960 * If an absolute path is provided it will load it direct from a file.
14962 * States created with this function can be removed with
14963 * elm_toolbar_item_state_del().
14965 * @see elm_toolbar_item_state_del()
14966 * @see elm_toolbar_item_state_sel()
14967 * @see elm_toolbar_item_state_get()
14971 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);
14974 * Delete a previoulsy added state to @p item.
14976 * @param item The toolbar item.
14977 * @param state The state to be deleted.
14978 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
14980 * @see elm_toolbar_item_state_add()
14982 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
14985 * Set @p state as the current state of @p it.
14987 * @param it The item.
14988 * @param state The state to use.
14989 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
14991 * If @p state is @c NULL, it won't select any state and the default item's
14992 * icon and label will be used. It's the same behaviour than
14993 * elm_toolbar_item_state_unser().
14995 * @see elm_toolbar_item_state_unset()
14999 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15002 * Unset the state of @p it.
15004 * @param it The item.
15006 * The default icon and label from this item will be displayed.
15008 * @see elm_toolbar_item_state_set() for more details.
15012 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15015 * Get the current state of @p it.
15017 * @param item The item.
15018 * @return The selected state or @c NULL if none is selected or on failure.
15020 * @see elm_toolbar_item_state_set() for details.
15021 * @see elm_toolbar_item_state_unset()
15022 * @see elm_toolbar_item_state_add()
15026 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15029 * Get the state after selected state in toolbar's @p item.
15031 * @param it The toolbar item to change state.
15032 * @return The state after current state, or @c NULL on failure.
15034 * If last state is selected, this function will return first state.
15036 * @see elm_toolbar_item_state_set()
15037 * @see elm_toolbar_item_state_add()
15041 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15044 * Get the state before selected state in toolbar's @p item.
15046 * @param it The toolbar item to change state.
15047 * @return The state before current state, or @c NULL on failure.
15049 * If first state is selected, this function will return last state.
15051 * @see elm_toolbar_item_state_set()
15052 * @see elm_toolbar_item_state_add()
15056 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15059 * Set the text to be shown in a given toolbar item's tooltips.
15061 * @param item Target item.
15062 * @param text The text to set in the content.
15064 * Setup the text as tooltip to object. The item can have only one tooltip,
15065 * so any previous tooltip data - set with this function or
15066 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
15068 * @see elm_object_tooltip_text_set() for more details.
15072 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
15075 * Set the content to be shown in the tooltip item.
15077 * Setup the tooltip to item. The item can have only one tooltip,
15078 * so any previous tooltip data is removed. @p func(with @p data) will
15079 * be called every time that need show the tooltip and it should
15080 * return a valid Evas_Object. This object is then managed fully by
15081 * tooltip system and is deleted when the tooltip is gone.
15083 * @param item the toolbar item being attached a tooltip.
15084 * @param func the function used to create the tooltip contents.
15085 * @param data what to provide to @a func as callback data/context.
15086 * @param del_cb called when data is not needed anymore, either when
15087 * another callback replaces @a func, the tooltip is unset with
15088 * elm_toolbar_item_tooltip_unset() or the owner @a item
15089 * dies. This callback receives as the first parameter the
15090 * given @a data, and @c event_info is the item.
15092 * @see elm_object_tooltip_content_cb_set() for more details.
15096 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);
15099 * Unset tooltip from item.
15101 * @param item toolbar item to remove previously set tooltip.
15103 * Remove tooltip from item. The callback provided as del_cb to
15104 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
15105 * it is not used anymore.
15107 * @see elm_object_tooltip_unset() for more details.
15108 * @see elm_toolbar_item_tooltip_content_cb_set()
15112 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15115 * Sets a different style for this item tooltip.
15117 * @note before you set a style you should define a tooltip with
15118 * elm_toolbar_item_tooltip_content_cb_set() or
15119 * elm_toolbar_item_tooltip_text_set()
15121 * @param item toolbar item with tooltip already set.
15122 * @param style the theme style to use (default, transparent, ...)
15124 * @see elm_object_tooltip_style_set() for more details.
15128 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15131 * Get the style for this item tooltip.
15133 * @param item toolbar item with tooltip already set.
15134 * @return style the theme style in use, defaults to "default". If the
15135 * object does not have a tooltip set, then NULL is returned.
15137 * @see elm_object_tooltip_style_get() for more details.
15138 * @see elm_toolbar_item_tooltip_style_set()
15142 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15145 * Set the type of mouse pointer/cursor decoration to be shown,
15146 * when the mouse pointer is over the given toolbar widget item
15148 * @param item toolbar item to customize cursor on
15149 * @param cursor the cursor type's name
15151 * This function works analogously as elm_object_cursor_set(), but
15152 * here the cursor's changing area is restricted to the item's
15153 * area, and not the whole widget's. Note that that item cursors
15154 * have precedence over widget cursors, so that a mouse over an
15155 * item with custom cursor set will always show @b that cursor.
15157 * If this function is called twice for an object, a previously set
15158 * cursor will be unset on the second call.
15160 * @see elm_object_cursor_set()
15161 * @see elm_toolbar_item_cursor_get()
15162 * @see elm_toolbar_item_cursor_unset()
15166 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15169 * Get the type of mouse pointer/cursor decoration set to be shown,
15170 * when the mouse pointer is over the given toolbar widget item
15172 * @param item toolbar item with custom cursor set
15173 * @return the cursor type's name or @c NULL, if no custom cursors
15174 * were set to @p item (and on errors)
15176 * @see elm_object_cursor_get()
15177 * @see elm_toolbar_item_cursor_set()
15178 * @see elm_toolbar_item_cursor_unset()
15182 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15185 * Unset any custom mouse pointer/cursor decoration set to be
15186 * shown, when the mouse pointer is over the given toolbar widget
15187 * item, thus making it show the @b default cursor again.
15189 * @param item a toolbar item
15191 * Use this call to undo any custom settings on this item's cursor
15192 * decoration, bringing it back to defaults (no custom style set).
15194 * @see elm_object_cursor_unset()
15195 * @see elm_toolbar_item_cursor_set()
15199 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15202 * Set a different @b style for a given custom cursor set for a
15205 * @param item toolbar item with custom cursor set
15206 * @param style the <b>theme style</b> to use (e.g. @c "default",
15207 * @c "transparent", etc)
15209 * This function only makes sense when one is using custom mouse
15210 * cursor decorations <b>defined in a theme file</b>, which can have,
15211 * given a cursor name/type, <b>alternate styles</b> on it. It
15212 * works analogously as elm_object_cursor_style_set(), but here
15213 * applyed only to toolbar item objects.
15215 * @warning Before you set a cursor style you should have definen a
15216 * custom cursor previously on the item, with
15217 * elm_toolbar_item_cursor_set()
15219 * @see elm_toolbar_item_cursor_engine_only_set()
15220 * @see elm_toolbar_item_cursor_style_get()
15224 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15227 * Get the current @b style set for a given toolbar item's custom
15230 * @param item toolbar item with custom cursor set.
15231 * @return style the cursor style in use. If the object does not
15232 * have a cursor set, then @c NULL is returned.
15234 * @see elm_toolbar_item_cursor_style_set() for more details
15238 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15241 * Set if the (custom)cursor for a given toolbar item should be
15242 * searched in its theme, also, or should only rely on the
15243 * rendering engine.
15245 * @param item item with custom (custom) cursor already set on
15246 * @param engine_only Use @c EINA_TRUE to have cursors looked for
15247 * only on those provided by the rendering engine, @c EINA_FALSE to
15248 * have them searched on the widget's theme, as well.
15250 * @note This call is of use only if you've set a custom cursor
15251 * for toolbar items, with elm_toolbar_item_cursor_set().
15253 * @note By default, cursors will only be looked for between those
15254 * provided by the rendering engine.
15258 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15261 * Get if the (custom) cursor for a given toolbar item is being
15262 * searched in its theme, also, or is only relying on the rendering
15265 * @param item a toolbar item
15266 * @return @c EINA_TRUE, if cursors are being looked for only on
15267 * those provided by the rendering engine, @c EINA_FALSE if they
15268 * are being searched on the widget's theme, as well.
15270 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
15274 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15277 * Change a toolbar's orientation
15278 * @param obj The toolbar object
15279 * @param vertical If @c EINA_TRUE, the toolbar is vertical
15280 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15283 EAPI void elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
15286 * Get a toolbar's orientation
15287 * @param obj The toolbar object
15288 * @return If @c EINA_TRUE, the toolbar is vertical
15289 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15292 EAPI Eina_Bool elm_toolbar_orientation_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
15299 * @defgroup Tooltips Tooltips
15301 * The Tooltip is an (internal, for now) smart object used to show a
15302 * content in a frame on mouse hover of objects(or widgets), with
15303 * tips/information about them.
15308 EAPI double elm_tooltip_delay_get(void);
15309 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
15310 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
15311 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
15312 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
15313 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);
15314 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15315 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15316 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15317 EAPI Eina_Bool elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
15318 EAPI Eina_Bool elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
15325 * @defgroup Cursors Cursors
15327 * The Elementary cursor is an internal smart object used to
15328 * customize the mouse cursor displayed over objects (or
15329 * widgets). In the most common scenario, the cursor decoration
15330 * comes from the graphical @b engine Elementary is running
15331 * on. Those engines may provide different decorations for cursors,
15332 * and Elementary provides functions to choose them (think of X11
15333 * cursors, as an example).
15335 * There's also the possibility of, besides using engine provided
15336 * cursors, also use ones coming from Edje theming files. Both
15337 * globally and per widget, Elementary makes it possible for one to
15338 * make the cursors lookup to be held on engines only or on
15339 * Elementary's theme file, too.
15345 * Set the cursor to be shown when mouse is over the object
15347 * Set the cursor that will be displayed when mouse is over the
15348 * object. The object can have only one cursor set to it, so if
15349 * this function is called twice for an object, the previous set
15351 * If using X cursors, a definition of all the valid cursor names
15352 * is listed on Elementary_Cursors.h. If an invalid name is set
15353 * the default cursor will be used.
15355 * @param obj the object being set a cursor.
15356 * @param cursor the cursor name to be used.
15360 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
15363 * Get the cursor to be shown when mouse is over the object
15365 * @param obj an object with cursor already set.
15366 * @return the cursor name.
15370 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15373 * Unset cursor for object
15375 * Unset cursor for object, and set the cursor to default if the mouse
15376 * was over this object.
15378 * @param obj Target object
15379 * @see elm_object_cursor_set()
15383 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15386 * Sets a different style for this object cursor.
15388 * @note before you set a style you should define a cursor with
15389 * elm_object_cursor_set()
15391 * @param obj an object with cursor already set.
15392 * @param style the theme style to use (default, transparent, ...)
15396 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15399 * Get the style for this object cursor.
15401 * @param obj an object with cursor already set.
15402 * @return style the theme style in use, defaults to "default". If the
15403 * object does not have a cursor set, then NULL is returned.
15407 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15410 * Set if the cursor set should be searched on the theme or should use
15411 * the provided by the engine, only.
15413 * @note before you set if should look on theme you should define a cursor
15414 * with elm_object_cursor_set(). By default it will only look for cursors
15415 * provided by the engine.
15417 * @param obj an object with cursor already set.
15418 * @param engine_only boolean to define it cursors should be looked only
15419 * between the provided by the engine or searched on widget's theme as well.
15423 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15426 * Get the cursor engine only usage for this object cursor.
15428 * @param obj an object with cursor already set.
15429 * @return engine_only boolean to define it cursors should be
15430 * looked only between the provided by the engine or searched on
15431 * widget's theme as well. If the object does not have a cursor
15432 * set, then EINA_FALSE is returned.
15436 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15439 * Get the configured cursor engine only usage
15441 * This gets the globally configured exclusive usage of engine cursors.
15443 * @return 1 if only engine cursors should be used
15446 EAPI int elm_cursor_engine_only_get(void);
15449 * Set the configured cursor engine only usage
15451 * This sets the globally configured exclusive usage of engine cursors.
15452 * It won't affect cursors set before changing this value.
15454 * @param engine_only If 1 only engine cursors will be enabled, if 0 will
15455 * look for them on theme before.
15456 * @return EINA_TRUE if value is valid and setted (0 or 1)
15459 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
15466 * @defgroup Menu Menu
15468 * @image html img/widget/menu/preview-00.png
15469 * @image latex img/widget/menu/preview-00.eps
15471 * A menu is a list of items displayed above its parent. When the menu is
15472 * showing its parent is darkened. Each item can have a sub-menu. The menu
15473 * object can be used to display a menu on a right click event, in a toolbar,
15476 * Signals that you can add callbacks for are:
15477 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
15478 * event_info is NULL.
15480 * @see @ref tutorial_menu
15483 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
15485 * @brief Add a new menu to the parent
15487 * @param parent The parent object.
15488 * @return The new object or NULL if it cannot be created.
15490 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15492 * @brief Set the parent for the given menu widget
15494 * @param obj The menu object.
15495 * @param parent The new parent.
15497 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15499 * @brief Get the parent for the given menu widget
15501 * @param obj The menu object.
15502 * @return The parent.
15504 * @see elm_menu_parent_set()
15506 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15508 * @brief Move the menu to a new position
15510 * @param obj The menu object.
15511 * @param x The new position.
15512 * @param y The new position.
15514 * Sets the top-left position of the menu to (@p x,@p y).
15516 * @note @p x and @p y coordinates are relative to parent.
15518 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
15520 * @brief Close a opened menu
15522 * @param obj the menu object
15525 * Hides the menu and all it's sub-menus.
15527 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
15529 * @brief Returns a list of @p item's items.
15531 * @param obj The menu object
15532 * @return An Eina_List* of @p item's items
15534 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15536 * @brief Get the Evas_Object of an Elm_Menu_Item
15538 * @param item The menu item object.
15539 * @return The edje object containing the swallowed content
15541 * @warning Don't manipulate this object!
15543 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15545 * @brief Add an item at the end of the given menu widget
15547 * @param obj The menu object.
15548 * @param parent The parent menu item (optional)
15549 * @param icon A icon display on the item. The icon will be destryed by the menu.
15550 * @param label The label of the item.
15551 * @param func Function called when the user select the item.
15552 * @param data Data sent by the callback.
15553 * @return Returns the new item.
15555 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);
15557 * @brief Add an object swallowed in an item at the end of the given menu
15560 * @param obj The menu object.
15561 * @param parent The parent menu item (optional)
15562 * @param subobj The object to swallow
15563 * @param func Function called when the user select the item.
15564 * @param data Data sent by the callback.
15565 * @return Returns the new item.
15567 * Add an evas object as an item to the menu.
15569 EAPI Elm_Menu_Item *elm_menu_item_add_object(Evas_Object *obj, Elm_Menu_Item *parent, Evas_Object *subobj, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
15571 * @brief Set the label of a menu item
15573 * @param item The menu item object.
15574 * @param label The label to set for @p item
15576 * @warning Don't use this funcion on items created with
15577 * elm_menu_item_add_object() or elm_menu_item_separator_add().
15579 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
15581 * @brief Get the label of a menu item
15583 * @param item The menu item object.
15584 * @return The label of @p item
15586 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15588 * @brief Set the icon of a menu item to the standard icon with name @p icon
15590 * @param item The menu item object.
15591 * @param icon The icon object to set for the content of @p item
15593 * Once this icon is set, any previously set icon will be deleted.
15595 EAPI void elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
15597 * @brief Get the string representation from the icon of a menu item
15599 * @param item The menu item object.
15600 * @return The string representation of @p item's icon or NULL
15602 * @see elm_menu_item_object_icon_name_set()
15604 EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15606 * @brief Set the content object of a menu item
15608 * @param item The menu item object
15609 * @param The content object or NULL
15610 * @return EINA_TRUE on success, else EINA_FALSE
15612 * Use this function to change the object swallowed by a menu item, deleting
15613 * any previously swallowed object.
15615 EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
15617 * @brief Get the content object of a menu item
15619 * @param item The menu item object
15620 * @return The content object or NULL
15621 * @note If @p item was added with elm_menu_item_add_object, this
15622 * function will return the object passed, else it will return the
15625 * @see elm_menu_item_object_content_set()
15627 EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15629 * @brief Set the selected state of @p item.
15631 * @param item The menu item object.
15632 * @param selected The selected/unselected state of the item
15634 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15636 * @brief Get the selected state of @p item.
15638 * @param item The menu item object.
15639 * @return The selected/unselected state of the item
15641 * @see elm_menu_item_selected_set()
15643 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15645 * @brief Set the disabled state of @p item.
15647 * @param item The menu item object.
15648 * @param disabled The enabled/disabled state of the item
15650 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15652 * @brief Get the disabled state of @p item.
15654 * @param item The menu item object.
15655 * @return The enabled/disabled state of the item
15657 * @see elm_menu_item_disabled_set()
15659 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15661 * @brief Add a separator item to menu @p obj under @p parent.
15663 * @param obj The menu object
15664 * @param parent The item to add the separator under
15665 * @return The created item or NULL on failure
15667 * This is item is a @ref Separator.
15669 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
15671 * @brief Returns whether @p item is a separator.
15673 * @param item The item to check
15674 * @return If true, @p item is a separator
15676 * @see elm_menu_item_separator_add()
15678 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15680 * @brief Deletes an item from the menu.
15682 * @param item The item to delete.
15684 * @see elm_menu_item_add()
15686 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15688 * @brief Set the function called when a menu item is deleted.
15690 * @param item The item to set the callback on
15691 * @param func The function called
15693 * @see elm_menu_item_add()
15694 * @see elm_menu_item_del()
15696 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15698 * @brief Returns the data associated with menu item @p item.
15700 * @param item The item
15701 * @return The data associated with @p item or NULL if none was set.
15703 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
15705 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15707 * @brief Sets the data to be associated with menu item @p item.
15709 * @param item The item
15710 * @param data The data to be associated with @p item
15712 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
15714 * @brief Returns a list of @p item's subitems.
15716 * @param item The item
15717 * @return An Eina_List* of @p item's subitems
15719 * @see elm_menu_add()
15721 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15723 * @brief Get the position of a menu item
15725 * @param item The menu item
15726 * @return The item's index
15728 * This function returns the index position of a menu item in a menu.
15729 * For a sub-menu, this number is relative to the first item in the sub-menu.
15731 * @note Index values begin with 0
15733 EAPI unsigned int elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
15735 * @brief @brief Return a menu item's owner menu
15737 * @param item The menu item
15738 * @return The menu object owning @p item, or NULL on failure
15740 * Use this function to get the menu object owning an item.
15742 EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
15744 * @brief Get the selected item in the menu
15746 * @param obj The menu object
15747 * @return The selected item, or NULL if none
15749 * @see elm_menu_item_selected_get()
15750 * @see elm_menu_item_selected_set()
15752 EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
15754 * @brief Get the last item in the menu
15756 * @param obj The menu object
15757 * @return The last item, or NULL if none
15759 EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
15761 * @brief Get the first item in the menu
15763 * @param obj The menu object
15764 * @return The first item, or NULL if none
15766 EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
15768 * @brief Get the next item in the menu.
15770 * @param item The menu item object.
15771 * @return The item after it, or NULL if none
15773 EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15775 * @brief Get the previous item in the menu.
15777 * @param item The menu item object.
15778 * @return The item before it, or NULL if none
15780 EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15786 * @defgroup List List
15787 * @ingroup Elementary
15789 * @image html img/widget/list/preview-00.png
15790 * @image latex img/widget/list/preview-00.eps width=\textwidth
15792 * @image html img/list.png
15793 * @image latex img/list.eps width=\textwidth
15795 * A list widget is a container whose children are displayed vertically or
15796 * horizontally, in order, and can be selected.
15797 * The list can accept only one or multiple items selection. Also has many
15798 * modes of items displaying.
15800 * A list is a very simple type of list widget. For more robust
15801 * lists, @ref Genlist should probably be used.
15803 * Smart callbacks one can listen to:
15804 * - @c "activated" - The user has double-clicked or pressed
15805 * (enter|return|spacebar) on an item. The @c event_info parameter
15806 * is the item that was activated.
15807 * - @c "clicked,double" - The user has double-clicked an item.
15808 * The @c event_info parameter is the item that was double-clicked.
15809 * - "selected" - when the user selected an item
15810 * - "unselected" - when the user unselected an item
15811 * - "longpressed" - an item in the list is long-pressed
15812 * - "scroll,edge,top" - the list is scrolled until the top edge
15813 * - "scroll,edge,bottom" - the list is scrolled until the bottom edge
15814 * - "scroll,edge,left" - the list is scrolled until the left edge
15815 * - "scroll,edge,right" - the list is scrolled until the right edge
15817 * Available styles for it:
15820 * List of examples:
15821 * @li @ref list_example_01
15822 * @li @ref list_example_02
15823 * @li @ref list_example_03
15832 * @enum _Elm_List_Mode
15833 * @typedef Elm_List_Mode
15835 * Set list's resize behavior, transverse axis scroll and
15836 * items cropping. See each mode's description for more details.
15838 * @note Default value is #ELM_LIST_SCROLL.
15840 * Values <b> don't </b> work as bitmask, only one can be choosen.
15842 * @see elm_list_mode_set()
15843 * @see elm_list_mode_get()
15847 typedef enum _Elm_List_Mode
15849 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. */
15850 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). */
15851 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. */
15852 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. */
15853 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
15856 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(). */
15859 * Add a new list widget to the given parent Elementary
15860 * (container) object.
15862 * @param parent The parent object.
15863 * @return a new list widget handle or @c NULL, on errors.
15865 * This function inserts a new list widget on the canvas.
15869 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15874 * @param obj The list object
15876 * @note Call before running show() on the list object.
15877 * @warning If not called, it won't display the list properly.
15880 * li = elm_list_add(win);
15881 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
15882 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
15884 * evas_object_show(li);
15889 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
15892 * Enable or disable multiple items selection on the list object.
15894 * @param obj The list object
15895 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
15898 * Disabled by default. If disabled, the user can select a single item of
15899 * the list each time. Selected items are highlighted on list.
15900 * If enabled, many items can be selected.
15902 * If a selected item is selected again, it will be unselected.
15904 * @see elm_list_multi_select_get()
15908 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
15911 * Get a value whether multiple items selection is enabled or not.
15913 * @see elm_list_multi_select_set() for details.
15915 * @param obj The list object.
15916 * @return @c EINA_TRUE means multiple items selection is enabled.
15917 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
15918 * @c EINA_FALSE is returned.
15922 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15925 * Set which mode to use for the list object.
15927 * @param obj The list object
15928 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
15929 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
15931 * Set list's resize behavior, transverse axis scroll and
15932 * items cropping. See each mode's description for more details.
15934 * @note Default value is #ELM_LIST_SCROLL.
15936 * Only one can be set, if a previous one was set, it will be changed
15937 * by the new mode set. Bitmask won't work as well.
15939 * @see elm_list_mode_get()
15943 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
15946 * Get the mode the list is at.
15948 * @param obj The list object
15949 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
15950 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
15952 * @note see elm_list_mode_set() for more information.
15956 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15959 * Enable or disable horizontal mode on the list object.
15961 * @param obj The list object.
15962 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
15963 * disable it, i.e., to enable vertical mode.
15965 * @note Vertical mode is set by default.
15967 * On horizontal mode items are displayed on list from left to right,
15968 * instead of from top to bottom. Also, the list will scroll horizontally.
15969 * Each item will presents left icon on top and right icon, or end, at
15972 * @see elm_list_horizontal_get()
15976 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15979 * Get a value whether horizontal mode is enabled or not.
15981 * @param obj The list object.
15982 * @return @c EINA_TRUE means horizontal mode selection is enabled.
15983 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
15984 * @c EINA_FALSE is returned.
15986 * @see elm_list_horizontal_set() for details.
15990 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15993 * Enable or disable always select mode on the list object.
15995 * @param obj The list object
15996 * @param always_select @c EINA_TRUE to enable always select mode or
15997 * @c EINA_FALSE to disable it.
15999 * @note Always select mode is disabled by default.
16001 * Default behavior of list items is to only call its callback function
16002 * the first time it's pressed, i.e., when it is selected. If a selected
16003 * item is pressed again, and multi-select is disabled, it won't call
16004 * this function (if multi-select is enabled it will unselect the item).
16006 * If always select is enabled, it will call the callback function
16007 * everytime a item is pressed, so it will call when the item is selected,
16008 * and again when a selected item is pressed.
16010 * @see elm_list_always_select_mode_get()
16011 * @see elm_list_multi_select_set()
16015 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16018 * Get a value whether always select mode is enabled or not, meaning that
16019 * an item will always call its callback function, even if already selected.
16021 * @param obj The list object
16022 * @return @c EINA_TRUE means horizontal mode selection is enabled.
16023 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16024 * @c EINA_FALSE is returned.
16026 * @see elm_list_always_select_mode_set() for details.
16030 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16033 * Set bouncing behaviour when the scrolled content reaches an edge.
16035 * Tell the internal scroller object whether it should bounce or not
16036 * when it reaches the respective edges for each axis.
16038 * @param obj The list object
16039 * @param h_bounce Whether to bounce or not in the horizontal axis.
16040 * @param v_bounce Whether to bounce or not in the vertical axis.
16042 * @see elm_scroller_bounce_set()
16046 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
16049 * Get the bouncing behaviour of the internal scroller.
16051 * Get whether the internal scroller should bounce when the edge of each
16052 * axis is reached scrolling.
16054 * @param obj The list object.
16055 * @param h_bounce Pointer where to store the bounce state of the horizontal
16057 * @param v_bounce Pointer where to store the bounce state of the vertical
16060 * @see elm_scroller_bounce_get()
16061 * @see elm_list_bounce_set()
16065 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
16068 * Set the scrollbar policy.
16070 * @param obj The list object
16071 * @param policy_h Horizontal scrollbar policy.
16072 * @param policy_v Vertical scrollbar policy.
16074 * This sets the scrollbar visibility policy for the given scroller.
16075 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
16076 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
16077 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
16078 * This applies respectively for the horizontal and vertical scrollbars.
16080 * The both are disabled by default, i.e., are set to
16081 * #ELM_SCROLLER_POLICY_OFF.
16085 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
16088 * Get the scrollbar policy.
16090 * @see elm_list_scroller_policy_get() for details.
16092 * @param obj The list object.
16093 * @param policy_h Pointer where to store horizontal scrollbar policy.
16094 * @param policy_v Pointer where to store vertical scrollbar policy.
16098 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);
16101 * Append a new item to the list object.
16103 * @param obj The list object.
16104 * @param label The label of the list item.
16105 * @param icon The icon object to use for the left side of the item. An
16106 * icon can be any Evas object, but usually it is an icon created
16107 * with elm_icon_add().
16108 * @param end The icon object to use for the right side of the item. An
16109 * icon can be any Evas object.
16110 * @param func The function to call when the item is clicked.
16111 * @param data The data to associate with the item for related callbacks.
16113 * @return The created item or @c NULL upon failure.
16115 * A new item will be created and appended to the list, i.e., will
16116 * be set as @b last item.
16118 * Items created with this method can be deleted with
16119 * elm_list_item_del().
16121 * Associated @p data can be properly freed when item is deleted if a
16122 * callback function is set with elm_list_item_del_cb_set().
16124 * If a function is passed as argument, it will be called everytime this item
16125 * is selected, i.e., the user clicks over an unselected item.
16126 * If always select is enabled it will call this function every time
16127 * user clicks over an item (already selected or not).
16128 * If such function isn't needed, just passing
16129 * @c NULL as @p func is enough. The same should be done for @p data.
16131 * Simple example (with no function callback or data associated):
16133 * li = elm_list_add(win);
16134 * ic = elm_icon_add(win);
16135 * elm_icon_file_set(ic, "path/to/image", NULL);
16136 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
16137 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
16139 * evas_object_show(li);
16142 * @see elm_list_always_select_mode_set()
16143 * @see elm_list_item_del()
16144 * @see elm_list_item_del_cb_set()
16145 * @see elm_list_clear()
16146 * @see elm_icon_add()
16150 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);
16153 * Prepend a new item to the list object.
16155 * @param obj The list object.
16156 * @param label The label of the list item.
16157 * @param icon The icon object to use for the left side of the item. An
16158 * icon can be any Evas object, but usually it is an icon created
16159 * with elm_icon_add().
16160 * @param end The icon object to use for the right side of the item. An
16161 * icon can be any Evas object.
16162 * @param func The function to call when the item is clicked.
16163 * @param data The data to associate with the item for related callbacks.
16165 * @return The created item or @c NULL upon failure.
16167 * A new item will be created and prepended to the list, i.e., will
16168 * be set as @b first item.
16170 * Items created with this method can be deleted with
16171 * elm_list_item_del().
16173 * Associated @p data can be properly freed when item is deleted if a
16174 * callback function is set with elm_list_item_del_cb_set().
16176 * If a function is passed as argument, it will be called everytime this item
16177 * is selected, i.e., the user clicks over an unselected item.
16178 * If always select is enabled it will call this function every time
16179 * user clicks over an item (already selected or not).
16180 * If such function isn't needed, just passing
16181 * @c NULL as @p func is enough. The same should be done for @p data.
16183 * @see elm_list_item_append() for a simple code example.
16184 * @see elm_list_always_select_mode_set()
16185 * @see elm_list_item_del()
16186 * @see elm_list_item_del_cb_set()
16187 * @see elm_list_clear()
16188 * @see elm_icon_add()
16192 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);
16195 * Insert a new item into the list object before item @p before.
16197 * @param obj The list object.
16198 * @param before The list item to insert before.
16199 * @param label The label of the list item.
16200 * @param icon The icon object to use for the left side of the item. An
16201 * icon can be any Evas object, but usually it is an icon created
16202 * with elm_icon_add().
16203 * @param end The icon object to use for the right side of the item. An
16204 * icon can be any Evas object.
16205 * @param func The function to call when the item is clicked.
16206 * @param data The data to associate with the item for related callbacks.
16208 * @return The created item or @c NULL upon failure.
16210 * A new item will be created and added to the list. Its position in
16211 * this list will be just before item @p before.
16213 * Items created with this method can be deleted with
16214 * elm_list_item_del().
16216 * Associated @p data can be properly freed when item is deleted if a
16217 * callback function is set with elm_list_item_del_cb_set().
16219 * If a function is passed as argument, it will be called everytime this item
16220 * is selected, i.e., the user clicks over an unselected item.
16221 * If always select is enabled it will call this function every time
16222 * user clicks over an item (already selected or not).
16223 * If such function isn't needed, just passing
16224 * @c NULL as @p func is enough. The same should be done for @p data.
16226 * @see elm_list_item_append() for a simple code example.
16227 * @see elm_list_always_select_mode_set()
16228 * @see elm_list_item_del()
16229 * @see elm_list_item_del_cb_set()
16230 * @see elm_list_clear()
16231 * @see elm_icon_add()
16235 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);
16238 * Insert a new item into the list object after item @p after.
16240 * @param obj The list object.
16241 * @param after The list item to insert after.
16242 * @param label The label of the list item.
16243 * @param icon The icon object to use for the left side of the item. An
16244 * icon can be any Evas object, but usually it is an icon created
16245 * with elm_icon_add().
16246 * @param end The icon object to use for the right side of the item. An
16247 * icon can be any Evas object.
16248 * @param func The function to call when the item is clicked.
16249 * @param data The data to associate with the item for related callbacks.
16251 * @return The created item or @c NULL upon failure.
16253 * A new item will be created and added to the list. Its position in
16254 * this list will be just after item @p after.
16256 * Items created with this method can be deleted with
16257 * elm_list_item_del().
16259 * Associated @p data can be properly freed when item is deleted if a
16260 * callback function is set with elm_list_item_del_cb_set().
16262 * If a function is passed as argument, it will be called everytime this item
16263 * is selected, i.e., the user clicks over an unselected item.
16264 * If always select is enabled it will call this function every time
16265 * user clicks over an item (already selected or not).
16266 * If such function isn't needed, just passing
16267 * @c NULL as @p func is enough. The same should be done for @p data.
16269 * @see elm_list_item_append() for a simple code example.
16270 * @see elm_list_always_select_mode_set()
16271 * @see elm_list_item_del()
16272 * @see elm_list_item_del_cb_set()
16273 * @see elm_list_clear()
16274 * @see elm_icon_add()
16278 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);
16281 * Insert a new item into the sorted list object.
16283 * @param obj The list object.
16284 * @param label The label of the list item.
16285 * @param icon The icon object to use for the left side of the item. An
16286 * icon can be any Evas object, but usually it is an icon created
16287 * with elm_icon_add().
16288 * @param end The icon object to use for the right side of the item. An
16289 * icon can be any Evas object.
16290 * @param func The function to call when the item is clicked.
16291 * @param data The data to associate with the item for related callbacks.
16292 * @param cmp_func The comparing function to be used to sort list
16293 * items <b>by #Elm_List_Item item handles</b>. This function will
16294 * receive two items and compare them, returning a non-negative integer
16295 * if the second item should be place after the first, or negative value
16296 * if should be placed before.
16298 * @return The created item or @c NULL upon failure.
16300 * @note This function inserts values into a list object assuming it was
16301 * sorted and the result will be sorted.
16303 * A new item will be created and added to the list. Its position in
16304 * this list will be found comparing the new item with previously inserted
16305 * items using function @p cmp_func.
16307 * Items created with this method can be deleted with
16308 * elm_list_item_del().
16310 * Associated @p data can be properly freed when item is deleted if a
16311 * callback function is set with elm_list_item_del_cb_set().
16313 * If a function is passed as argument, it will be called everytime this item
16314 * is selected, i.e., the user clicks over an unselected item.
16315 * If always select is enabled it will call this function every time
16316 * user clicks over an item (already selected or not).
16317 * If such function isn't needed, just passing
16318 * @c NULL as @p func is enough. The same should be done for @p data.
16320 * @see elm_list_item_append() for a simple code example.
16321 * @see elm_list_always_select_mode_set()
16322 * @see elm_list_item_del()
16323 * @see elm_list_item_del_cb_set()
16324 * @see elm_list_clear()
16325 * @see elm_icon_add()
16329 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);
16332 * Remove all list's items.
16334 * @param obj The list object
16336 * @see elm_list_item_del()
16337 * @see elm_list_item_append()
16341 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16344 * Get a list of all the list items.
16346 * @param obj The list object
16347 * @return An @c Eina_List of list items, #Elm_List_Item,
16348 * or @c NULL on failure.
16350 * @see elm_list_item_append()
16351 * @see elm_list_item_del()
16352 * @see elm_list_clear()
16356 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16359 * Get the selected item.
16361 * @param obj The list object.
16362 * @return The selected list item.
16364 * The selected item can be unselected with function
16365 * elm_list_item_selected_set().
16367 * The selected item always will be highlighted on list.
16369 * @see elm_list_selected_items_get()
16373 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16376 * Return a list of the currently selected list items.
16378 * @param obj The list object.
16379 * @return An @c Eina_List of list items, #Elm_List_Item,
16380 * or @c NULL on failure.
16382 * Multiple items can be selected if multi select is enabled. It can be
16383 * done with elm_list_multi_select_set().
16385 * @see elm_list_selected_item_get()
16386 * @see elm_list_multi_select_set()
16390 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16393 * Set the selected state of an item.
16395 * @param item The list item
16396 * @param selected The selected state
16398 * This sets the selected state of the given item @p it.
16399 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
16401 * If a new item is selected the previosly selected will be unselected,
16402 * unless multiple selection is enabled with elm_list_multi_select_set().
16403 * Previoulsy selected item can be get with function
16404 * elm_list_selected_item_get().
16406 * Selected items will be highlighted.
16408 * @see elm_list_item_selected_get()
16409 * @see elm_list_selected_item_get()
16410 * @see elm_list_multi_select_set()
16414 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16417 * Get whether the @p item is selected or not.
16419 * @param item The list item.
16420 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
16421 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
16423 * @see elm_list_selected_item_set() for details.
16424 * @see elm_list_item_selected_get()
16428 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16431 * Set or unset item as a separator.
16433 * @param it The list item.
16434 * @param setting @c EINA_TRUE to set item @p it as separator or
16435 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
16437 * Items aren't set as separator by default.
16439 * If set as separator it will display separator theme, so won't display
16442 * @see elm_list_item_separator_get()
16446 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
16449 * Get a value whether item is a separator or not.
16451 * @see elm_list_item_separator_set() for details.
16453 * @param it The list item.
16454 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
16455 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
16459 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16462 * Show @p item in the list view.
16464 * @param item The list item to be shown.
16466 * It won't animate list until item is visible. If such behavior is wanted,
16467 * use elm_list_bring_in() intead.
16471 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16474 * Bring in the given item to list view.
16476 * @param item The item.
16478 * This causes list to jump to the given item @p item and show it
16479 * (by scrolling), if it is not fully visible.
16481 * This may use animation to do so and take a period of time.
16483 * If animation isn't wanted, elm_list_item_show() can be used.
16487 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16490 * Delete them item from the list.
16492 * @param item The item of list to be deleted.
16494 * If deleting all list items is required, elm_list_clear()
16495 * should be used instead of getting items list and deleting each one.
16497 * @see elm_list_clear()
16498 * @see elm_list_item_append()
16499 * @see elm_list_item_del_cb_set()
16503 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16506 * Set the function called when a list item is freed.
16508 * @param item The item to set the callback on
16509 * @param func The function called
16511 * If there is a @p func, then it will be called prior item's memory release.
16512 * That will be called with the following arguments:
16514 * @li item's Evas object;
16517 * This way, a data associated to a list item could be properly freed.
16521 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16524 * Get the data associated to the item.
16526 * @param item The list item
16527 * @return The data associated to @p item
16529 * The return value is a pointer to data associated to @p item when it was
16530 * created, with function elm_list_item_append() or similar. If no data
16531 * was passed as argument, it will return @c NULL.
16533 * @see elm_list_item_append()
16537 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16540 * Get the left side icon associated to the item.
16542 * @param item The list item
16543 * @return The left side icon associated to @p item
16545 * The return value is a pointer to the icon associated to @p item when
16547 * created, with function elm_list_item_append() or similar, or later
16548 * with function elm_list_item_icon_set(). If no icon
16549 * was passed as argument, it will return @c NULL.
16551 * @see elm_list_item_append()
16552 * @see elm_list_item_icon_set()
16556 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16559 * Set the left side icon associated to the item.
16561 * @param item The list item
16562 * @param icon The left side icon object to associate with @p item
16564 * The icon object to use at left side of the item. An
16565 * icon can be any Evas object, but usually it is an icon created
16566 * with elm_icon_add().
16568 * Once the icon object is set, a previously set one will be deleted.
16569 * @warning Setting the same icon for two items will cause the icon to
16570 * dissapear from the first item.
16572 * If an icon was passed as argument on item creation, with function
16573 * elm_list_item_append() or similar, it will be already
16574 * associated to the item.
16576 * @see elm_list_item_append()
16577 * @see elm_list_item_icon_get()
16581 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
16584 * Get the right side icon associated to the item.
16586 * @param item The list item
16587 * @return The right side icon associated to @p item
16589 * The return value is a pointer to the icon associated to @p item when
16591 * created, with function elm_list_item_append() or similar, or later
16592 * with function elm_list_item_icon_set(). If no icon
16593 * was passed as argument, it will return @c NULL.
16595 * @see elm_list_item_append()
16596 * @see elm_list_item_icon_set()
16600 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16603 * Set the right side icon associated to the item.
16605 * @param item The list item
16606 * @param end The right side icon object to associate with @p item
16608 * The icon object to use at right side of the item. An
16609 * icon can be any Evas object, but usually it is an icon created
16610 * with elm_icon_add().
16612 * Once the icon object is set, a previously set one will be deleted.
16613 * @warning Setting the same icon for two items will cause the icon to
16614 * dissapear from the first item.
16616 * If an icon was passed as argument on item creation, with function
16617 * elm_list_item_append() or similar, it will be already
16618 * associated to the item.
16620 * @see elm_list_item_append()
16621 * @see elm_list_item_end_get()
16625 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
16628 * Gets the base object of the item.
16630 * @param item The list item
16631 * @return The base object associated with @p item
16633 * Base object is the @c Evas_Object that represents that item.
16637 EAPI Evas_Object *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16638 EINA_DEPRECATED EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16641 * Get the label of item.
16643 * @param item The item of list.
16644 * @return The label of item.
16646 * The return value is a pointer to the label associated to @p item when
16647 * it was created, with function elm_list_item_append(), or later
16648 * with function elm_list_item_label_set. If no label
16649 * was passed as argument, it will return @c NULL.
16651 * @see elm_list_item_label_set() for more details.
16652 * @see elm_list_item_append()
16656 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16659 * Set the label of item.
16661 * @param item The item of list.
16662 * @param text The label of item.
16664 * The label to be displayed by the item.
16665 * Label will be placed between left and right side icons (if set).
16667 * If a label was passed as argument on item creation, with function
16668 * elm_list_item_append() or similar, it will be already
16669 * displayed by the item.
16671 * @see elm_list_item_label_get()
16672 * @see elm_list_item_append()
16676 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
16680 * Get the item before @p it in list.
16682 * @param it The list item.
16683 * @return The item before @p it, or @c NULL if none or on failure.
16685 * @note If it is the first item, @c NULL will be returned.
16687 * @see elm_list_item_append()
16688 * @see elm_list_items_get()
16692 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16695 * Get the item after @p it in list.
16697 * @param it The list item.
16698 * @return The item after @p it, or @c NULL if none or on failure.
16700 * @note If it is the last item, @c NULL will be returned.
16702 * @see elm_list_item_append()
16703 * @see elm_list_items_get()
16707 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16710 * Sets the disabled/enabled state of a list item.
16712 * @param it The item.
16713 * @param disabled The disabled state.
16715 * A disabled item cannot be selected or unselected. It will also
16716 * change its appearance (generally greyed out). This sets the
16717 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
16722 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
16725 * Get a value whether list item is disabled or not.
16727 * @param it The item.
16728 * @return The disabled state.
16730 * @see elm_list_item_disabled_set() for more details.
16734 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16737 * Set the text to be shown in a given list item's tooltips.
16739 * @param item Target item.
16740 * @param text The text to set in the content.
16742 * Setup the text as tooltip to object. The item can have only one tooltip,
16743 * so any previous tooltip data - set with this function or
16744 * elm_list_item_tooltip_content_cb_set() - is removed.
16746 * @see elm_object_tooltip_text_set() for more details.
16750 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
16754 * @brief Disable size restrictions on an object's tooltip
16755 * @param item The tooltip's anchor object
16756 * @param disable If EINA_TRUE, size restrictions are disabled
16757 * @return EINA_FALSE on failure, EINA_TRUE on success
16759 * This function allows a tooltip to expand beyond its parant window's canvas.
16760 * It will instead be limited only by the size of the display.
16762 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
16764 * @brief Retrieve size restriction state of an object's tooltip
16765 * @param obj The tooltip's anchor object
16766 * @return If EINA_TRUE, size restrictions are disabled
16768 * This function returns whether a tooltip is allowed to expand beyond
16769 * its parant window's canvas.
16770 * It will instead be limited only by the size of the display.
16772 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16775 * Set the content to be shown in the tooltip item.
16777 * Setup the tooltip to item. The item can have only one tooltip,
16778 * so any previous tooltip data is removed. @p func(with @p data) will
16779 * be called every time that need show the tooltip and it should
16780 * return a valid Evas_Object. This object is then managed fully by
16781 * tooltip system and is deleted when the tooltip is gone.
16783 * @param item the list item being attached a tooltip.
16784 * @param func the function used to create the tooltip contents.
16785 * @param data what to provide to @a func as callback data/context.
16786 * @param del_cb called when data is not needed anymore, either when
16787 * another callback replaces @a func, the tooltip is unset with
16788 * elm_list_item_tooltip_unset() or the owner @a item
16789 * dies. This callback receives as the first parameter the
16790 * given @a data, and @c event_info is the item.
16792 * @see elm_object_tooltip_content_cb_set() for more details.
16796 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);
16799 * Unset tooltip from item.
16801 * @param item list item to remove previously set tooltip.
16803 * Remove tooltip from item. The callback provided as del_cb to
16804 * elm_list_item_tooltip_content_cb_set() will be called to notify
16805 * it is not used anymore.
16807 * @see elm_object_tooltip_unset() for more details.
16808 * @see elm_list_item_tooltip_content_cb_set()
16812 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16815 * Sets a different style for this item tooltip.
16817 * @note before you set a style you should define a tooltip with
16818 * elm_list_item_tooltip_content_cb_set() or
16819 * elm_list_item_tooltip_text_set()
16821 * @param item list item with tooltip already set.
16822 * @param style the theme style to use (default, transparent, ...)
16824 * @see elm_object_tooltip_style_set() for more details.
16828 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
16831 * Get the style for this item tooltip.
16833 * @param item list item with tooltip already set.
16834 * @return style the theme style in use, defaults to "default". If the
16835 * object does not have a tooltip set, then NULL is returned.
16837 * @see elm_object_tooltip_style_get() for more details.
16838 * @see elm_list_item_tooltip_style_set()
16842 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16845 * Set the type of mouse pointer/cursor decoration to be shown,
16846 * when the mouse pointer is over the given list widget item
16848 * @param item list item to customize cursor on
16849 * @param cursor the cursor type's name
16851 * This function works analogously as elm_object_cursor_set(), but
16852 * here the cursor's changing area is restricted to the item's
16853 * area, and not the whole widget's. Note that that item cursors
16854 * have precedence over widget cursors, so that a mouse over an
16855 * item with custom cursor set will always show @b that cursor.
16857 * If this function is called twice for an object, a previously set
16858 * cursor will be unset on the second call.
16860 * @see elm_object_cursor_set()
16861 * @see elm_list_item_cursor_get()
16862 * @see elm_list_item_cursor_unset()
16866 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
16869 * Get the type of mouse pointer/cursor decoration set to be shown,
16870 * when the mouse pointer is over the given list widget item
16872 * @param item list item with custom cursor set
16873 * @return the cursor type's name or @c NULL, if no custom cursors
16874 * were set to @p item (and on errors)
16876 * @see elm_object_cursor_get()
16877 * @see elm_list_item_cursor_set()
16878 * @see elm_list_item_cursor_unset()
16882 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16885 * Unset any custom mouse pointer/cursor decoration set to be
16886 * shown, when the mouse pointer is over the given list widget
16887 * item, thus making it show the @b default cursor again.
16889 * @param item a list item
16891 * Use this call to undo any custom settings on this item's cursor
16892 * decoration, bringing it back to defaults (no custom style set).
16894 * @see elm_object_cursor_unset()
16895 * @see elm_list_item_cursor_set()
16899 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16902 * Set a different @b style for a given custom cursor set for a
16905 * @param item list item with custom cursor set
16906 * @param style the <b>theme style</b> to use (e.g. @c "default",
16907 * @c "transparent", etc)
16909 * This function only makes sense when one is using custom mouse
16910 * cursor decorations <b>defined in a theme file</b>, which can have,
16911 * given a cursor name/type, <b>alternate styles</b> on it. It
16912 * works analogously as elm_object_cursor_style_set(), but here
16913 * applyed only to list item objects.
16915 * @warning Before you set a cursor style you should have definen a
16916 * custom cursor previously on the item, with
16917 * elm_list_item_cursor_set()
16919 * @see elm_list_item_cursor_engine_only_set()
16920 * @see elm_list_item_cursor_style_get()
16924 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
16927 * Get the current @b style set for a given list item's custom
16930 * @param item list item with custom cursor set.
16931 * @return style the cursor style in use. If the object does not
16932 * have a cursor set, then @c NULL is returned.
16934 * @see elm_list_item_cursor_style_set() for more details
16938 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16941 * Set if the (custom)cursor for a given list item should be
16942 * searched in its theme, also, or should only rely on the
16943 * rendering engine.
16945 * @param item item with custom (custom) cursor already set on
16946 * @param engine_only Use @c EINA_TRUE to have cursors looked for
16947 * only on those provided by the rendering engine, @c EINA_FALSE to
16948 * have them searched on the widget's theme, as well.
16950 * @note This call is of use only if you've set a custom cursor
16951 * for list items, with elm_list_item_cursor_set().
16953 * @note By default, cursors will only be looked for between those
16954 * provided by the rendering engine.
16958 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
16961 * Get if the (custom) cursor for a given list item is being
16962 * searched in its theme, also, or is only relying on the rendering
16965 * @param item a list item
16966 * @return @c EINA_TRUE, if cursors are being looked for only on
16967 * those provided by the rendering engine, @c EINA_FALSE if they
16968 * are being searched on the widget's theme, as well.
16970 * @see elm_list_item_cursor_engine_only_set(), for more details
16974 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16981 * @defgroup Slider Slider
16982 * @ingroup Elementary
16984 * @image html img/widget/slider/preview-00.png
16985 * @image latex img/widget/slider/preview-00.eps width=\textwidth
16987 * The slider adds a dragable “slider” widget for selecting the value of
16988 * something within a range.
16990 * A slider can be horizontal or vertical. It can contain an Icon and has a
16991 * primary label as well as a units label (that is formatted with floating
16992 * point values and thus accepts a printf-style format string, like
16993 * “%1.2f units”. There is also an indicator string that may be somewhere
16994 * else (like on the slider itself) that also accepts a format string like
16995 * units. Label, Icon Unit and Indicator strings/objects are optional.
16997 * A slider may be inverted which means values invert, with high vales being
16998 * on the left or top and low values on the right or bottom (as opposed to
16999 * normally being low on the left or top and high on the bottom and right).
17001 * The slider should have its minimum and maximum values set by the
17002 * application with elm_slider_min_max_set() and value should also be set by
17003 * the application before use with elm_slider_value_set(). The span of the
17004 * slider is its length (horizontally or vertically). This will be scaled by
17005 * the object or applications scaling factor. At any point code can query the
17006 * slider for its value with elm_slider_value_get().
17008 * Smart callbacks one can listen to:
17009 * - "changed" - Whenever the slider value is changed by the user.
17010 * - "slider,drag,start" - dragging the slider indicator around has started.
17011 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
17012 * - "delay,changed" - A short time after the value is changed by the user.
17013 * This will be called only when the user stops dragging for
17014 * a very short period or when they release their
17015 * finger/mouse, so it avoids possibly expensive reactions to
17016 * the value change.
17018 * Available styles for it:
17021 * Here is an example on its usage:
17022 * @li @ref slider_example
17026 * @addtogroup Slider
17031 * Add a new slider widget to the given parent Elementary
17032 * (container) object.
17034 * @param parent The parent object.
17035 * @return a new slider widget handle or @c NULL, on errors.
17037 * This function inserts a new slider widget on the canvas.
17041 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17044 * Set the label of a given slider widget
17046 * @param obj The progress bar object
17047 * @param label The text label string, in UTF-8
17050 * @deprecated use elm_object_text_set() instead.
17052 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17055 * Get the label of a given slider widget
17057 * @param obj The progressbar object
17058 * @return The text label string, in UTF-8
17061 * @deprecated use elm_object_text_get() instead.
17063 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17066 * Set the icon object of the slider object.
17068 * @param obj The slider object.
17069 * @param icon The icon object.
17071 * On horizontal mode, icon is placed at left, and on vertical mode,
17074 * @note Once the icon object is set, a previously set one will be deleted.
17075 * If you want to keep that old content object, use the
17076 * elm_slider_icon_unset() function.
17078 * @warning If the object being set does not have minimum size hints set,
17079 * it won't get properly displayed.
17083 EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17086 * Unset an icon set on a given slider widget.
17088 * @param obj The slider object.
17089 * @return The icon object that was being used, if any was set, or
17090 * @c NULL, otherwise (and on errors).
17092 * On horizontal mode, icon is placed at left, and on vertical mode,
17095 * This call will unparent and return the icon object which was set
17096 * for this widget, previously, on success.
17098 * @see elm_slider_icon_set() for more details
17099 * @see elm_slider_icon_get()
17103 EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17106 * Retrieve the icon object set for a given slider widget.
17108 * @param obj The slider object.
17109 * @return The icon object's handle, if @p obj had one set, or @c NULL,
17110 * otherwise (and on errors).
17112 * On horizontal mode, icon is placed at left, and on vertical mode,
17115 * @see elm_slider_icon_set() for more details
17116 * @see elm_slider_icon_unset()
17120 EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17123 * Set the end object of the slider object.
17125 * @param obj The slider object.
17126 * @param end The end object.
17128 * On horizontal mode, end is placed at left, and on vertical mode,
17129 * placed at bottom.
17131 * @note Once the icon object is set, a previously set one will be deleted.
17132 * If you want to keep that old content object, use the
17133 * elm_slider_end_unset() function.
17135 * @warning If the object being set does not have minimum size hints set,
17136 * it won't get properly displayed.
17140 EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
17143 * Unset an end object set on a given slider widget.
17145 * @param obj The slider object.
17146 * @return The end object that was being used, if any was set, or
17147 * @c NULL, otherwise (and on errors).
17149 * On horizontal mode, end is placed at left, and on vertical mode,
17150 * placed at bottom.
17152 * This call will unparent and return the icon object which was set
17153 * for this widget, previously, on success.
17155 * @see elm_slider_end_set() for more details.
17156 * @see elm_slider_end_get()
17160 EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17163 * Retrieve the end object set for a given slider widget.
17165 * @param obj The slider object.
17166 * @return The end object's handle, if @p obj had one set, or @c NULL,
17167 * otherwise (and on errors).
17169 * On horizontal mode, icon is placed at right, and on vertical mode,
17170 * placed at bottom.
17172 * @see elm_slider_end_set() for more details.
17173 * @see elm_slider_end_unset()
17177 EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17180 * Set the (exact) length of the bar region of a given slider widget.
17182 * @param obj The slider object.
17183 * @param size The length of the slider's bar region.
17185 * This sets the minimum width (when in horizontal mode) or height
17186 * (when in vertical mode) of the actual bar area of the slider
17187 * @p obj. This in turn affects the object's minimum size. Use
17188 * this when you're not setting other size hints expanding on the
17189 * given direction (like weight and alignment hints) and you would
17190 * like it to have a specific size.
17192 * @note Icon, end, label, indicator and unit text around @p obj
17193 * will require their
17194 * own space, which will make @p obj to require more the @p size,
17197 * @see elm_slider_span_size_get()
17201 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17204 * Get the length set for the bar region of a given slider widget
17206 * @param obj The slider object.
17207 * @return The length of the slider's bar region.
17209 * If that size was not set previously, with
17210 * elm_slider_span_size_set(), this call will return @c 0.
17214 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17217 * Set the format string for the unit label.
17219 * @param obj The slider object.
17220 * @param format The format string for the unit display.
17222 * Unit label is displayed all the time, if set, after slider's bar.
17223 * In horizontal mode, at right and in vertical mode, at bottom.
17225 * If @c NULL, unit label won't be visible. If not it sets the format
17226 * string for the label text. To the label text is provided a floating point
17227 * value, so the label text can display up to 1 floating point value.
17228 * Note that this is optional.
17230 * Use a format string such as "%1.2f meters" for example, and it will
17231 * display values like: "3.14 meters" for a value equal to 3.14159.
17233 * Default is unit label disabled.
17235 * @see elm_slider_indicator_format_get()
17239 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17242 * Get the unit label format of the slider.
17244 * @param obj The slider object.
17245 * @return The unit label format string in UTF-8.
17247 * Unit label is displayed all the time, if set, after slider's bar.
17248 * In horizontal mode, at right and in vertical mode, at bottom.
17250 * @see elm_slider_unit_format_set() for more
17251 * information on how this works.
17255 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17258 * Set the format string for the indicator label.
17260 * @param obj The slider object.
17261 * @param indicator The format string for the indicator display.
17263 * The slider may display its value somewhere else then unit label,
17264 * for example, above the slider knob that is dragged around. This function
17265 * sets the format string used for this.
17267 * If @c NULL, indicator label won't be visible. If not it sets the format
17268 * string for the label text. To the label text is provided a floating point
17269 * value, so the label text can display up to 1 floating point value.
17270 * Note that this is optional.
17272 * Use a format string such as "%1.2f meters" for example, and it will
17273 * display values like: "3.14 meters" for a value equal to 3.14159.
17275 * Default is indicator label disabled.
17277 * @see elm_slider_indicator_format_get()
17281 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
17284 * Get the indicator label format of the slider.
17286 * @param obj The slider object.
17287 * @return The indicator label format string in UTF-8.
17289 * The slider may display its value somewhere else then unit label,
17290 * for example, above the slider knob that is dragged around. This function
17291 * gets the format string used for this.
17293 * @see elm_slider_indicator_format_set() for more
17294 * information on how this works.
17298 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17301 * Set the format function pointer for the indicator label
17303 * @param obj The slider object.
17304 * @param func The indicator format function.
17305 * @param free_func The freeing function for the format string.
17307 * Set the callback function to format the indicator string.
17309 * @see elm_slider_indicator_format_set() for more info on how this works.
17313 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);
17316 * Set the format function pointer for the units label
17318 * @param obj The slider object.
17319 * @param func The units format function.
17320 * @param free_func The freeing function for the format string.
17322 * Set the callback function to format the indicator string.
17324 * @see elm_slider_units_format_set() for more info on how this works.
17328 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);
17331 * Set the orientation of a given slider widget.
17333 * @param obj The slider object.
17334 * @param horizontal Use @c EINA_TRUE to make @p obj to be
17335 * @b horizontal, @c EINA_FALSE to make it @b vertical.
17337 * Use this function to change how your slider is to be
17338 * disposed: vertically or horizontally.
17340 * By default it's displayed horizontally.
17342 * @see elm_slider_horizontal_get()
17346 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17349 * Retrieve the orientation of a given slider widget
17351 * @param obj The slider object.
17352 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17353 * @c EINA_FALSE if it's @b vertical (and on errors).
17355 * @see elm_slider_horizontal_set() for more details.
17359 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17362 * Set the minimum and maximum values for the slider.
17364 * @param obj The slider object.
17365 * @param min The minimum value.
17366 * @param max The maximum value.
17368 * Define the allowed range of values to be selected by the user.
17370 * If actual value is less than @p min, it will be updated to @p min. If it
17371 * is bigger then @p max, will be updated to @p max. Actual value can be
17372 * get with elm_slider_value_get().
17374 * By default, min is equal to 0.0, and max is equal to 1.0.
17376 * @warning Maximum must be greater than minimum, otherwise behavior
17379 * @see elm_slider_min_max_get()
17383 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17386 * Get the minimum and maximum values of the slider.
17388 * @param obj The slider object.
17389 * @param min Pointer where to store the minimum value.
17390 * @param max Pointer where to store the maximum value.
17392 * @note If only one value is needed, the other pointer can be passed
17395 * @see elm_slider_min_max_set() for details.
17399 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17402 * Set the value the slider displays.
17404 * @param obj The slider object.
17405 * @param val The value to be displayed.
17407 * Value will be presented on the unit label following format specified with
17408 * elm_slider_unit_format_set() and on indicator with
17409 * elm_slider_indicator_format_set().
17411 * @warning The value must to be between min and max values. This values
17412 * are set by elm_slider_min_max_set().
17414 * @see elm_slider_value_get()
17415 * @see elm_slider_unit_format_set()
17416 * @see elm_slider_indicator_format_set()
17417 * @see elm_slider_min_max_set()
17421 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17424 * Get the value displayed by the spinner.
17426 * @param obj The spinner object.
17427 * @return The value displayed.
17429 * @see elm_spinner_value_set() for details.
17433 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17436 * Invert a given slider widget's displaying values order
17438 * @param obj The slider object.
17439 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17440 * @c EINA_FALSE to bring it back to default, non-inverted values.
17442 * A slider may be @b inverted, in which state it gets its
17443 * values inverted, with high vales being on the left or top and
17444 * low values on the right or bottom, as opposed to normally have
17445 * the low values on the former and high values on the latter,
17446 * respectively, for horizontal and vertical modes.
17448 * @see elm_slider_inverted_get()
17452 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
17455 * Get whether a given slider widget's displaying values are
17458 * @param obj The slider object.
17459 * @return @c EINA_TRUE, if @p obj has inverted values,
17460 * @c EINA_FALSE otherwise (and on errors).
17462 * @see elm_slider_inverted_set() for more details.
17466 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17469 * Set whether to enlarge slider indicator (augmented knob) or not.
17471 * @param obj The slider object.
17472 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
17473 * let the knob always at default size.
17475 * By default, indicator will be bigger while dragged by the user.
17477 * @warning It won't display values set with
17478 * elm_slider_indicator_format_set() if you disable indicator.
17482 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
17485 * Get whether a given slider widget's enlarging indicator or not.
17487 * @param obj The slider object.
17488 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
17489 * @c EINA_FALSE otherwise (and on errors).
17491 * @see elm_slider_indicator_show_set() for details.
17495 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17502 * @addtogroup Actionslider Actionslider
17504 * @image html img/widget/actionslider/preview-00.png
17505 * @image latex img/widget/actionslider/preview-00.eps
17507 * A actionslider is a switcher for 2 or 3 labels with customizable magnet
17508 * properties. The indicator is the element the user drags to choose a label.
17509 * When the position is set with magnet, when released the indicator will be
17510 * moved to it if it's nearest the magnetized position.
17512 * @note By default all positions are set as enabled.
17514 * Signals that you can add callbacks for are:
17516 * "selected" - when user selects an enabled position (the label is passed
17519 * "pos_changed" - when the indicator reaches any of the positions("left",
17520 * "right" or "center").
17522 * See an example of actionslider usage @ref actionslider_example_page "here"
17525 typedef enum _Elm_Actionslider_Pos
17527 ELM_ACTIONSLIDER_NONE = 0,
17528 ELM_ACTIONSLIDER_LEFT = 1 << 0,
17529 ELM_ACTIONSLIDER_CENTER = 1 << 1,
17530 ELM_ACTIONSLIDER_RIGHT = 1 << 2,
17531 ELM_ACTIONSLIDER_ALL = (1 << 3) -1
17532 } Elm_Actionslider_Pos;
17535 * Add a new actionslider to the parent.
17537 * @param parent The parent object
17538 * @return The new actionslider object or NULL if it cannot be created
17540 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17542 * Set actionslider labels.
17544 * @param obj The actionslider object
17545 * @param left_label The label to be set on the left.
17546 * @param center_label The label to be set on the center.
17547 * @param right_label The label to be set on the right.
17548 * @deprecated use elm_object_text_set() instead.
17550 EINA_DEPRECATED EAPI void elm_actionslider_labels_set(Evas_Object *obj, const char *left_label, const char *center_label, const char *right_label) EINA_ARG_NONNULL(1);
17552 * Get actionslider labels.
17554 * @param obj The actionslider object
17555 * @param left_label A char** to place the left_label of @p obj into.
17556 * @param center_label A char** to place the center_label of @p obj into.
17557 * @param right_label A char** to place the right_label of @p obj into.
17558 * @deprecated use elm_object_text_set() instead.
17560 EINA_DEPRECATED 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);
17562 * Get actionslider selected label.
17564 * @param obj The actionslider object
17565 * @return The selected label
17567 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17569 * Set actionslider indicator position.
17571 * @param obj The actionslider object.
17572 * @param pos The position of the indicator.
17574 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
17576 * Get actionslider indicator position.
17578 * @param obj The actionslider object.
17579 * @return The position of the indicator.
17581 EAPI Elm_Actionslider_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17583 * Set actionslider magnet position. To make multiple positions magnets @c or
17584 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
17586 * @param obj The actionslider object.
17587 * @param pos Bit mask indicating the magnet positions.
17589 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
17591 * Get actionslider magnet position.
17593 * @param obj The actionslider object.
17594 * @return The positions with magnet property.
17596 EAPI Elm_Actionslider_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17598 * Set actionslider enabled position. To set multiple positions as enabled @c or
17599 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
17601 * @note All the positions are enabled by default.
17603 * @param obj The actionslider object.
17604 * @param pos Bit mask indicating the enabled positions.
17606 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
17608 * Get actionslider enabled position.
17610 * @param obj The actionslider object.
17611 * @return The enabled positions.
17613 EAPI Elm_Actionslider_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17615 * Set the label used on the indicator.
17617 * @param obj The actionslider object
17618 * @param label The label to be set on the indicator.
17619 * @deprecated use elm_object_text_set() instead.
17621 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17623 * Get the label used on the indicator object.
17625 * @param obj The actionslider object
17626 * @return The indicator label
17627 * @deprecated use elm_object_text_get() instead.
17629 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
17635 * @defgroup Genlist Genlist
17637 * @image html img/widget/genlist/preview-00.png
17638 * @image latex img/widget/genlist/preview-00.eps
17639 * @image html img/genlist.png
17640 * @image latex img/genlist.eps
17642 * This widget aims to have more expansive list than the simple list in
17643 * Elementary that could have more flexible items and allow many more entries
17644 * while still being fast and low on memory usage. At the same time it was
17645 * also made to be able to do tree structures. But the price to pay is more
17646 * complexity when it comes to usage. If all you want is a simple list with
17647 * icons and a single label, use the normal @ref List object.
17649 * Genlist has a fairly large API, mostly because it's relatively complex,
17650 * trying to be both expansive, powerful and efficient. First we will begin
17651 * an overview on the theory behind genlist.
17653 * @section Genlist_Item_Class Genlist item classes - creating items
17655 * In order to have the ability to add and delete items on the fly, genlist
17656 * implements a class (callback) system where the application provides a
17657 * structure with information about that type of item (genlist may contain
17658 * multiple different items with different classes, states and styles).
17659 * Genlist will call the functions in this struct (methods) when an item is
17660 * "realized" (i.e., created dynamically, while the user is scrolling the
17661 * grid). All objects will simply be deleted when no longer needed with
17662 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
17663 * following members:
17664 * - @c item_style - This is a constant string and simply defines the name
17665 * of the item style. It @b must be specified and the default should be @c
17667 * - @c mode_item_style - This is a constant string and simply defines the
17668 * name of the style that will be used for mode animations. It can be left
17669 * as @c NULL if you don't plan to use Genlist mode. See
17670 * elm_genlist_item_mode_set() for more info.
17672 * - @c func - A struct with pointers to functions that will be called when
17673 * an item is going to be actually created. All of them receive a @c data
17674 * parameter that will point to the same data passed to
17675 * elm_genlist_item_append() and related item creation functions, and a @c
17676 * obj parameter that points to the genlist object itself.
17678 * The function pointers inside @c func are @c label_get, @c icon_get, @c
17679 * state_get and @c del. The 3 first functions also receive a @c part
17680 * parameter described below. A brief description of these functions follows:
17682 * - @c label_get - The @c part parameter is the name string of one of the
17683 * existing text parts in the Edje group implementing the item's theme.
17684 * This function @b must return a strdup'()ed string, as the caller will
17685 * free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
17686 * - @c icon_get - The @c part parameter is the name string of one of the
17687 * existing (icon) swallow parts in the Edje group implementing the item's
17688 * theme. It must return @c NULL, when no icon is desired, or a valid
17689 * object handle, otherwise. The object will be deleted by the genlist on
17690 * its deletion or when the item is "unrealized". See
17691 * #Elm_Genlist_Item_Icon_Get_Cb.
17692 * - @c func.state_get - The @c part parameter is the name string of one of
17693 * the state parts in the Edje group implementing the item's theme. Return
17694 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
17695 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
17696 * and @c "elm" as "emission" and "source" arguments, respectively, when
17697 * the state is true (the default is false), where @c XXX is the name of
17698 * the (state) part. See #Elm_Genlist_Item_State_Get_Cb.
17699 * - @c func.del - This is intended for use when genlist items are deleted,
17700 * so any data attached to the item (e.g. its data parameter on creation)
17701 * can be deleted. See #Elm_Genlist_Item_Del_Cb.
17703 * available item styles:
17705 * - default_style - The text part is a textblock
17707 * @image html img/widget/genlist/preview-04.png
17708 * @image latex img/widget/genlist/preview-04.eps
17712 * @image html img/widget/genlist/preview-01.png
17713 * @image latex img/widget/genlist/preview-01.eps
17715 * - icon_top_text_bottom
17717 * @image html img/widget/genlist/preview-02.png
17718 * @image latex img/widget/genlist/preview-02.eps
17722 * @image html img/widget/genlist/preview-03.png
17723 * @image latex img/widget/genlist/preview-03.eps
17725 * @section Genlist_Items Structure of items
17727 * An item in a genlist can have 0 or more text labels (they can be regular
17728 * text or textblock Evas objects - that's up to the style to determine), 0
17729 * or more icons (which are simply objects swallowed into the genlist item's
17730 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
17731 * behavior left to the user to define. The Edje part names for each of
17732 * these properties will be looked up, in the theme file for the genlist,
17733 * under the Edje (string) data items named @c "labels", @c "icons" and @c
17734 * "states", respectively. For each of those properties, if more than one
17735 * part is provided, they must have names listed separated by spaces in the
17736 * data fields. For the default genlist item theme, we have @b one label
17737 * part (@c "elm.text"), @b two icon parts (@c "elm.swalllow.icon" and @c
17738 * "elm.swallow.end") and @b no state parts.
17740 * A genlist item may be at one of several styles. Elementary provides one
17741 * by default - "default", but this can be extended by system or application
17742 * custom themes/overlays/extensions (see @ref Theme "themes" for more
17745 * @section Genlist_Manipulation Editing and Navigating
17747 * Items can be added by several calls. All of them return a @ref
17748 * Elm_Genlist_Item handle that is an internal member inside the genlist.
17749 * They all take a data parameter that is meant to be used for a handle to
17750 * the applications internal data (eg the struct with the original item
17751 * data). The parent parameter is the parent genlist item this belongs to if
17752 * it is a tree or an indexed group, and NULL if there is no parent. The
17753 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
17754 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
17755 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
17756 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
17757 * is set then this item is group index item that is displayed at the top
17758 * until the next group comes. The func parameter is a convenience callback
17759 * that is called when the item is selected and the data parameter will be
17760 * the func_data parameter, obj be the genlist object and event_info will be
17761 * the genlist item.
17763 * elm_genlist_item_append() adds an item to the end of the list, or if
17764 * there is a parent, to the end of all the child items of the parent.
17765 * elm_genlist_item_prepend() is the same but adds to the beginning of
17766 * the list or children list. elm_genlist_item_insert_before() inserts at
17767 * item before another item and elm_genlist_item_insert_after() inserts after
17768 * the indicated item.
17770 * The application can clear the list with elm_genlist_clear() which deletes
17771 * all the items in the list and elm_genlist_item_del() will delete a specific
17772 * item. elm_genlist_item_subitems_clear() will clear all items that are
17773 * children of the indicated parent item.
17775 * To help inspect list items you can jump to the item at the top of the list
17776 * with elm_genlist_first_item_get() which will return the item pointer, and
17777 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
17778 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
17779 * and previous items respectively relative to the indicated item. Using
17780 * these calls you can walk the entire item list/tree. Note that as a tree
17781 * the items are flattened in the list, so elm_genlist_item_parent_get() will
17782 * let you know which item is the parent (and thus know how to skip them if
17785 * @section Genlist_Muti_Selection Multi-selection
17787 * If the application wants multiple items to be able to be selected,
17788 * elm_genlist_multi_select_set() can enable this. If the list is
17789 * single-selection only (the default), then elm_genlist_selected_item_get()
17790 * will return the selected item, if any, or NULL I none is selected. If the
17791 * list is multi-select then elm_genlist_selected_items_get() will return a
17792 * list (that is only valid as long as no items are modified (added, deleted,
17793 * selected or unselected)).
17795 * @section Genlist_Usage_Hints Usage hints
17797 * There are also convenience functions. elm_genlist_item_genlist_get() will
17798 * return the genlist object the item belongs to. elm_genlist_item_show()
17799 * will make the scroller scroll to show that specific item so its visible.
17800 * elm_genlist_item_data_get() returns the data pointer set by the item
17801 * creation functions.
17803 * If an item changes (state of boolean changes, label or icons change),
17804 * then use elm_genlist_item_update() to have genlist update the item with
17805 * the new state. Genlist will re-realize the item thus call the functions
17806 * in the _Elm_Genlist_Item_Class for that item.
17808 * To programmatically (un)select an item use elm_genlist_item_selected_set().
17809 * To get its selected state use elm_genlist_item_selected_get(). Similarly
17810 * to expand/contract an item and get its expanded state, use
17811 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
17812 * again to make an item disabled (unable to be selected and appear
17813 * differently) use elm_genlist_item_disabled_set() to set this and
17814 * elm_genlist_item_disabled_get() to get the disabled state.
17816 * In general to indicate how the genlist should expand items horizontally to
17817 * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
17818 * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
17819 * mode means that if items are too wide to fit, the scroller will scroll
17820 * horizontally. Otherwise items are expanded to fill the width of the
17821 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
17822 * to the viewport width and limited to that size. This can be combined with
17823 * a different style that uses edjes' ellipsis feature (cutting text off like
17826 * Items will only call their selection func and callback when first becoming
17827 * selected. Any further clicks will do nothing, unless you enable always
17828 * select with elm_genlist_always_select_mode_set(). This means even if
17829 * selected, every click will make the selected callbacks be called.
17830 * elm_genlist_no_select_mode_set() will turn off the ability to select
17831 * items entirely and they will neither appear selected nor call selected
17832 * callback functions.
17834 * Remember that you can create new styles and add your own theme augmentation
17835 * per application with elm_theme_extension_add(). If you absolutely must
17836 * have a specific style that overrides any theme the user or system sets up
17837 * you can use elm_theme_overlay_add() to add such a file.
17839 * @section Genlist_Implementation Implementation
17841 * Evas tracks every object you create. Every time it processes an event
17842 * (mouse move, down, up etc.) it needs to walk through objects and find out
17843 * what event that affects. Even worse every time it renders display updates,
17844 * in order to just calculate what to re-draw, it needs to walk through many
17845 * many many objects. Thus, the more objects you keep active, the more
17846 * overhead Evas has in just doing its work. It is advisable to keep your
17847 * active objects to the minimum working set you need. Also remember that
17848 * object creation and deletion carries an overhead, so there is a
17849 * middle-ground, which is not easily determined. But don't keep massive lists
17850 * of objects you can't see or use. Genlist does this with list objects. It
17851 * creates and destroys them dynamically as you scroll around. It groups them
17852 * into blocks so it can determine the visibility etc. of a whole block at
17853 * once as opposed to having to walk the whole list. This 2-level list allows
17854 * for very large numbers of items to be in the list (tests have used up to
17855 * 2,000,000 items). Also genlist employs a queue for adding items. As items
17856 * may be different sizes, every item added needs to be calculated as to its
17857 * size and thus this presents a lot of overhead on populating the list, this
17858 * genlist employs a queue. Any item added is queued and spooled off over
17859 * time, actually appearing some time later, so if your list has many members
17860 * you may find it takes a while for them to all appear, with your process
17861 * consuming a lot of CPU while it is busy spooling.
17863 * Genlist also implements a tree structure, but it does so with callbacks to
17864 * the application, with the application filling in tree structures when
17865 * requested (allowing for efficient building of a very deep tree that could
17866 * even be used for file-management). See the above smart signal callbacks for
17869 * @section Genlist_Smart_Events Genlist smart events
17871 * Signals that you can add callbacks for are:
17872 * - @c "activated" - The user has double-clicked or pressed
17873 * (enter|return|spacebar) on an item. The @c event_info parameter is the
17874 * item that was activated.
17875 * - @c "clicked,double" - The user has double-clicked an item. The @c
17876 * event_info parameter is the item that was double-clicked.
17877 * - @c "selected" - This is called when a user has made an item selected.
17878 * The event_info parameter is the genlist item that was selected.
17879 * - @c "unselected" - This is called when a user has made an item
17880 * unselected. The event_info parameter is the genlist item that was
17882 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
17883 * called and the item is now meant to be expanded. The event_info
17884 * parameter is the genlist item that was indicated to expand. It is the
17885 * job of this callback to then fill in the child items.
17886 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
17887 * called and the item is now meant to be contracted. The event_info
17888 * parameter is the genlist item that was indicated to contract. It is the
17889 * job of this callback to then delete the child items.
17890 * - @c "expand,request" - This is called when a user has indicated they want
17891 * to expand a tree branch item. The callback should decide if the item can
17892 * expand (has any children) and then call elm_genlist_item_expanded_set()
17893 * appropriately to set the state. The event_info parameter is the genlist
17894 * item that was indicated to expand.
17895 * - @c "contract,request" - This is called when a user has indicated they
17896 * want to contract a tree branch item. The callback should decide if the
17897 * item can contract (has any children) and then call
17898 * elm_genlist_item_expanded_set() appropriately to set the state. The
17899 * event_info parameter is the genlist item that was indicated to contract.
17900 * - @c "realized" - This is called when the item in the list is created as a
17901 * real evas object. event_info parameter is the genlist item that was
17902 * created. The object may be deleted at any time, so it is up to the
17903 * caller to not use the object pointer from elm_genlist_item_object_get()
17904 * in a way where it may point to freed objects.
17905 * - @c "unrealized" - This is called just before an item is unrealized.
17906 * After this call icon objects provided will be deleted and the item
17907 * object itself delete or be put into a floating cache.
17908 * - @c "drag,start,up" - This is called when the item in the list has been
17909 * dragged (not scrolled) up.
17910 * - @c "drag,start,down" - This is called when the item in the list has been
17911 * dragged (not scrolled) down.
17912 * - @c "drag,start,left" - This is called when the item in the list has been
17913 * dragged (not scrolled) left.
17914 * - @c "drag,start,right" - This is called when the item in the list has
17915 * been dragged (not scrolled) right.
17916 * - @c "drag,stop" - This is called when the item in the list has stopped
17918 * - @c "drag" - This is called when the item in the list is being dragged.
17919 * - @c "longpressed" - This is called when the item is pressed for a certain
17920 * amount of time. By default it's 1 second.
17921 * - @c "scroll,anim,start" - This is called when scrolling animation has
17923 * - @c "scroll,anim,stop" - This is called when scrolling animation has
17925 * - @c "scroll,drag,start" - This is called when dragging the content has
17927 * - @c "scroll,drag,stop" - This is called when dragging the content has
17929 * - @c "scroll,edge,top" - This is called when the genlist is scrolled until
17931 * - @c "scroll,edge,bottom" - This is called when the genlist is scrolled
17932 * until the bottom edge.
17933 * - @c "scroll,edge,left" - This is called when the genlist is scrolled
17934 * until the left edge.
17935 * - @c "scroll,edge,right" - This is called when the genlist is scrolled
17936 * until the right edge.
17937 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
17939 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
17941 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
17943 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
17945 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
17946 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
17947 * multi-touch pinched in.
17948 * - @c "swipe" - This is called when the genlist is swiped.
17950 * @section Genlist_Examples Examples
17952 * Here is a list of examples that use the genlist, trying to show some of
17953 * its capabilities:
17954 * - @ref genlist_example_01
17955 * - @ref genlist_example_02
17956 * - @ref genlist_example_03
17957 * - @ref genlist_example_04
17958 * - @ref genlist_example_05
17962 * @addtogroup Genlist
17967 * @enum _Elm_Genlist_Item_Flags
17968 * @typedef Elm_Genlist_Item_Flags
17970 * Defines if the item is of any special type (has subitems or it's the
17971 * index of a group), or is just a simple item.
17975 typedef enum _Elm_Genlist_Item_Flags
17977 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
17978 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
17979 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
17980 } Elm_Genlist_Item_Flags;
17981 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
17982 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
17983 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
17984 typedef char *(*Elm_Genlist_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
17985 typedef Evas_Object *(*Elm_Genlist_Item_Icon_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Icon fetching class function for genlist item classes. */
17986 typedef Eina_Bool (*Elm_Genlist_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for genlist item classes. */
17987 typedef void (*Elm_Genlist_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
17988 typedef void (*GenlistItemMovedFunc) (Evas_Object *obj, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after); /** TODO: remove this by SeoZ **/
17990 typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Label_Get_Cb instead. */
17991 typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Icon_Get_Cb instead. */
17992 typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_State_Get_Cb instead. */
17993 typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Del_Cb instead. */
17996 * @struct _Elm_Genlist_Item_Class
17998 * Genlist item class definition structs.
18000 * This struct contains the style and fetching functions that will define the
18001 * contents of each item.
18003 * @see @ref Genlist_Item_Class
18005 struct _Elm_Genlist_Item_Class
18007 const char *item_style; /**< style of this class. */
18010 Elm_Genlist_Item_Label_Get_Cb label_get; /**< Label fetching class function for genlist item classes.*/
18011 Elm_Genlist_Item_Icon_Get_Cb icon_get; /**< Icon fetching class function for genlist item classes. */
18012 Elm_Genlist_Item_State_Get_Cb state_get; /**< State fetching class function for genlist item classes. */
18013 Elm_Genlist_Item_Del_Cb del; /**< Deletion class function for genlist item classes. */
18014 GenlistItemMovedFunc moved; // TODO: do not use this. change this to smart callback.
18016 const char *mode_item_style;
18020 * Add a new genlist widget to the given parent Elementary
18021 * (container) object
18023 * @param parent The parent object
18024 * @return a new genlist widget handle or @c NULL, on errors
18026 * This function inserts a new genlist widget on the canvas.
18028 * @see elm_genlist_item_append()
18029 * @see elm_genlist_item_del()
18030 * @see elm_genlist_clear()
18034 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18036 * Remove all items from a given genlist widget.
18038 * @param obj The genlist object
18040 * This removes (and deletes) all items in @p obj, leaving it empty.
18042 * @see elm_genlist_item_del(), to remove just one item.
18046 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18048 * Enable or disable multi-selection in the genlist
18050 * @param obj The genlist object
18051 * @param multi Multi-select enable/disable. Default is disabled.
18053 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
18054 * the list. This allows more than 1 item to be selected. To retrieve the list
18055 * of selected items, use elm_genlist_selected_items_get().
18057 * @see elm_genlist_selected_items_get()
18058 * @see elm_genlist_multi_select_get()
18062 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
18064 * Gets if multi-selection in genlist is enabled or disabled.
18066 * @param obj The genlist object
18067 * @return Multi-select enabled/disabled
18068 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
18070 * @see elm_genlist_multi_select_set()
18074 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18076 * This sets the horizontal stretching mode.
18078 * @param obj The genlist object
18079 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
18081 * This sets the mode used for sizing items horizontally. Valid modes
18082 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
18083 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
18084 * the scroller will scroll horizontally. Otherwise items are expanded
18085 * to fill the width of the viewport of the scroller. If it is
18086 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
18087 * limited to that size.
18089 * @see elm_genlist_horizontal_get()
18093 EAPI void elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18094 EINA_DEPRECATED EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18096 * Gets the horizontal stretching mode.
18098 * @param obj The genlist object
18099 * @return The mode to use
18100 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
18102 * @see elm_genlist_horizontal_set()
18106 EAPI Elm_List_Mode elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18107 EINA_DEPRECATED EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18109 * Set the always select mode.
18111 * @param obj The genlist object
18112 * @param always_select The always select mode (@c EINA_TRUE = on, @c
18113 * EINA_FALSE = off). Default is @c EINA_FALSE.
18115 * Items will only call their selection func and callback when first
18116 * becoming selected. Any further clicks will do nothing, unless you
18117 * enable always select with elm_genlist_always_select_mode_set().
18118 * This means that, even if selected, every click will make the selected
18119 * callbacks be called.
18121 * @see elm_genlist_always_select_mode_get()
18125 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
18127 * Get the always select mode.
18129 * @param obj The genlist object
18130 * @return The always select mode
18131 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18133 * @see elm_genlist_always_select_mode_set()
18137 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18139 * Enable/disable the no select mode.
18141 * @param obj The genlist object
18142 * @param no_select The no select mode
18143 * (EINA_TRUE = on, EINA_FALSE = off)
18145 * This will turn off the ability to select items entirely and they
18146 * will neither appear selected nor call selected callback functions.
18148 * @see elm_genlist_no_select_mode_get()
18152 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
18154 * Gets whether the no select mode is enabled.
18156 * @param obj The genlist object
18157 * @return The no select mode
18158 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18160 * @see elm_genlist_no_select_mode_set()
18164 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18166 * Enable/disable compress mode.
18168 * @param obj The genlist object
18169 * @param compress The compress mode
18170 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
18172 * This will enable the compress mode where items are "compressed"
18173 * horizontally to fit the genlist scrollable viewport width. This is
18174 * special for genlist. Do not rely on
18175 * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
18176 * work as genlist needs to handle it specially.
18178 * @see elm_genlist_compress_mode_get()
18182 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
18184 * Get whether the compress mode is enabled.
18186 * @param obj The genlist object
18187 * @return The compress mode
18188 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18190 * @see elm_genlist_compress_mode_set()
18194 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18196 * Enable/disable height-for-width mode.
18198 * @param obj The genlist object
18199 * @param setting The height-for-width mode (@c EINA_TRUE = on,
18200 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
18202 * With height-for-width mode the item width will be fixed (restricted
18203 * to a minimum of) to the list width when calculating its size in
18204 * order to allow the height to be calculated based on it. This allows,
18205 * for instance, text block to wrap lines if the Edje part is
18206 * configured with "text.min: 0 1".
18208 * @note This mode will make list resize slower as it will have to
18209 * recalculate every item height again whenever the list width
18212 * @note When height-for-width mode is enabled, it also enables
18213 * compress mode (see elm_genlist_compress_mode_set()) and
18214 * disables homogeneous (see elm_genlist_homogeneous_set()).
18218 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
18220 * Get whether the height-for-width mode is enabled.
18222 * @param obj The genlist object
18223 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
18228 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18230 * Enable/disable horizontal and vertical bouncing effect.
18232 * @param obj The genlist object
18233 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
18234 * EINA_FALSE = off). Default is @c EINA_FALSE.
18235 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
18236 * EINA_FALSE = off). Default is @c EINA_TRUE.
18238 * This will enable or disable the scroller bouncing effect for the
18239 * genlist. See elm_scroller_bounce_set() for details.
18241 * @see elm_scroller_bounce_set()
18242 * @see elm_genlist_bounce_get()
18246 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18248 * Get whether the horizontal and vertical bouncing effect is enabled.
18250 * @param obj The genlist object
18251 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
18253 * @param v_bounce Pointer to a bool to receive if the bounce vertically
18256 * @see elm_genlist_bounce_set()
18260 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18262 * Enable/disable homogenous mode.
18264 * @param obj The genlist object
18265 * @param homogeneous Assume the items within the genlist are of the
18266 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
18269 * This will enable the homogeneous mode where items are of the same
18270 * height and width so that genlist may do the lazy-loading at its
18271 * maximum (which increases the performance for scrolling the list). This
18272 * implies 'compressed' mode.
18274 * @see elm_genlist_compress_mode_set()
18275 * @see elm_genlist_homogeneous_get()
18279 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
18281 * Get whether the homogenous mode is enabled.
18283 * @param obj The genlist object
18284 * @return Assume the items within the genlist are of the same height
18285 * and width (EINA_TRUE = on, EINA_FALSE = off)
18287 * @see elm_genlist_homogeneous_set()
18291 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18293 * Set the maximum number of items within an item block
18295 * @param obj The genlist object
18296 * @param n Maximum number of items within an item block. Default is 32.
18298 * This will configure the block count to tune to the target with
18299 * particular performance matrix.
18301 * A block of objects will be used to reduce the number of operations due to
18302 * many objects in the screen. It can determine the visibility, or if the
18303 * object has changed, it theme needs to be updated, etc. doing this kind of
18304 * calculation to the entire block, instead of per object.
18306 * The default value for the block count is enough for most lists, so unless
18307 * you know you will have a lot of objects visible in the screen at the same
18308 * time, don't try to change this.
18310 * @see elm_genlist_block_count_get()
18311 * @see @ref Genlist_Implementation
18315 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
18317 * Get the maximum number of items within an item block
18319 * @param obj The genlist object
18320 * @return Maximum number of items within an item block
18322 * @see elm_genlist_block_count_set()
18326 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18328 * Set the timeout in seconds for the longpress event.
18330 * @param obj The genlist object
18331 * @param timeout timeout in seconds. Default is 1.
18333 * This option will change how long it takes to send an event "longpressed"
18334 * after the mouse down signal is sent to the list. If this event occurs, no
18335 * "clicked" event will be sent.
18337 * @see elm_genlist_longpress_timeout_set()
18341 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18343 * Get the timeout in seconds for the longpress event.
18345 * @param obj The genlist object
18346 * @return timeout in seconds
18348 * @see elm_genlist_longpress_timeout_get()
18352 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18354 * Append a new item in a given genlist widget.
18356 * @param obj The genlist object
18357 * @param itc The item class for the item
18358 * @param data The item data
18359 * @param parent The parent item, or NULL if none
18360 * @param flags Item flags
18361 * @param func Convenience function called when the item is selected
18362 * @param func_data Data passed to @p func above.
18363 * @return A handle to the item added or @c NULL if not possible
18365 * This adds the given item to the end of the list or the end of
18366 * the children list if the @p parent is given.
18368 * @see elm_genlist_item_prepend()
18369 * @see elm_genlist_item_insert_before()
18370 * @see elm_genlist_item_insert_after()
18371 * @see elm_genlist_item_del()
18375 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);
18377 * Prepend a new item in a given genlist widget.
18379 * @param obj The genlist object
18380 * @param itc The item class for the item
18381 * @param data The item data
18382 * @param parent The parent item, or NULL if none
18383 * @param flags Item flags
18384 * @param func Convenience function called when the item is selected
18385 * @param func_data Data passed to @p func above.
18386 * @return A handle to the item added or NULL if not possible
18388 * This adds an item to the beginning of the list or beginning of the
18389 * children of the parent if given.
18391 * @see elm_genlist_item_append()
18392 * @see elm_genlist_item_insert_before()
18393 * @see elm_genlist_item_insert_after()
18394 * @see elm_genlist_item_del()
18398 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);
18400 * Insert an item before another in a genlist widget
18402 * @param obj The genlist object
18403 * @param itc The item class for the item
18404 * @param data The item data
18405 * @param before The item to place this new one before.
18406 * @param flags Item flags
18407 * @param func Convenience function called when the item is selected
18408 * @param func_data Data passed to @p func above.
18409 * @return A handle to the item added or @c NULL if not possible
18411 * This inserts an item before another in the list. It will be in the
18412 * same tree level or group as the item it is inserted before.
18414 * @see elm_genlist_item_append()
18415 * @see elm_genlist_item_prepend()
18416 * @see elm_genlist_item_insert_after()
18417 * @see elm_genlist_item_del()
18421 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);
18423 * Insert an item after another in a genlist widget
18425 * @param obj The genlist object
18426 * @param itc The item class for the item
18427 * @param data The item data
18428 * @param after The item to place this new one after.
18429 * @param flags Item flags
18430 * @param func Convenience function called when the item is selected
18431 * @param func_data Data passed to @p func above.
18432 * @return A handle to the item added or @c NULL if not possible
18434 * This inserts an item after another in the list. It will be in the
18435 * same tree level or group as the item it is inserted after.
18437 * @see elm_genlist_item_append()
18438 * @see elm_genlist_item_prepend()
18439 * @see elm_genlist_item_insert_before()
18440 * @see elm_genlist_item_del()
18444 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);
18446 * Insert a new item into the sorted genlist object
18448 * @param obj The genlist object
18449 * @param itc The item class for the item
18450 * @param data The item data
18451 * @param parent The parent item, or NULL if none
18452 * @param flags Item flags
18453 * @param comp The function called for the sort
18454 * @param func Convenience function called when item selected
18455 * @param func_data Data passed to @p func above.
18456 * @return A handle to the item added or NULL if not possible
18460 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);
18461 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);
18462 /* operations to retrieve existing items */
18464 * Get the selectd item in the genlist.
18466 * @param obj The genlist object
18467 * @return The selected item, or NULL if none is selected.
18469 * This gets the selected item in the list (if multi-selection is enabled, only
18470 * the item that was first selected in the list is returned - which is not very
18471 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
18474 * If no item is selected, NULL is returned.
18476 * @see elm_genlist_selected_items_get()
18480 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18482 * Get a list of selected items in the genlist.
18484 * @param obj The genlist object
18485 * @return The list of selected items, or NULL if none are selected.
18487 * It returns a list of the selected items. This list pointer is only valid so
18488 * long as the selection doesn't change (no items are selected or unselected, or
18489 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
18490 * pointers. The order of the items in this list is the order which they were
18491 * selected, i.e. the first item in this list is the first item that was
18492 * selected, and so on.
18494 * @note If not in multi-select mode, consider using function
18495 * elm_genlist_selected_item_get() instead.
18497 * @see elm_genlist_multi_select_set()
18498 * @see elm_genlist_selected_item_get()
18502 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18504 * Get a list of realized items in genlist
18506 * @param obj The genlist object
18507 * @return The list of realized items, nor NULL if none are realized.
18509 * This returns a list of the realized items in the genlist. The list
18510 * contains Elm_Genlist_Item pointers. The list must be freed by the
18511 * caller when done with eina_list_free(). The item pointers in the
18512 * list are only valid so long as those items are not deleted or the
18513 * genlist is not deleted.
18515 * @see elm_genlist_realized_items_update()
18519 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18521 * Get the item that is at the x, y canvas coords.
18523 * @param obj The gelinst object.
18524 * @param x The input x coordinate
18525 * @param y The input y coordinate
18526 * @param posret The position relative to the item returned here
18527 * @return The item at the coordinates or NULL if none
18529 * This returns the item at the given coordinates (which are canvas
18530 * relative, not object-relative). If an item is at that coordinate,
18531 * that item handle is returned, and if @p posret is not NULL, the
18532 * integer pointed to is set to a value of -1, 0 or 1, depending if
18533 * the coordinate is on the upper portion of that item (-1), on the
18534 * middle section (0) or on the lower part (1). If NULL is returned as
18535 * an item (no item found there), then posret may indicate -1 or 1
18536 * based if the coordinate is above or below all items respectively in
18541 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);
18543 * Get the first item in the genlist
18545 * This returns the first item in the list.
18547 * @param obj The genlist object
18548 * @return The first item, or NULL if none
18552 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18554 * Get the last item in the genlist
18556 * This returns the last item in the list.
18558 * @return The last item, or NULL if none
18562 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18564 * Set the scrollbar policy
18566 * @param obj The genlist object
18567 * @param policy_h Horizontal scrollbar policy.
18568 * @param policy_v Vertical scrollbar policy.
18570 * This sets the scrollbar visibility policy for the given genlist
18571 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
18572 * made visible if it is needed, and otherwise kept hidden.
18573 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
18574 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
18575 * respectively for the horizontal and vertical scrollbars. Default is
18576 * #ELM_SMART_SCROLLER_POLICY_AUTO
18578 * @see elm_genlist_scroller_policy_get()
18582 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
18584 * Get the scrollbar policy
18586 * @param obj The genlist object
18587 * @param policy_h Pointer to store the horizontal scrollbar policy.
18588 * @param policy_v Pointer to store the vertical scrollbar policy.
18590 * @see elm_genlist_scroller_policy_set()
18594 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);
18596 * Get the @b next item in a genlist widget's internal list of items,
18597 * given a handle to one of those items.
18599 * @param item The genlist item to fetch next from
18600 * @return The item after @p item, or @c NULL if there's none (and
18603 * This returns the item placed after the @p item, on the container
18606 * @see elm_genlist_item_prev_get()
18610 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18612 * Get the @b previous item in a genlist widget's internal list of items,
18613 * given a handle to one of those items.
18615 * @param item The genlist item to fetch previous from
18616 * @return The item before @p item, or @c NULL if there's none (and
18619 * This returns the item placed before the @p item, on the container
18622 * @see elm_genlist_item_next_get()
18626 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18628 * Get the genlist object's handle which contains a given genlist
18631 * @param item The item to fetch the container from
18632 * @return The genlist (parent) object
18634 * This returns the genlist object itself that an item belongs to.
18638 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18640 * Get the parent item of the given item
18642 * @param it The item
18643 * @return The parent of the item or @c NULL if it has no parent.
18645 * This returns the item that was specified as parent of the item @p it on
18646 * elm_genlist_item_append() and insertion related functions.
18650 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18652 * Remove all sub-items (children) of the given item
18654 * @param it The item
18656 * This removes all items that are children (and their descendants) of the
18657 * given item @p it.
18659 * @see elm_genlist_clear()
18660 * @see elm_genlist_item_del()
18664 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18666 * Set whether a given genlist item is selected or not
18668 * @param it The item
18669 * @param selected Use @c EINA_TRUE, to make it selected, @c
18670 * EINA_FALSE to make it unselected
18672 * This sets the selected state of an item. If multi selection is
18673 * not enabled on the containing genlist and @p selected is @c
18674 * EINA_TRUE, any other previously selected items will get
18675 * unselected in favor of this new one.
18677 * @see elm_genlist_item_selected_get()
18681 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
18683 * Get whether a given genlist item is selected or not
18685 * @param it The item
18686 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
18688 * @see elm_genlist_item_selected_set() for more details
18692 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18694 * Sets the expanded state of an item.
18696 * @param it The item
18697 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
18699 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
18702 * The theme will respond to this change visually, and a signal "expanded" or
18703 * "contracted" will be sent from the genlist with a pointer to the item that
18704 * has been expanded/contracted.
18706 * Calling this function won't show or hide any child of this item (if it is
18707 * a parent). You must manually delete and create them on the callbacks fo
18708 * the "expanded" or "contracted" signals.
18710 * @see elm_genlist_item_expanded_get()
18714 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
18716 * Get the expanded state of an item
18718 * @param it The item
18719 * @return The expanded state
18721 * This gets the expanded state of an item.
18723 * @see elm_genlist_item_expanded_set()
18727 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18729 * Get the depth of expanded item
18731 * @param it The genlist item object
18732 * @return The depth of expanded item
18736 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18738 * Set whether a given genlist item is disabled or not.
18740 * @param it The item
18741 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
18742 * to enable it back.
18744 * A disabled item cannot be selected or unselected. It will also
18745 * change its appearance, to signal the user it's disabled.
18747 * @see elm_genlist_item_disabled_get()
18751 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
18753 * Get whether a given genlist item is disabled or not.
18755 * @param it The item
18756 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
18759 * @see elm_genlist_item_disabled_set() for more details
18763 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18765 * Sets the display only state of an item.
18767 * @param it The item
18768 * @param display_only @c EINA_TRUE if the item is display only, @c
18769 * EINA_FALSE otherwise.
18771 * A display only item cannot be selected or unselected. It is for
18772 * display only and not selecting or otherwise clicking, dragging
18773 * etc. by the user, thus finger size rules will not be applied to
18776 * It's good to set group index items to display only state.
18778 * @see elm_genlist_item_display_only_get()
18782 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
18784 * Get the display only state of an item
18786 * @param it The item
18787 * @return @c EINA_TRUE if the item is display only, @c
18788 * EINA_FALSE otherwise.
18790 * @see elm_genlist_item_display_only_set()
18794 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18796 * Show the portion of a genlist's internal list containing a given
18797 * item, immediately.
18799 * @param it The item to display
18801 * This causes genlist to jump to the given item @p it and show it (by
18802 * immediately scrolling to that position), if it is not fully visible.
18804 * @see elm_genlist_item_bring_in()
18805 * @see elm_genlist_item_top_show()
18806 * @see elm_genlist_item_middle_show()
18810 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18812 * Animatedly bring in, to the visible are of a genlist, a given
18815 * @param it The item to display
18817 * This causes genlist to jump to the given item @p it and show it (by
18818 * animatedly scrolling), if it is not fully visible. This may use animation
18819 * to do so and take a period of time
18821 * @see elm_genlist_item_show()
18822 * @see elm_genlist_item_top_bring_in()
18823 * @see elm_genlist_item_middle_bring_in()
18827 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18829 * Show the portion of a genlist's internal list containing a given
18830 * item, immediately.
18832 * @param it The item to display
18834 * This causes genlist to jump to the given item @p it and show it (by
18835 * immediately scrolling to that position), if it is not fully visible.
18837 * The item will be positioned at the top of the genlist viewport.
18839 * @see elm_genlist_item_show()
18840 * @see elm_genlist_item_top_bring_in()
18844 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18846 * Animatedly bring in, to the visible are of a genlist, a given
18849 * @param it The item
18851 * This causes genlist to jump to the given item @p it and show it (by
18852 * animatedly scrolling), if it is not fully visible. This may use animation
18853 * to do so and take a period of time
18855 * The item will be positioned at the top of the genlist viewport.
18857 * @see elm_genlist_item_bring_in()
18858 * @see elm_genlist_item_top_show()
18862 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18864 * Show the portion of a genlist's internal list containing a given
18865 * item, immediately.
18867 * @param it The item to display
18869 * This causes genlist to jump to the given item @p it and show it (by
18870 * immediately scrolling to that position), if it is not fully visible.
18872 * The item will be positioned at the middle of the genlist viewport.
18874 * @see elm_genlist_item_show()
18875 * @see elm_genlist_item_middle_bring_in()
18879 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18881 * Animatedly bring in, to the visible are of a genlist, a given
18884 * @param it The item
18886 * This causes genlist to jump to the given item @p it and show it (by
18887 * animatedly scrolling), if it is not fully visible. This may use animation
18888 * to do so and take a period of time
18890 * The item will be positioned at the middle of the genlist viewport.
18892 * @see elm_genlist_item_bring_in()
18893 * @see elm_genlist_item_middle_show()
18897 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18899 * Remove a genlist item from the its parent, deleting it.
18901 * @param item The item to be removed.
18902 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
18904 * @see elm_genlist_clear(), to remove all items in a genlist at
18909 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18911 * Return the data associated to a given genlist item
18913 * @param item The genlist item.
18914 * @return the data associated to this item.
18916 * This returns the @c data value passed on the
18917 * elm_genlist_item_append() and related item addition calls.
18919 * @see elm_genlist_item_append()
18920 * @see elm_genlist_item_data_set()
18924 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18926 * Set the data associated to a given genlist item
18928 * @param item The genlist item
18929 * @param data The new data pointer to set on it
18931 * This @b overrides the @c data value passed on the
18932 * elm_genlist_item_append() and related item addition calls. This
18933 * function @b won't call elm_genlist_item_update() automatically,
18934 * so you'd issue it afterwards if you want to hove the item
18935 * updated to reflect the that new data.
18937 * @see elm_genlist_item_data_get()
18941 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
18943 * Tells genlist to "orphan" icons fetchs by the item class
18945 * @param it The item
18947 * This instructs genlist to release references to icons in the item,
18948 * meaning that they will no longer be managed by genlist and are
18949 * floating "orphans" that can be re-used elsewhere if the user wants
18954 EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18956 * Get the real Evas object created to implement the view of a
18957 * given genlist item
18959 * @param item The genlist item.
18960 * @return the Evas object implementing this item's view.
18962 * This returns the actual Evas object used to implement the
18963 * specified genlist item's view. This may be @c NULL, as it may
18964 * not have been created or may have been deleted, at any time, by
18965 * the genlist. <b>Do not modify this object</b> (move, resize,
18966 * show, hide, etc.), as the genlist is controlling it. This
18967 * function is for querying, emitting custom signals or hooking
18968 * lower level callbacks for events on that object. Do not delete
18969 * this object under any circumstances.
18971 * @see elm_genlist_item_data_get()
18975 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18977 * Update the contents of an item
18979 * @param it The item
18981 * This updates an item by calling all the item class functions again
18982 * to get the icons, labels and states. Use this when the original
18983 * item data has changed and the changes are desired to be reflected.
18985 * Use elm_genlist_realized_items_update() to update all already realized
18988 * @see elm_genlist_realized_items_update()
18992 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18994 * Update the item class of an item
18996 * @param it The item
18997 * @param itc The item class for the item
18999 * This sets another class fo the item, changing the way that it is
19000 * displayed. After changing the item class, elm_genlist_item_update() is
19001 * called on the item @p it.
19005 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
19006 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19008 * Set the text to be shown in a given genlist item's tooltips.
19010 * @param item The genlist item
19011 * @param text The text to set in the content
19013 * This call will setup the text to be used as tooltip to that item
19014 * (analogous to elm_object_tooltip_text_set(), but being item
19015 * tooltips with higher precedence than object tooltips). It can
19016 * have only one tooltip at a time, so any previous tooltip data
19017 * will get removed.
19019 * In order to set an icon or something else as a tooltip, look at
19020 * elm_genlist_item_tooltip_content_cb_set().
19024 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
19026 * Set the content to be shown in a given genlist item's tooltips
19028 * @param item The genlist item.
19029 * @param func The function returning the tooltip contents.
19030 * @param data What to provide to @a func as callback data/context.
19031 * @param del_cb Called when data is not needed anymore, either when
19032 * another callback replaces @p func, the tooltip is unset with
19033 * elm_genlist_item_tooltip_unset() or the owner @p item
19034 * dies. This callback receives as its first parameter the
19035 * given @p data, being @c event_info the item handle.
19037 * This call will setup the tooltip's contents to @p item
19038 * (analogous to elm_object_tooltip_content_cb_set(), but being
19039 * item tooltips with higher precedence than object tooltips). It
19040 * can have only one tooltip at a time, so any previous tooltip
19041 * content will get removed. @p func (with @p data) will be called
19042 * every time Elementary needs to show the tooltip and it should
19043 * return a valid Evas object, which will be fully managed by the
19044 * tooltip system, getting deleted when the tooltip is gone.
19046 * In order to set just a text as a tooltip, look at
19047 * elm_genlist_item_tooltip_text_set().
19051 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);
19053 * Unset a tooltip from a given genlist item
19055 * @param item genlist item to remove a previously set tooltip from.
19057 * This call removes any tooltip set on @p item. The callback
19058 * provided as @c del_cb to
19059 * elm_genlist_item_tooltip_content_cb_set() will be called to
19060 * notify it is not used anymore (and have resources cleaned, if
19063 * @see elm_genlist_item_tooltip_content_cb_set()
19067 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19069 * Set a different @b style for a given genlist item's tooltip.
19071 * @param item genlist item with tooltip set
19072 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
19073 * "default", @c "transparent", etc)
19075 * Tooltips can have <b>alternate styles</b> to be displayed on,
19076 * which are defined by the theme set on Elementary. This function
19077 * works analogously as elm_object_tooltip_style_set(), but here
19078 * applied only to genlist item objects. The default style for
19079 * tooltips is @c "default".
19081 * @note before you set a style you should define a tooltip with
19082 * elm_genlist_item_tooltip_content_cb_set() or
19083 * elm_genlist_item_tooltip_text_set()
19085 * @see elm_genlist_item_tooltip_style_get()
19089 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19091 * Get the style set a given genlist item's tooltip.
19093 * @param item genlist item with tooltip already set on.
19094 * @return style the theme style in use, which defaults to
19095 * "default". If the object does not have a tooltip set,
19096 * then @c NULL is returned.
19098 * @see elm_genlist_item_tooltip_style_set() for more details
19102 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19104 * @brief Disable size restrictions on an object's tooltip
19105 * @param item The tooltip's anchor object
19106 * @param disable If EINA_TRUE, size restrictions are disabled
19107 * @return EINA_FALSE on failure, EINA_TRUE on success
19109 * This function allows a tooltip to expand beyond its parant window's canvas.
19110 * It will instead be limited only by the size of the display.
19112 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
19114 * @brief Retrieve size restriction state of an object's tooltip
19115 * @param item The tooltip's anchor object
19116 * @return If EINA_TRUE, size restrictions are disabled
19118 * This function returns whether a tooltip is allowed to expand beyond
19119 * its parant window's canvas.
19120 * It will instead be limited only by the size of the display.
19122 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
19124 * Set the type of mouse pointer/cursor decoration to be shown,
19125 * when the mouse pointer is over the given genlist widget item
19127 * @param item genlist item to customize cursor on
19128 * @param cursor the cursor type's name
19130 * This function works analogously as elm_object_cursor_set(), but
19131 * here the cursor's changing area is restricted to the item's
19132 * area, and not the whole widget's. Note that that item cursors
19133 * have precedence over widget cursors, so that a mouse over @p
19134 * item will always show cursor @p type.
19136 * If this function is called twice for an object, a previously set
19137 * cursor will be unset on the second call.
19139 * @see elm_object_cursor_set()
19140 * @see elm_genlist_item_cursor_get()
19141 * @see elm_genlist_item_cursor_unset()
19145 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
19147 * Get the type of mouse pointer/cursor decoration set to be shown,
19148 * when the mouse pointer is over the given genlist widget item
19150 * @param item genlist item with custom cursor set
19151 * @return the cursor type's name or @c NULL, if no custom cursors
19152 * were set to @p item (and on errors)
19154 * @see elm_object_cursor_get()
19155 * @see elm_genlist_item_cursor_set() for more details
19156 * @see elm_genlist_item_cursor_unset()
19160 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19162 * Unset any custom mouse pointer/cursor decoration set to be
19163 * shown, when the mouse pointer is over the given genlist widget
19164 * item, thus making it show the @b default cursor again.
19166 * @param item a genlist item
19168 * Use this call to undo any custom settings on this item's cursor
19169 * decoration, bringing it back to defaults (no custom style set).
19171 * @see elm_object_cursor_unset()
19172 * @see elm_genlist_item_cursor_set() for more details
19176 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19178 * Set a different @b style for a given custom cursor set for a
19181 * @param item genlist item with custom cursor set
19182 * @param style the <b>theme style</b> to use (e.g. @c "default",
19183 * @c "transparent", etc)
19185 * This function only makes sense when one is using custom mouse
19186 * cursor decorations <b>defined in a theme file</b> , which can
19187 * have, given a cursor name/type, <b>alternate styles</b> on
19188 * it. It works analogously as elm_object_cursor_style_set(), but
19189 * here applied only to genlist item objects.
19191 * @warning Before you set a cursor style you should have defined a
19192 * custom cursor previously on the item, with
19193 * elm_genlist_item_cursor_set()
19195 * @see elm_genlist_item_cursor_engine_only_set()
19196 * @see elm_genlist_item_cursor_style_get()
19200 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19202 * Get the current @b style set for a given genlist item's custom
19205 * @param item genlist item with custom cursor set.
19206 * @return style the cursor style in use. If the object does not
19207 * have a cursor set, then @c NULL is returned.
19209 * @see elm_genlist_item_cursor_style_set() for more details
19213 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19215 * Set if the (custom) cursor for a given genlist item should be
19216 * searched in its theme, also, or should only rely on the
19217 * rendering engine.
19219 * @param item item with custom (custom) cursor already set on
19220 * @param engine_only Use @c EINA_TRUE to have cursors looked for
19221 * only on those provided by the rendering engine, @c EINA_FALSE to
19222 * have them searched on the widget's theme, as well.
19224 * @note This call is of use only if you've set a custom cursor
19225 * for genlist items, with elm_genlist_item_cursor_set().
19227 * @note By default, cursors will only be looked for between those
19228 * provided by the rendering engine.
19232 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
19234 * Get if the (custom) cursor for a given genlist item is being
19235 * searched in its theme, also, or is only relying on the rendering
19238 * @param item a genlist item
19239 * @return @c EINA_TRUE, if cursors are being looked for only on
19240 * those provided by the rendering engine, @c EINA_FALSE if they
19241 * are being searched on the widget's theme, as well.
19243 * @see elm_genlist_item_cursor_engine_only_set(), for more details
19247 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19249 * Update the contents of all realized items.
19251 * @param obj The genlist object.
19253 * This updates all realized items by calling all the item class functions again
19254 * to get the icons, labels and states. Use this when the original
19255 * item data has changed and the changes are desired to be reflected.
19257 * To update just one item, use elm_genlist_item_update().
19259 * @see elm_genlist_realized_items_get()
19260 * @see elm_genlist_item_update()
19264 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
19266 * Activate a genlist mode on an item
19268 * @param item The genlist item
19269 * @param mode Mode name
19270 * @param mode_set Boolean to define set or unset mode.
19272 * A genlist mode is a different way of selecting an item. Once a mode is
19273 * activated on an item, any other selected item is immediately unselected.
19274 * This feature provides an easy way of implementing a new kind of animation
19275 * for selecting an item, without having to entirely rewrite the item style
19276 * theme. However, the elm_genlist_selected_* API can't be used to get what
19277 * item is activate for a mode.
19279 * The current item style will still be used, but applying a genlist mode to
19280 * an item will select it using a different kind of animation.
19282 * The current active item for a mode can be found by
19283 * elm_genlist_mode_item_get().
19285 * The characteristics of genlist mode are:
19286 * - Only one mode can be active at any time, and for only one item.
19287 * - Genlist handles deactivating other items when one item is activated.
19288 * - A mode is defined in the genlist theme (edc), and more modes can easily
19290 * - A mode style and the genlist item style are different things. They
19291 * can be combined to provide a default style to the item, with some kind
19292 * of animation for that item when the mode is activated.
19294 * When a mode is activated on an item, a new view for that item is created.
19295 * The theme of this mode defines the animation that will be used to transit
19296 * the item from the old view to the new view. This second (new) view will be
19297 * active for that item while the mode is active on the item, and will be
19298 * destroyed after the mode is totally deactivated from that item.
19300 * @see elm_genlist_mode_get()
19301 * @see elm_genlist_mode_item_get()
19305 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
19307 * Get the last (or current) genlist mode used.
19309 * @param obj The genlist object
19311 * This function just returns the name of the last used genlist mode. It will
19312 * be the current mode if it's still active.
19314 * @see elm_genlist_item_mode_set()
19315 * @see elm_genlist_mode_item_get()
19319 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19321 * Get active genlist mode item
19323 * @param obj The genlist object
19324 * @return The active item for that current mode. Or @c NULL if no item is
19325 * activated with any mode.
19327 * This function returns the item that was activated with a mode, by the
19328 * function elm_genlist_item_mode_set().
19330 * @see elm_genlist_item_mode_set()
19331 * @see elm_genlist_mode_get()
19335 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19340 * @param obj The genlist object
19341 * @param reorder_mode The reorder mode
19342 * (EINA_TRUE = on, EINA_FALSE = off)
19346 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
19349 * Get the reorder mode
19351 * @param obj The genlist object
19352 * @return The reorder mode
19353 * (EINA_TRUE = on, EINA_FALSE = off)
19357 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19364 * @defgroup Check Check
19366 * @image html img/widget/check/preview-00.png
19367 * @image latex img/widget/check/preview-00.eps
19368 * @image html img/widget/check/preview-01.png
19369 * @image latex img/widget/check/preview-01.eps
19370 * @image html img/widget/check/preview-02.png
19371 * @image latex img/widget/check/preview-02.eps
19373 * @brief The check widget allows for toggling a value between true and
19376 * Check objects are a lot like radio objects in layout and functionality
19377 * except they do not work as a group, but independently and only toggle the
19378 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
19379 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
19380 * returns the current state. For convenience, like the radio objects, you
19381 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
19382 * for it to modify.
19384 * Signals that you can add callbacks for are:
19385 * "changed" - This is called whenever the user changes the state of one of
19386 * the check object(event_info is NULL).
19388 * @ref tutorial_check should give you a firm grasp of how to use this widget.
19392 * @brief Add a new Check object
19394 * @param parent The parent object
19395 * @return The new object or NULL if it cannot be created
19397 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19399 * @brief Set the text label of the check object
19401 * @param obj The check object
19402 * @param label The text label string in UTF-8
19404 * @deprecated use elm_object_text_set() instead.
19406 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19408 * @brief Get the text label of the check object
19410 * @param obj The check object
19411 * @return The text label string in UTF-8
19413 * @deprecated use elm_object_text_get() instead.
19415 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19417 * @brief Set the icon object of the check object
19419 * @param obj The check object
19420 * @param icon The icon object
19422 * Once the icon object is set, a previously set one will be deleted.
19423 * If you want to keep that old content object, use the
19424 * elm_check_icon_unset() function.
19426 EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19428 * @brief Get the icon object of the check object
19430 * @param obj The check object
19431 * @return The icon object
19433 EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19435 * @brief Unset the icon used for the check object
19437 * @param obj The check object
19438 * @return The icon object that was being used
19440 * Unparent and return the icon object which was set for this widget.
19442 EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19444 * @brief Set the on/off state of the check object
19446 * @param obj The check object
19447 * @param state The state to use (1 == on, 0 == off)
19449 * This sets the state of the check. If set
19450 * with elm_check_state_pointer_set() the state of that variable is also
19451 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
19453 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
19455 * @brief Get the state of the check object
19457 * @param obj The check object
19458 * @return The boolean state
19460 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19462 * @brief Set a convenience pointer to a boolean to change
19464 * @param obj The check object
19465 * @param statep Pointer to the boolean to modify
19467 * This sets a pointer to a boolean, that, in addition to the check objects
19468 * state will also be modified directly. To stop setting the object pointed
19469 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
19470 * then when this is called, the check objects state will also be modified to
19471 * reflect the value of the boolean @p statep points to, just like calling
19472 * elm_check_state_set().
19474 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
19480 * @defgroup Radio Radio
19482 * @image html img/widget/radio/preview-00.png
19483 * @image latex img/widget/radio/preview-00.eps
19485 * @brief Radio is a widget that allows for 1 or more options to be displayed
19486 * and have the user choose only 1 of them.
19488 * A radio object contains an indicator, an optional Label and an optional
19489 * icon object. While it's possible to have a group of only one radio they,
19490 * are normally used in groups of 2 or more. To add a radio to a group use
19491 * elm_radio_group_add(). The radio object(s) will select from one of a set
19492 * of integer values, so any value they are configuring needs to be mapped to
19493 * a set of integers. To configure what value that radio object represents,
19494 * use elm_radio_state_value_set() to set the integer it represents. To set
19495 * the value the whole group(which one is currently selected) is to indicate
19496 * use elm_radio_value_set() on any group member, and to get the groups value
19497 * use elm_radio_value_get(). For convenience the radio objects are also able
19498 * to directly set an integer(int) to the value that is selected. To specify
19499 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
19500 * The radio objects will modify this directly. That implies the pointer must
19501 * point to valid memory for as long as the radio objects exist.
19503 * Signals that you can add callbacks for are:
19504 * @li changed - This is called whenever the user changes the state of one of
19505 * the radio objects within the group of radio objects that work together.
19507 * @ref tutorial_radio show most of this API in action.
19511 * @brief Add a new radio to the parent
19513 * @param parent The parent object
19514 * @return The new object or NULL if it cannot be created
19516 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19518 * @brief Set the text label of the radio object
19520 * @param obj The radio object
19521 * @param label The text label string in UTF-8
19523 * @deprecated use elm_object_text_set() instead.
19525 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19527 * @brief Get the text label of the radio object
19529 * @param obj The radio object
19530 * @return The text label string in UTF-8
19532 * @deprecated use elm_object_text_set() instead.
19534 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19536 * @brief Set the icon object of the radio object
19538 * @param obj The radio object
19539 * @param icon The icon object
19541 * Once the icon object is set, a previously set one will be deleted. If you
19542 * want to keep that old content object, use the elm_radio_icon_unset()
19545 EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19547 * @brief Get the icon object of the radio object
19549 * @param obj The radio object
19550 * @return The icon object
19552 * @see elm_radio_icon_set()
19554 EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19556 * @brief Unset the icon used for the radio object
19558 * @param obj The radio object
19559 * @return The icon object that was being used
19561 * Unparent and return the icon object which was set for this widget.
19563 * @see elm_radio_icon_set()
19565 EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19567 * @brief Add this radio to a group of other radio objects
19569 * @param obj The radio object
19570 * @param group Any object whose group the @p obj is to join.
19572 * Radio objects work in groups. Each member should have a different integer
19573 * value assigned. In order to have them work as a group, they need to know
19574 * about each other. This adds the given radio object to the group of which
19575 * the group object indicated is a member.
19577 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
19579 * @brief Set the integer value that this radio object represents
19581 * @param obj The radio object
19582 * @param value The value to use if this radio object is selected
19584 * This sets the value of the radio.
19586 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
19588 * @brief Get the integer value that this radio object represents
19590 * @param obj The radio object
19591 * @return The value used if this radio object is selected
19593 * This gets the value of the radio.
19595 * @see elm_radio_value_set()
19597 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19599 * @brief Set the value of the radio.
19601 * @param obj The radio object
19602 * @param value The value to use for the group
19604 * This sets the value of the radio group and will also set the value if
19605 * pointed to, to the value supplied, but will not call any callbacks.
19607 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
19609 * @brief Get the state of the radio object
19611 * @param obj The radio object
19612 * @return The integer state
19614 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19616 * @brief Set a convenience pointer to a integer to change
19618 * @param obj The radio object
19619 * @param valuep Pointer to the integer to modify
19621 * This sets a pointer to a integer, that, in addition to the radio objects
19622 * state will also be modified directly. To stop setting the object pointed
19623 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
19624 * when this is called, the radio objects state will also be modified to
19625 * reflect the value of the integer valuep points to, just like calling
19626 * elm_radio_value_set().
19628 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
19634 * @defgroup Pager Pager
19636 * @image html img/widget/pager/preview-00.png
19637 * @image latex img/widget/pager/preview-00.eps
19639 * @brief Widget that allows flipping between 1 or more “pages” of objects.
19641 * The flipping between “pages” of objects is animated. All content in pager
19642 * is kept in a stack, the last content to be added will be on the top of the
19643 * stack(be visible).
19645 * Objects can be pushed or popped from the stack or deleted as normal.
19646 * Pushes and pops will animate (and a pop will delete the object once the
19647 * animation is finished). Any object already in the pager can be promoted to
19648 * the top(from its current stacking position) through the use of
19649 * elm_pager_content_promote(). Objects are pushed to the top with
19650 * elm_pager_content_push() and when the top item is no longer wanted, simply
19651 * pop it with elm_pager_content_pop() and it will also be deleted. If an
19652 * object is no longer needed and is not the top item, just delete it as
19653 * normal. You can query which objects are the top and bottom with
19654 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
19656 * Signals that you can add callbacks for are:
19657 * "hide,finished" - when the previous page is hided
19659 * This widget has the following styles available:
19662 * @li fade_translucide
19663 * @li fade_invisible
19664 * @note This styles affect only the flipping animations, the appearance when
19665 * not animating is unaffected by styles.
19667 * @ref tutorial_pager gives a good overview of the usage of the API.
19671 * Add a new pager to the parent
19673 * @param parent The parent object
19674 * @return The new object or NULL if it cannot be created
19678 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19680 * @brief Push an object to the top of the pager stack (and show it).
19682 * @param obj The pager object
19683 * @param content The object to push
19685 * The object pushed becomes a child of the pager, it will be controlled and
19686 * deleted when the pager is deleted.
19688 * @note If the content is already in the stack use
19689 * elm_pager_content_promote().
19690 * @warning Using this function on @p content already in the stack results in
19691 * undefined behavior.
19693 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
19695 * @brief Pop the object that is on top of the stack
19697 * @param obj The pager object
19699 * This pops the object that is on the top(visible) of the pager, makes it
19700 * disappear, then deletes the object. The object that was underneath it on
19701 * the stack will become visible.
19703 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
19705 * @brief Moves an object already in the pager stack to the top of the stack.
19707 * @param obj The pager object
19708 * @param content The object to promote
19710 * This will take the @p content and move it to the top of the stack as
19711 * if it had been pushed there.
19713 * @note If the content isn't already in the stack use
19714 * elm_pager_content_push().
19715 * @warning Using this function on @p content not already in the stack
19716 * results in undefined behavior.
19718 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
19720 * @brief Return the object at the bottom of the pager stack
19722 * @param obj The pager object
19723 * @return The bottom object or NULL if none
19725 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19727 * @brief Return the object at the top of the pager stack
19729 * @param obj The pager object
19730 * @return The top object or NULL if none
19732 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19738 * @defgroup Slideshow Slideshow
19740 * @image html img/widget/slideshow/preview-00.png
19741 * @image latex img/widget/slideshow/preview-00.eps
19743 * This widget, as the name indicates, is a pre-made image
19744 * slideshow panel, with API functions acting on (child) image
19745 * items presentation. Between those actions, are:
19746 * - advance to next/previous image
19747 * - select the style of image transition animation
19748 * - set the exhibition time for each image
19749 * - start/stop the slideshow
19751 * The transition animations are defined in the widget's theme,
19752 * consequently new animations can be added without having to
19753 * update the widget's code.
19755 * @section Slideshow_Items Slideshow items
19757 * For slideshow items, just like for @ref Genlist "genlist" ones,
19758 * the user defines a @b classes, specifying functions that will be
19759 * called on the item's creation and deletion times.
19761 * The #Elm_Slideshow_Item_Class structure contains the following
19764 * - @c func.get - When an item is displayed, this function is
19765 * called, and it's where one should create the item object, de
19766 * facto. For example, the object can be a pure Evas image object
19767 * or an Elementary @ref Photocam "photocam" widget. See
19768 * #SlideshowItemGetFunc.
19769 * - @c func.del - When an item is no more displayed, this function
19770 * is called, where the user must delete any data associated to
19771 * the item. See #SlideshowItemDelFunc.
19773 * @section Slideshow_Caching Slideshow caching
19775 * The slideshow provides facilities to have items adjacent to the
19776 * one being displayed <b>already "realized"</b> (i.e. loaded) for
19777 * you, so that the system does not have to decode image data
19778 * anymore at the time it has to actually switch images on its
19779 * viewport. The user is able to set the numbers of items to be
19780 * cached @b before and @b after the current item, in the widget's
19783 * Smart events one can add callbacks for are:
19785 * - @c "changed" - when the slideshow switches its view to a new
19788 * List of examples for the slideshow widget:
19789 * @li @ref slideshow_example
19793 * @addtogroup Slideshow
19797 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
19798 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
19799 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Slideshow item handle */
19800 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
19801 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
19804 * @struct _Elm_Slideshow_Item_Class
19806 * Slideshow item class definition. See @ref Slideshow_Items for
19809 struct _Elm_Slideshow_Item_Class
19811 struct _Elm_Slideshow_Item_Class_Func
19813 SlideshowItemGetFunc get;
19814 SlideshowItemDelFunc del;
19816 }; /**< #Elm_Slideshow_Item_Class member definitions */
19819 * Add a new slideshow widget to the given parent Elementary
19820 * (container) object
19822 * @param parent The parent object
19823 * @return A new slideshow widget handle or @c NULL, on errors
19825 * This function inserts a new slideshow widget on the canvas.
19827 * @ingroup Slideshow
19829 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19832 * Add (append) a new item in a given slideshow widget.
19834 * @param obj The slideshow object
19835 * @param itc The item class for the item
19836 * @param data The item's data
19837 * @return A handle to the item added or @c NULL, on errors
19839 * Add a new item to @p obj's internal list of items, appending it.
19840 * The item's class must contain the function really fetching the
19841 * image object to show for this item, which could be an Evas image
19842 * object or an Elementary photo, for example. The @p data
19843 * parameter is going to be passed to both class functions of the
19846 * @see #Elm_Slideshow_Item_Class
19847 * @see elm_slideshow_item_sorted_insert()
19849 * @ingroup Slideshow
19851 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
19854 * Insert a new item into the given slideshow widget, using the @p func
19855 * function to sort items (by item handles).
19857 * @param obj The slideshow object
19858 * @param itc The item class for the item
19859 * @param data The item's data
19860 * @param func The comparing function to be used to sort slideshow
19861 * items <b>by #Elm_Slideshow_Item item handles</b>
19862 * @return Returns The slideshow item handle, on success, or
19863 * @c NULL, on errors
19865 * Add a new item to @p obj's internal list of items, in a position
19866 * determined by the @p func comparing function. The item's class
19867 * must contain the function really fetching the image object to
19868 * show for this item, which could be an Evas image object or an
19869 * Elementary photo, for example. The @p data parameter is going to
19870 * be passed to both class functions of the item.
19872 * @see #Elm_Slideshow_Item_Class
19873 * @see elm_slideshow_item_add()
19875 * @ingroup Slideshow
19877 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);
19880 * Display a given slideshow widget's item, programmatically.
19882 * @param obj The slideshow object
19883 * @param item The item to display on @p obj's viewport
19885 * The change between the current item and @p item will use the
19886 * transition @p obj is set to use (@see
19887 * elm_slideshow_transition_set()).
19889 * @ingroup Slideshow
19891 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
19894 * Slide to the @b next item, in a given slideshow widget
19896 * @param obj The slideshow object
19898 * The sliding animation @p obj is set to use will be the
19899 * transition effect used, after this call is issued.
19901 * @note If the end of the slideshow's internal list of items is
19902 * reached, it'll wrap around to the list's beginning, again.
19904 * @ingroup Slideshow
19906 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
19909 * Slide to the @b previous item, in a given slideshow widget
19911 * @param obj The slideshow object
19913 * The sliding animation @p obj is set to use will be the
19914 * transition effect used, after this call is issued.
19916 * @note If the beginning of the slideshow's internal list of items
19917 * is reached, it'll wrap around to the list's end, again.
19919 * @ingroup Slideshow
19921 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
19924 * Returns the list of sliding transition/effect names available, for a
19925 * given slideshow widget.
19927 * @param obj The slideshow object
19928 * @return The list of transitions (list of @b stringshared strings
19931 * The transitions, which come from @p obj's theme, must be an EDC
19932 * data item named @c "transitions" on the theme file, with (prefix)
19933 * names of EDC programs actually implementing them.
19935 * The available transitions for slideshows on the default theme are:
19936 * - @c "fade" - the current item fades out, while the new one
19937 * fades in to the slideshow's viewport.
19938 * - @c "black_fade" - the current item fades to black, and just
19939 * then, the new item will fade in.
19940 * - @c "horizontal" - the current item slides horizontally, until
19941 * it gets out of the slideshow's viewport, while the new item
19942 * comes from the left to take its place.
19943 * - @c "vertical" - the current item slides vertically, until it
19944 * gets out of the slideshow's viewport, while the new item comes
19945 * from the bottom to take its place.
19946 * - @c "square" - the new item starts to appear from the middle of
19947 * the current one, but with a tiny size, growing until its
19948 * target (full) size and covering the old one.
19950 * @warning The stringshared strings get no new references
19951 * exclusive to the user grabbing the list, here, so if you'd like
19952 * to use them out of this call's context, you'd better @c
19953 * eina_stringshare_ref() them.
19955 * @see elm_slideshow_transition_set()
19957 * @ingroup Slideshow
19959 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19962 * Set the current slide transition/effect in use for a given
19965 * @param obj The slideshow object
19966 * @param transition The new transition's name string
19968 * If @p transition is implemented in @p obj's theme (i.e., is
19969 * contained in the list returned by
19970 * elm_slideshow_transitions_get()), this new sliding effect will
19971 * be used on the widget.
19973 * @see elm_slideshow_transitions_get() for more details
19975 * @ingroup Slideshow
19977 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
19980 * Get the current slide transition/effect in use for a given
19983 * @param obj The slideshow object
19984 * @return The current transition's name
19986 * @see elm_slideshow_transition_set() for more details
19988 * @ingroup Slideshow
19990 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19993 * Set the interval between each image transition on a given
19994 * slideshow widget, <b>and start the slideshow, itself</b>
19996 * @param obj The slideshow object
19997 * @param timeout The new displaying timeout for images
19999 * After this call, the slideshow widget will start cycling its
20000 * view, sequentially and automatically, with the images of the
20001 * items it has. The time between each new image displayed is going
20002 * to be @p timeout, in @b seconds. If a different timeout was set
20003 * previously and an slideshow was in progress, it will continue
20004 * with the new time between transitions, after this call.
20006 * @note A value less than or equal to 0 on @p timeout will disable
20007 * the widget's internal timer, thus halting any slideshow which
20008 * could be happening on @p obj.
20010 * @see elm_slideshow_timeout_get()
20012 * @ingroup Slideshow
20014 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
20017 * Get the interval set for image transitions on a given slideshow
20020 * @param obj The slideshow object
20021 * @return Returns the timeout set on it
20023 * @see elm_slideshow_timeout_set() for more details
20025 * @ingroup Slideshow
20027 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20030 * Set if, after a slideshow is started, for a given slideshow
20031 * widget, its items should be displayed cyclically or not.
20033 * @param obj The slideshow object
20034 * @param loop Use @c EINA_TRUE to make it cycle through items or
20035 * @c EINA_FALSE for it to stop at the end of @p obj's internal
20038 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
20039 * ignore what is set by this functions, i.e., they'll @b always
20040 * cycle through items. This affects only the "automatic"
20041 * slideshow, as set by elm_slideshow_timeout_set().
20043 * @see elm_slideshow_loop_get()
20045 * @ingroup Slideshow
20047 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
20050 * Get if, after a slideshow is started, for a given slideshow
20051 * widget, its items are to be displayed cyclically or not.
20053 * @param obj The slideshow object
20054 * @return @c EINA_TRUE, if the items in @p obj will be cycled
20055 * through or @c EINA_FALSE, otherwise
20057 * @see elm_slideshow_loop_set() for more details
20059 * @ingroup Slideshow
20061 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20064 * Remove all items from a given slideshow widget
20066 * @param obj The slideshow object
20068 * This removes (and deletes) all items in @p obj, leaving it
20071 * @see elm_slideshow_item_del(), to remove just one item.
20073 * @ingroup Slideshow
20075 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20078 * Get the internal list of items in a given slideshow widget.
20080 * @param obj The slideshow object
20081 * @return The list of items (#Elm_Slideshow_Item as data) or
20082 * @c NULL on errors.
20084 * This list is @b not to be modified in any way and must not be
20085 * freed. Use the list members with functions like
20086 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
20088 * @warning This list is only valid until @p obj object's internal
20089 * items list is changed. It should be fetched again with another
20090 * call to this function when changes happen.
20092 * @ingroup Slideshow
20094 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20097 * Delete a given item from a slideshow widget.
20099 * @param item The slideshow item
20101 * @ingroup Slideshow
20103 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20106 * Return the data associated with a given slideshow item
20108 * @param item The slideshow item
20109 * @return Returns the data associated to this item
20111 * @ingroup Slideshow
20113 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20116 * Returns the currently displayed item, in a given slideshow widget
20118 * @param obj The slideshow object
20119 * @return A handle to the item being displayed in @p obj or
20120 * @c NULL, if none is (and on errors)
20122 * @ingroup Slideshow
20124 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20127 * Get the real Evas object created to implement the view of a
20128 * given slideshow item
20130 * @param item The slideshow item.
20131 * @return the Evas object implementing this item's view.
20133 * This returns the actual Evas object used to implement the
20134 * specified slideshow item's view. This may be @c NULL, as it may
20135 * not have been created or may have been deleted, at any time, by
20136 * the slideshow. <b>Do not modify this object</b> (move, resize,
20137 * show, hide, etc.), as the slideshow is controlling it. This
20138 * function is for querying, emitting custom signals or hooking
20139 * lower level callbacks for events on that object. Do not delete
20140 * this object under any circumstances.
20142 * @see elm_slideshow_item_data_get()
20144 * @ingroup Slideshow
20146 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
20149 * Get the the item, in a given slideshow widget, placed at
20150 * position @p nth, in its internal items list
20152 * @param obj The slideshow object
20153 * @param nth The number of the item to grab a handle to (0 being
20155 * @return The item stored in @p obj at position @p nth or @c NULL,
20156 * if there's no item with that index (and on errors)
20158 * @ingroup Slideshow
20160 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
20163 * Set the current slide layout in use for a given slideshow widget
20165 * @param obj The slideshow object
20166 * @param layout The new layout's name string
20168 * If @p layout is implemented in @p obj's theme (i.e., is contained
20169 * in the list returned by elm_slideshow_layouts_get()), this new
20170 * images layout will be used on the widget.
20172 * @see elm_slideshow_layouts_get() for more details
20174 * @ingroup Slideshow
20176 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
20179 * Get the current slide layout in use for a given slideshow widget
20181 * @param obj The slideshow object
20182 * @return The current layout's name
20184 * @see elm_slideshow_layout_set() for more details
20186 * @ingroup Slideshow
20188 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20191 * Returns the list of @b layout names available, for a given
20192 * slideshow widget.
20194 * @param obj The slideshow object
20195 * @return The list of layouts (list of @b stringshared strings
20198 * Slideshow layouts will change how the widget is to dispose each
20199 * image item in its viewport, with regard to cropping, scaling,
20202 * The layouts, which come from @p obj's theme, must be an EDC
20203 * data item name @c "layouts" on the theme file, with (prefix)
20204 * names of EDC programs actually implementing them.
20206 * The available layouts for slideshows on the default theme are:
20207 * - @c "fullscreen" - item images with original aspect, scaled to
20208 * touch top and down slideshow borders or, if the image's heigh
20209 * is not enough, left and right slideshow borders.
20210 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
20211 * one, but always leaving 10% of the slideshow's dimensions of
20212 * distance between the item image's borders and the slideshow
20213 * borders, for each axis.
20215 * @warning The stringshared strings get no new references
20216 * exclusive to the user grabbing the list, here, so if you'd like
20217 * to use them out of this call's context, you'd better @c
20218 * eina_stringshare_ref() them.
20220 * @see elm_slideshow_layout_set()
20222 * @ingroup Slideshow
20224 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20227 * Set the number of items to cache, on a given slideshow widget,
20228 * <b>before the current item</b>
20230 * @param obj The slideshow object
20231 * @param count Number of items to cache before the current one
20233 * The default value for this property is @c 2. See
20234 * @ref Slideshow_Caching "slideshow caching" for more details.
20236 * @see elm_slideshow_cache_before_get()
20238 * @ingroup Slideshow
20240 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20243 * Retrieve the number of items to cache, on a given slideshow widget,
20244 * <b>before the current item</b>
20246 * @param obj The slideshow object
20247 * @return The number of items set to be cached before the current one
20249 * @see elm_slideshow_cache_before_set() for more details
20251 * @ingroup Slideshow
20253 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20256 * Set the number of items to cache, on a given slideshow widget,
20257 * <b>after the current item</b>
20259 * @param obj The slideshow object
20260 * @param count Number of items to cache after the current one
20262 * The default value for this property is @c 2. See
20263 * @ref Slideshow_Caching "slideshow caching" for more details.
20265 * @see elm_slideshow_cache_after_get()
20267 * @ingroup Slideshow
20269 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20272 * Retrieve the number of items to cache, on a given slideshow widget,
20273 * <b>after the current item</b>
20275 * @param obj The slideshow object
20276 * @return The number of items set to be cached after the current one
20278 * @see elm_slideshow_cache_after_set() for more details
20280 * @ingroup Slideshow
20282 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20285 * Get the number of items stored in a given slideshow widget
20287 * @param obj The slideshow object
20288 * @return The number of items on @p obj, at the moment of this call
20290 * @ingroup Slideshow
20292 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20299 * @defgroup Fileselector File Selector
20301 * @image html img/widget/fileselector/preview-00.png
20302 * @image latex img/widget/fileselector/preview-00.eps
20304 * A file selector is a widget that allows a user to navigate
20305 * through a file system, reporting file selections back via its
20308 * It contains shortcut buttons for home directory (@c ~) and to
20309 * jump one directory upwards (..), as well as cancel/ok buttons to
20310 * confirm/cancel a given selection. After either one of those two
20311 * former actions, the file selector will issue its @c "done" smart
20314 * There's a text entry on it, too, showing the name of the current
20315 * selection. There's the possibility of making it editable, so it
20316 * is useful on file saving dialogs on applications, where one
20317 * gives a file name to save contents to, in a given directory in
20318 * the system. This custom file name will be reported on the @c
20319 * "done" smart callback (explained in sequence).
20321 * Finally, it has a view to display file system items into in two
20326 * If Elementary is built with support of the Ethumb thumbnailing
20327 * library, the second form of view will display preview thumbnails
20328 * of files which it supports.
20330 * Smart callbacks one can register to:
20332 * - @c "selected" - the user has clicked on a file (when not in
20333 * folders-only mode) or directory (when in folders-only mode)
20334 * - @c "directory,open" - the list has been populated with new
20335 * content (@c event_info is a pointer to the directory's
20336 * path, a @b stringshared string)
20337 * - @c "done" - the user has clicked on the "ok" or "cancel"
20338 * buttons (@c event_info is a pointer to the selection's
20339 * path, a @b stringshared string)
20341 * Here is an example on its usage:
20342 * @li @ref fileselector_example
20346 * @addtogroup Fileselector
20351 * Defines how a file selector widget is to layout its contents
20352 * (file system entries).
20354 typedef enum _Elm_Fileselector_Mode
20356 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
20357 ELM_FILESELECTOR_GRID, /**< layout as a grid */
20358 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
20359 } Elm_Fileselector_Mode;
20362 * Add a new file selector widget to the given parent Elementary
20363 * (container) object
20365 * @param parent The parent object
20366 * @return a new file selector widget handle or @c NULL, on errors
20368 * This function inserts a new file selector widget on the canvas.
20370 * @ingroup Fileselector
20372 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20375 * Enable/disable the file name entry box where the user can type
20376 * in a name for a file, in a given file selector widget
20378 * @param obj The file selector object
20379 * @param is_save @c EINA_TRUE to make the file selector a "saving
20380 * dialog", @c EINA_FALSE otherwise
20382 * Having the entry editable is useful on file saving dialogs on
20383 * applications, where one gives a file name to save contents to,
20384 * in a given directory in the system. This custom file name will
20385 * be reported on the @c "done" smart callback.
20387 * @see elm_fileselector_is_save_get()
20389 * @ingroup Fileselector
20391 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
20394 * Get whether the given file selector is in "saving dialog" mode
20396 * @param obj The file selector object
20397 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
20398 * mode, @c EINA_FALSE otherwise (and on errors)
20400 * @see elm_fileselector_is_save_set() for more details
20402 * @ingroup Fileselector
20404 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20407 * Enable/disable folder-only view for a given file selector widget
20409 * @param obj The file selector object
20410 * @param only @c EINA_TRUE to make @p obj only display
20411 * directories, @c EINA_FALSE to make files to be displayed in it
20414 * If enabled, the widget's view will only display folder items,
20417 * @see elm_fileselector_folder_only_get()
20419 * @ingroup Fileselector
20421 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
20424 * Get whether folder-only view is set for a given file selector
20427 * @param obj The file selector object
20428 * @return only @c EINA_TRUE if @p obj is only displaying
20429 * directories, @c EINA_FALSE if files are being displayed in it
20430 * too (and on errors)
20432 * @see elm_fileselector_folder_only_get()
20434 * @ingroup Fileselector
20436 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20439 * Enable/disable the "ok" and "cancel" buttons on a given file
20442 * @param obj The file selector object
20443 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
20445 * @note A file selector without those buttons will never emit the
20446 * @c "done" smart event, and is only usable if one is just hooking
20447 * to the other two events.
20449 * @see elm_fileselector_buttons_ok_cancel_get()
20451 * @ingroup Fileselector
20453 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
20456 * Get whether the "ok" and "cancel" buttons on a given file
20457 * selector widget are being shown.
20459 * @param obj The file selector object
20460 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
20461 * otherwise (and on errors)
20463 * @see elm_fileselector_buttons_ok_cancel_set() for more details
20465 * @ingroup Fileselector
20467 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20470 * Enable/disable a tree view in the given file selector widget,
20471 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
20473 * @param obj The file selector object
20474 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
20477 * In a tree view, arrows are created on the sides of directories,
20478 * allowing them to expand in place.
20480 * @note If it's in other mode, the changes made by this function
20481 * will only be visible when one switches back to "list" mode.
20483 * @see elm_fileselector_expandable_get()
20485 * @ingroup Fileselector
20487 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
20490 * Get whether tree view is enabled for the given file selector
20493 * @param obj The file selector object
20494 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
20495 * otherwise (and or errors)
20497 * @see elm_fileselector_expandable_set() for more details
20499 * @ingroup Fileselector
20501 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20504 * Set, programmatically, the @b directory that a given file
20505 * selector widget will display contents from
20507 * @param obj The file selector object
20508 * @param path The path to display in @p obj
20510 * This will change the @b directory that @p obj is displaying. It
20511 * will also clear the text entry area on the @p obj object, which
20512 * displays select files' names.
20514 * @see elm_fileselector_path_get()
20516 * @ingroup Fileselector
20518 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
20521 * Get the parent directory's path that a given file selector
20522 * widget is displaying
20524 * @param obj The file selector object
20525 * @return The (full) path of the directory the file selector is
20526 * displaying, a @b stringshared string
20528 * @see elm_fileselector_path_set()
20530 * @ingroup Fileselector
20532 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20535 * Set, programmatically, the currently selected file/directory in
20536 * the given file selector widget
20538 * @param obj The file selector object
20539 * @param path The (full) path to a file or directory
20540 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
20541 * latter case occurs if the directory or file pointed to do not
20544 * @see elm_fileselector_selected_get()
20546 * @ingroup Fileselector
20548 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
20551 * Get the currently selected item's (full) path, in the given file
20554 * @param obj The file selector object
20555 * @return The absolute path of the selected item, a @b
20556 * stringshared string
20558 * @note Custom editions on @p obj object's text entry, if made,
20559 * will appear on the return string of this function, naturally.
20561 * @see elm_fileselector_selected_set() for more details
20563 * @ingroup Fileselector
20565 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20568 * Set the mode in which a given file selector widget will display
20569 * (layout) file system entries in its view
20571 * @param obj The file selector object
20572 * @param mode The mode of the fileselector, being it one of
20573 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
20574 * first one, naturally, will display the files in a list. The
20575 * latter will make the widget to display its entries in a grid
20578 * @note By using elm_fileselector_expandable_set(), the user may
20579 * trigger a tree view for that list.
20581 * @note If Elementary is built with support of the Ethumb
20582 * thumbnailing library, the second form of view will display
20583 * preview thumbnails of files which it supports. You must have
20584 * elm_need_ethumb() called in your Elementary for thumbnailing to
20587 * @see elm_fileselector_expandable_set().
20588 * @see elm_fileselector_mode_get().
20590 * @ingroup Fileselector
20592 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
20595 * Get the mode in which a given file selector widget is displaying
20596 * (layouting) file system entries in its view
20598 * @param obj The fileselector object
20599 * @return The mode in which the fileselector is at
20601 * @see elm_fileselector_mode_set() for more details
20603 * @ingroup Fileselector
20605 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20612 * @defgroup Progressbar Progress bar
20614 * The progress bar is a widget for visually representing the
20615 * progress status of a given job/task.
20617 * A progress bar may be horizontal or vertical. It may display an
20618 * icon besides it, as well as primary and @b units labels. The
20619 * former is meant to label the widget as a whole, while the
20620 * latter, which is formatted with floating point values (and thus
20621 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
20622 * units"</c>), is meant to label the widget's <b>progress
20623 * value</b>. Label, icon and unit strings/objects are @b optional
20624 * for progress bars.
20626 * A progress bar may be @b inverted, in which state it gets its
20627 * values inverted, with high values being on the left or top and
20628 * low values on the right or bottom, as opposed to normally have
20629 * the low values on the former and high values on the latter,
20630 * respectively, for horizontal and vertical modes.
20632 * The @b span of the progress, as set by
20633 * elm_progressbar_span_size_set(), is its length (horizontally or
20634 * vertically), unless one puts size hints on the widget to expand
20635 * on desired directions, by any container. That length will be
20636 * scaled by the object or applications scaling factor. At any
20637 * point code can query the progress bar for its value with
20638 * elm_progressbar_value_get().
20640 * Available widget styles for progress bars:
20642 * - @c "wheel" (simple style, no text, no progression, only
20643 * "pulse" effect is available)
20645 * Here is an example on its usage:
20646 * @li @ref progressbar_example
20650 * Add a new progress bar widget to the given parent Elementary
20651 * (container) object
20653 * @param parent The parent object
20654 * @return a new progress bar widget handle or @c NULL, on errors
20656 * This function inserts a new progress bar widget on the canvas.
20658 * @ingroup Progressbar
20660 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20663 * Set whether a given progress bar widget is at "pulsing mode" or
20666 * @param obj The progress bar object
20667 * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
20668 * @c EINA_FALSE to put it back to its default one
20670 * By default, progress bars will display values from the low to
20671 * high value boundaries. There are, though, contexts in which the
20672 * state of progression of a given task is @b unknown. For those,
20673 * one can set a progress bar widget to a "pulsing state", to give
20674 * the user an idea that some computation is being held, but
20675 * without exact progress values. In the default theme it will
20676 * animate its bar with the contents filling in constantly and back
20677 * to non-filled, in a loop. To start and stop this pulsing
20678 * animation, one has to explicitly call elm_progressbar_pulse().
20680 * @see elm_progressbar_pulse_get()
20681 * @see elm_progressbar_pulse()
20683 * @ingroup Progressbar
20685 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
20688 * Get whether a given progress bar widget is at "pulsing mode" or
20691 * @param obj The progress bar object
20692 * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
20693 * if it's in the default one (and on errors)
20695 * @ingroup Progressbar
20697 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20700 * Start/stop a given progress bar "pulsing" animation, if its
20703 * @param obj The progress bar object
20704 * @param state @c EINA_TRUE, to @b start the pulsing animation,
20705 * @c EINA_FALSE to @b stop it
20707 * @note This call won't do anything if @p obj is not under "pulsing mode".
20709 * @see elm_progressbar_pulse_set() for more details.
20711 * @ingroup Progressbar
20713 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
20716 * Set the progress value (in percentage) on a given progress bar
20719 * @param obj The progress bar object
20720 * @param val The progress value (@b must be between @c 0.0 and @c
20723 * Use this call to set progress bar levels.
20725 * @note If you passes a value out of the specified range for @p
20726 * val, it will be interpreted as the @b closest of the @b boundary
20727 * values in the range.
20729 * @ingroup Progressbar
20731 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
20734 * Get the progress value (in percentage) on a given progress bar
20737 * @param obj The progress bar object
20738 * @return The value of the progressbar
20740 * @see elm_progressbar_value_set() for more details
20742 * @ingroup Progressbar
20744 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20747 * Set the label of a given progress bar widget
20749 * @param obj The progress bar object
20750 * @param label The text label string, in UTF-8
20752 * @ingroup Progressbar
20753 * @deprecated use elm_object_text_set() instead.
20755 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
20758 * Get the label of a given progress bar widget
20760 * @param obj The progressbar object
20761 * @return The text label string, in UTF-8
20763 * @ingroup Progressbar
20764 * @deprecated use elm_object_text_set() instead.
20766 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20769 * Set the icon object of a given progress bar widget
20771 * @param obj The progress bar object
20772 * @param icon The icon object
20774 * Use this call to decorate @p obj with an icon next to it.
20776 * @note Once the icon object is set, a previously set one will be
20777 * deleted. If you want to keep that old content object, use the
20778 * elm_progressbar_icon_unset() function.
20780 * @see elm_progressbar_icon_get()
20782 * @ingroup Progressbar
20784 EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
20787 * Retrieve the icon object set for a given progress bar widget
20789 * @param obj The progress bar object
20790 * @return The icon object's handle, if @p obj had one set, or @c NULL,
20791 * otherwise (and on errors)
20793 * @see elm_progressbar_icon_set() for more details
20795 * @ingroup Progressbar
20797 EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20800 * Unset an icon set on a given progress bar widget
20802 * @param obj The progress bar object
20803 * @return The icon object that was being used, if any was set, or
20804 * @c NULL, otherwise (and on errors)
20806 * This call will unparent and return the icon object which was set
20807 * for this widget, previously, on success.
20809 * @see elm_progressbar_icon_set() for more details
20811 * @ingroup Progressbar
20813 EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20816 * Set the (exact) length of the bar region of a given progress bar
20819 * @param obj The progress bar object
20820 * @param size The length of the progress bar's bar region
20822 * This sets the minimum width (when in horizontal mode) or height
20823 * (when in vertical mode) of the actual bar area of the progress
20824 * bar @p obj. This in turn affects the object's minimum size. Use
20825 * this when you're not setting other size hints expanding on the
20826 * given direction (like weight and alignment hints) and you would
20827 * like it to have a specific size.
20829 * @note Icon, label and unit text around @p obj will require their
20830 * own space, which will make @p obj to require more the @p size,
20833 * @see elm_progressbar_span_size_get()
20835 * @ingroup Progressbar
20837 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
20840 * Get the length set for the bar region of a given progress bar
20843 * @param obj The progress bar object
20844 * @return The length of the progress bar's bar region
20846 * If that size was not set previously, with
20847 * elm_progressbar_span_size_set(), this call will return @c 0.
20849 * @ingroup Progressbar
20851 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20854 * Set the format string for a given progress bar widget's units
20857 * @param obj The progress bar object
20858 * @param format The format string for @p obj's units label
20860 * If @c NULL is passed on @p format, it will make @p obj's units
20861 * area to be hidden completely. If not, it'll set the <b>format
20862 * string</b> for the units label's @b text. The units label is
20863 * provided a floating point value, so the units text is up display
20864 * at most one floating point falue. Note that the units label is
20865 * optional. Use a format string such as "%1.2f meters" for
20868 * @note The default format string for a progress bar is an integer
20869 * percentage, as in @c "%.0f %%".
20871 * @see elm_progressbar_unit_format_get()
20873 * @ingroup Progressbar
20875 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
20878 * Retrieve the format string set for a given progress bar widget's
20881 * @param obj The progress bar object
20882 * @return The format set string for @p obj's units label or
20883 * @c NULL, if none was set (and on errors)
20885 * @see elm_progressbar_unit_format_set() for more details
20887 * @ingroup Progressbar
20889 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20892 * Set the orientation of a given progress bar widget
20894 * @param obj The progress bar object
20895 * @param horizontal Use @c EINA_TRUE to make @p obj to be
20896 * @b horizontal, @c EINA_FALSE to make it @b vertical
20898 * Use this function to change how your progress bar is to be
20899 * disposed: vertically or horizontally.
20901 * @see elm_progressbar_horizontal_get()
20903 * @ingroup Progressbar
20905 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
20908 * Retrieve the orientation of a given progress bar widget
20910 * @param obj The progress bar object
20911 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
20912 * @c EINA_FALSE if it's @b vertical (and on errors)
20914 * @see elm_progressbar_horizontal_set() for more details
20916 * @ingroup Progressbar
20918 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20921 * Invert a given progress bar widget's displaying values order
20923 * @param obj The progress bar object
20924 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
20925 * @c EINA_FALSE to bring it back to default, non-inverted values.
20927 * A progress bar may be @b inverted, in which state it gets its
20928 * values inverted, with high values being on the left or top and
20929 * low values on the right or bottom, as opposed to normally have
20930 * the low values on the former and high values on the latter,
20931 * respectively, for horizontal and vertical modes.
20933 * @see elm_progressbar_inverted_get()
20935 * @ingroup Progressbar
20937 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
20940 * Get whether a given progress bar widget's displaying values are
20943 * @param obj The progress bar object
20944 * @return @c EINA_TRUE, if @p obj has inverted values,
20945 * @c EINA_FALSE otherwise (and on errors)
20947 * @see elm_progressbar_inverted_set() for more details
20949 * @ingroup Progressbar
20951 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20954 * @defgroup Separator Separator
20956 * @brief Separator is a very thin object used to separate other objects.
20958 * A separator can be vertical or horizontal.
20960 * @ref tutorial_separator is a good example of how to use a separator.
20964 * @brief Add a separator object to @p parent
20966 * @param parent The parent object
20968 * @return The separator object, or NULL upon failure
20970 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20972 * @brief Set the horizontal mode of a separator object
20974 * @param obj The separator object
20975 * @param horizontal If true, the separator is horizontal
20977 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
20979 * @brief Get the horizontal mode of a separator object
20981 * @param obj The separator object
20982 * @return If true, the separator is horizontal
20984 * @see elm_separator_horizontal_set()
20986 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20992 * @defgroup Spinner Spinner
20993 * @ingroup Elementary
20995 * @image html img/widget/spinner/preview-00.png
20996 * @image latex img/widget/spinner/preview-00.eps
20998 * A spinner is a widget which allows the user to increase or decrease
20999 * numeric values using arrow buttons, or edit values directly, clicking
21000 * over it and typing the new value.
21002 * By default the spinner will not wrap and has a label
21003 * of "%.0f" (just showing the integer value of the double).
21005 * A spinner has a label that is formatted with floating
21006 * point values and thus accepts a printf-style format string, like
21009 * It also allows specific values to be replaced by pre-defined labels.
21011 * Smart callbacks one can register to:
21013 * - "changed" - Whenever the spinner value is changed.
21014 * - "delay,changed" - A short time after the value is changed by the user.
21015 * This will be called only when the user stops dragging for a very short
21016 * period or when they release their finger/mouse, so it avoids possibly
21017 * expensive reactions to the value change.
21019 * Available styles for it:
21021 * - @c "vertical": up/down buttons at the right side and text left aligned.
21023 * Here is an example on its usage:
21024 * @ref spinner_example
21028 * @addtogroup Spinner
21033 * Add a new spinner widget to the given parent Elementary
21034 * (container) object.
21036 * @param parent The parent object.
21037 * @return a new spinner widget handle or @c NULL, on errors.
21039 * This function inserts a new spinner widget on the canvas.
21044 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21047 * Set the format string of the displayed label.
21049 * @param obj The spinner object.
21050 * @param fmt The format string for the label display.
21052 * If @c NULL, this sets the format to "%.0f". If not it sets the format
21053 * string for the label text. The label text is provided a floating point
21054 * value, so the label text can display up to 1 floating point value.
21055 * Note that this is optional.
21057 * Use a format string such as "%1.2f meters" for example, and it will
21058 * display values like: "3.14 meters" for a value equal to 3.14159.
21060 * Default is "%0.f".
21062 * @see elm_spinner_label_format_get()
21066 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
21069 * Get the label format of the spinner.
21071 * @param obj The spinner object.
21072 * @return The text label format string in UTF-8.
21074 * @see elm_spinner_label_format_set() for details.
21078 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21081 * Set the minimum and maximum values for the spinner.
21083 * @param obj The spinner object.
21084 * @param min The minimum value.
21085 * @param max The maximum value.
21087 * Define the allowed range of values to be selected by the user.
21089 * If actual value is less than @p min, it will be updated to @p min. If it
21090 * is bigger then @p max, will be updated to @p max. Actual value can be
21091 * get with elm_spinner_value_get().
21093 * By default, min is equal to 0, and max is equal to 100.
21095 * @warning Maximum must be greater than minimum.
21097 * @see elm_spinner_min_max_get()
21101 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
21104 * Get the minimum and maximum values of the spinner.
21106 * @param obj The spinner object.
21107 * @param min Pointer where to store the minimum value.
21108 * @param max Pointer where to store the maximum value.
21110 * @note If only one value is needed, the other pointer can be passed
21113 * @see elm_spinner_min_max_set() for details.
21117 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
21120 * Set the step used to increment or decrement the spinner value.
21122 * @param obj The spinner object.
21123 * @param step The step value.
21125 * This value will be incremented or decremented to the displayed value.
21126 * It will be incremented while the user keep right or top arrow pressed,
21127 * and will be decremented while the user keep left or bottom arrow pressed.
21129 * The interval to increment / decrement can be set with
21130 * elm_spinner_interval_set().
21132 * By default step value is equal to 1.
21134 * @see elm_spinner_step_get()
21138 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
21141 * Get the step used to increment or decrement the spinner value.
21143 * @param obj The spinner object.
21144 * @return The step value.
21146 * @see elm_spinner_step_get() for more details.
21150 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21153 * Set the value the spinner displays.
21155 * @param obj The spinner object.
21156 * @param val The value to be displayed.
21158 * Value will be presented on the label following format specified with
21159 * elm_spinner_format_set().
21161 * @warning The value must to be between min and max values. This values
21162 * are set by elm_spinner_min_max_set().
21164 * @see elm_spinner_value_get().
21165 * @see elm_spinner_format_set().
21166 * @see elm_spinner_min_max_set().
21170 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21173 * Get the value displayed by the spinner.
21175 * @param obj The spinner object.
21176 * @return The value displayed.
21178 * @see elm_spinner_value_set() for details.
21182 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21185 * Set whether the spinner should wrap when it reaches its
21186 * minimum or maximum value.
21188 * @param obj The spinner object.
21189 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
21192 * Disabled by default. If disabled, when the user tries to increment the
21194 * but displayed value plus step value is bigger than maximum value,
21196 * won't allow it. The same happens when the user tries to decrement it,
21197 * but the value less step is less than minimum value.
21199 * When wrap is enabled, in such situations it will allow these changes,
21200 * but will get the value that would be less than minimum and subtracts
21201 * from maximum. Or add the value that would be more than maximum to
21205 * @li min value = 10
21206 * @li max value = 50
21207 * @li step value = 20
21208 * @li displayed value = 20
21210 * When the user decrement value (using left or bottom arrow), it will
21211 * displays @c 40, because max - (min - (displayed - step)) is
21212 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
21214 * @see elm_spinner_wrap_get().
21218 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
21221 * Get whether the spinner should wrap when it reaches its
21222 * minimum or maximum value.
21224 * @param obj The spinner object
21225 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
21226 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21228 * @see elm_spinner_wrap_set() for details.
21232 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21235 * Set whether the spinner can be directly edited by the user or not.
21237 * @param obj The spinner object.
21238 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
21239 * don't allow users to edit it directly.
21241 * Spinner objects can have edition @b disabled, in which state they will
21242 * be changed only by arrows.
21243 * Useful for contexts
21244 * where you don't want your users to interact with it writting the value.
21246 * when using special values, the user can see real value instead
21247 * of special label on edition.
21249 * It's enabled by default.
21251 * @see elm_spinner_editable_get()
21255 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
21258 * Get whether the spinner can be directly edited by the user or not.
21260 * @param obj The spinner object.
21261 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
21262 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21264 * @see elm_spinner_editable_set() for details.
21268 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21271 * Set a special string to display in the place of the numerical value.
21273 * @param obj The spinner object.
21274 * @param value The value to be replaced.
21275 * @param label The label to be used.
21277 * It's useful for cases when a user should select an item that is
21278 * better indicated by a label than a value. For example, weekdays or months.
21282 * sp = elm_spinner_add(win);
21283 * elm_spinner_min_max_set(sp, 1, 3);
21284 * elm_spinner_special_value_add(sp, 1, "January");
21285 * elm_spinner_special_value_add(sp, 2, "February");
21286 * elm_spinner_special_value_add(sp, 3, "March");
21287 * evas_object_show(sp);
21292 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
21295 * Set the interval on time updates for an user mouse button hold
21296 * on spinner widgets' arrows.
21298 * @param obj The spinner object.
21299 * @param interval The (first) interval value in seconds.
21301 * This interval value is @b decreased while the user holds the
21302 * mouse pointer either incrementing or decrementing spinner's value.
21304 * This helps the user to get to a given value distant from the
21305 * current one easier/faster, as it will start to change quicker and
21306 * quicker on mouse button holds.
21308 * The calculation for the next change interval value, starting from
21309 * the one set with this call, is the previous interval divided by
21310 * @c 1.05, so it decreases a little bit.
21312 * The default starting interval value for automatic changes is
21315 * @see elm_spinner_interval_get()
21319 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21322 * Get the interval on time updates for an user mouse button hold
21323 * on spinner widgets' arrows.
21325 * @param obj The spinner object.
21326 * @return The (first) interval value, in seconds, set on it.
21328 * @see elm_spinner_interval_set() for more details.
21332 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21339 * @defgroup Index Index
21341 * @image html img/widget/index/preview-00.png
21342 * @image latex img/widget/index/preview-00.eps
21344 * An index widget gives you an index for fast access to whichever
21345 * group of other UI items one might have. It's a list of text
21346 * items (usually letters, for alphabetically ordered access).
21348 * Index widgets are by default hidden and just appear when the
21349 * user clicks over it's reserved area in the canvas. In its
21350 * default theme, it's an area one @ref Fingers "finger" wide on
21351 * the right side of the index widget's container.
21353 * When items on the index are selected, smart callbacks get
21354 * called, so that its user can make other container objects to
21355 * show a given area or child object depending on the index item
21356 * selected. You'd probably be using an index together with @ref
21357 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
21360 * Smart events one can add callbacks for are:
21361 * - @c "changed" - When the selected index item changes. @c
21362 * event_info is the selected item's data pointer.
21363 * - @c "delay,changed" - When the selected index item changes, but
21364 * after a small idling period. @c event_info is the selected
21365 * item's data pointer.
21366 * - @c "selected" - When the user releases a mouse button and
21367 * selects an item. @c event_info is the selected item's data
21369 * - @c "level,up" - when the user moves a finger from the first
21370 * level to the second level
21371 * - @c "level,down" - when the user moves a finger from the second
21372 * level to the first level
21374 * The @c "delay,changed" event is so that it'll wait a small time
21375 * before actually reporting those events and, moreover, just the
21376 * last event happening on those time frames will actually be
21379 * Here are some examples on its usage:
21380 * @li @ref index_example_01
21381 * @li @ref index_example_02
21385 * @addtogroup Index
21389 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
21392 * Add a new index widget to the given parent Elementary
21393 * (container) object
21395 * @param parent The parent object
21396 * @return a new index widget handle or @c NULL, on errors
21398 * This function inserts a new index widget on the canvas.
21402 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21405 * Set whether a given index widget is or not visible,
21408 * @param obj The index object
21409 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
21411 * Not to be confused with visible as in @c evas_object_show() --
21412 * visible with regard to the widget's auto hiding feature.
21414 * @see elm_index_active_get()
21418 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
21421 * Get whether a given index widget is currently visible or not.
21423 * @param obj The index object
21424 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
21426 * @see elm_index_active_set() for more details
21430 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21433 * Set the items level for a given index widget.
21435 * @param obj The index object.
21436 * @param level @c 0 or @c 1, the currently implemented levels.
21438 * @see elm_index_item_level_get()
21442 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21445 * Get the items level set for a given index widget.
21447 * @param obj The index object.
21448 * @return @c 0 or @c 1, which are the levels @p obj might be at.
21450 * @see elm_index_item_level_set() for more information
21454 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21457 * Returns the last selected item's data, for a given index widget.
21459 * @param obj The index object.
21460 * @return The item @b data associated to the last selected item on
21461 * @p obj (or @c NULL, on errors).
21463 * @warning The returned value is @b not an #Elm_Index_Item item
21464 * handle, but the data associated to it (see the @c item parameter
21465 * in elm_index_item_append(), as an example).
21469 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21472 * Append a new item on a given index widget.
21474 * @param obj The index object.
21475 * @param letter Letter under which the item should be indexed
21476 * @param item The item data to set for the index's item
21478 * Despite the most common usage of the @p letter argument is for
21479 * single char strings, one could use arbitrary strings as index
21482 * @c item will be the pointer returned back on @c "changed", @c
21483 * "delay,changed" and @c "selected" smart events.
21487 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21490 * Prepend a new item on a given index widget.
21492 * @param obj The index object.
21493 * @param letter Letter under which the item should be indexed
21494 * @param item The item data to set for the index's item
21496 * Despite the most common usage of the @p letter argument is for
21497 * single char strings, one could use arbitrary strings as index
21500 * @c item will be the pointer returned back on @c "changed", @c
21501 * "delay,changed" and @c "selected" smart events.
21505 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21508 * Append a new item, on a given index widget, <b>after the item
21509 * having @p relative as data</b>.
21511 * @param obj The index object.
21512 * @param letter Letter under which the item should be indexed
21513 * @param item The item data to set for the index's item
21514 * @param relative The item data of the index item to be the
21515 * predecessor of this new one
21517 * Despite the most common usage of the @p letter argument is for
21518 * single char strings, one could use arbitrary strings as index
21521 * @c item will be the pointer returned back on @c "changed", @c
21522 * "delay,changed" and @c "selected" smart events.
21524 * @note If @p relative is @c NULL or if it's not found to be data
21525 * set on any previous item on @p obj, this function will behave as
21526 * elm_index_item_append().
21530 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
21533 * Prepend a new item, on a given index widget, <b>after the item
21534 * having @p relative as data</b>.
21536 * @param obj The index object.
21537 * @param letter Letter under which the item should be indexed
21538 * @param item The item data to set for the index's item
21539 * @param relative The item data of the index item to be the
21540 * successor of this new one
21542 * Despite the most common usage of the @p letter argument is for
21543 * single char strings, one could use arbitrary strings as index
21546 * @c item will be the pointer returned back on @c "changed", @c
21547 * "delay,changed" and @c "selected" smart events.
21549 * @note If @p relative is @c NULL or if it's not found to be data
21550 * set on any previous item on @p obj, this function will behave as
21551 * elm_index_item_prepend().
21555 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
21558 * Insert a new item into the given index widget, using @p cmp_func
21559 * function to sort items (by item handles).
21561 * @param obj The index object.
21562 * @param letter Letter under which the item should be indexed
21563 * @param item The item data to set for the index's item
21564 * @param cmp_func The comparing function to be used to sort index
21565 * items <b>by #Elm_Index_Item item handles</b>
21566 * @param cmp_data_func A @b fallback function to be called for the
21567 * sorting of index items <b>by item data</b>). It will be used
21568 * when @p cmp_func returns @c 0 (equality), which means an index
21569 * item with provided item data already exists. To decide which
21570 * data item should be pointed to by the index item in question, @p
21571 * cmp_data_func will be used. If @p cmp_data_func returns a
21572 * non-negative value, the previous index item data will be
21573 * replaced by the given @p item pointer. If the previous data need
21574 * to be freed, it should be done by the @p cmp_data_func function,
21575 * because all references to it will be lost. If this function is
21576 * not provided (@c NULL is given), index items will be @b
21577 * duplicated, if @p cmp_func returns @c 0.
21579 * Despite the most common usage of the @p letter argument is for
21580 * single char strings, one could use arbitrary strings as index
21583 * @c item will be the pointer returned back on @c "changed", @c
21584 * "delay,changed" and @c "selected" smart events.
21588 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);
21591 * Remove an item from a given index widget, <b>to be referenced by
21592 * it's data value</b>.
21594 * @param obj The index object
21595 * @param item The item's data pointer for the item to be removed
21598 * If a deletion callback is set, via elm_index_item_del_cb_set(),
21599 * that callback function will be called by this one.
21601 * @warning The item to be removed from @p obj will be found via
21602 * its item data pointer, and not by an #Elm_Index_Item handle.
21606 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
21609 * Find a given index widget's item, <b>using item data</b>.
21611 * @param obj The index object
21612 * @param item The item data pointed to by the desired index item
21613 * @return The index item handle, if found, or @c NULL otherwise
21617 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
21620 * Removes @b all items from a given index widget.
21622 * @param obj The index object.
21624 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
21625 * that callback function will be called for each item in @p obj.
21629 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
21632 * Go to a given items level on a index widget
21634 * @param obj The index object
21635 * @param level The index level (one of @c 0 or @c 1)
21639 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21642 * Return the data associated with a given index widget item
21644 * @param it The index widget item handle
21645 * @return The data associated with @p it
21647 * @see elm_index_item_data_set()
21651 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
21654 * Set the data associated with a given index widget item
21656 * @param it The index widget item handle
21657 * @param data The new data pointer to set to @p it
21659 * This sets new item data on @p it.
21661 * @warning The old data pointer won't be touched by this function, so
21662 * the user had better to free that old data himself/herself.
21666 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
21669 * Set the function to be called when a given index widget item is freed.
21671 * @param it The item to set the callback on
21672 * @param func The function to call on the item's deletion
21674 * When called, @p func will have both @c data and @c event_info
21675 * arguments with the @p it item's data value and, naturally, the
21676 * @c obj argument with a handle to the parent index widget.
21680 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
21683 * Get the letter (string) set on a given index widget item.
21685 * @param it The index item handle
21686 * @return The letter string set on @p it
21690 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
21697 * @defgroup Photocam Photocam
21699 * @image html img/widget/photocam/preview-00.png
21700 * @image latex img/widget/photocam/preview-00.eps
21702 * This is a widget specifically for displaying high-resolution digital
21703 * camera photos giving speedy feedback (fast load), low memory footprint
21704 * and zooming and panning as well as fitting logic. It is entirely focused
21705 * on jpeg images, and takes advantage of properties of the jpeg format (via
21706 * evas loader features in the jpeg loader).
21708 * Signals that you can add callbacks for are:
21709 * @li "clicked" - This is called when a user has clicked the photo without
21711 * @li "press" - This is called when a user has pressed down on the photo.
21712 * @li "longpressed" - This is called when a user has pressed down on the
21713 * photo for a long time without dragging around.
21714 * @li "clicked,double" - This is called when a user has double-clicked the
21716 * @li "load" - Photo load begins.
21717 * @li "loaded" - This is called when the image file load is complete for the
21718 * first view (low resolution blurry version).
21719 * @li "load,detail" - Photo detailed data load begins.
21720 * @li "loaded,detail" - This is called when the image file load is complete
21721 * for the detailed image data (full resolution needed).
21722 * @li "zoom,start" - Zoom animation started.
21723 * @li "zoom,stop" - Zoom animation stopped.
21724 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
21725 * @li "scroll" - the content has been scrolled (moved)
21726 * @li "scroll,anim,start" - scrolling animation has started
21727 * @li "scroll,anim,stop" - scrolling animation has stopped
21728 * @li "scroll,drag,start" - dragging the contents around has started
21729 * @li "scroll,drag,stop" - dragging the contents around has stopped
21731 * @ref tutorial_photocam shows the API in action.
21735 * @brief Types of zoom available.
21737 typedef enum _Elm_Photocam_Zoom_Mode
21739 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
21740 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
21741 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
21742 ELM_PHOTOCAM_ZOOM_MODE_LAST
21743 } Elm_Photocam_Zoom_Mode;
21745 * @brief Add a new Photocam object
21747 * @param parent The parent object
21748 * @return The new object or NULL if it cannot be created
21750 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21752 * @brief Set the photo file to be shown
21754 * @param obj The photocam object
21755 * @param file The photo file
21756 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
21758 * This sets (and shows) the specified file (with a relative or absolute
21759 * path) and will return a load error (same error that
21760 * evas_object_image_load_error_get() will return). The image will change and
21761 * adjust its size at this point and begin a background load process for this
21762 * photo that at some time in the future will be displayed at the full
21765 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
21767 * @brief Returns the path of the current image file
21769 * @param obj The photocam object
21770 * @return Returns the path
21772 * @see elm_photocam_file_set()
21774 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21776 * @brief Set the zoom level of the photo
21778 * @param obj The photocam object
21779 * @param zoom The zoom level to set
21781 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
21782 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
21783 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
21784 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
21787 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
21789 * @brief Get the zoom level of the photo
21791 * @param obj The photocam object
21792 * @return The current zoom level
21794 * This returns the current zoom level of the photocam object. Note that if
21795 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
21796 * (which is the default), the zoom level may be changed at any time by the
21797 * photocam object itself to account for photo size and photocam viewpoer
21800 * @see elm_photocam_zoom_set()
21801 * @see elm_photocam_zoom_mode_set()
21803 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21805 * @brief Set the zoom mode
21807 * @param obj The photocam object
21808 * @param mode The desired mode
21810 * This sets the zoom mode to manual or one of several automatic levels.
21811 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
21812 * elm_photocam_zoom_set() and will stay at that level until changed by code
21813 * or until zoom mode is changed. This is the default mode. The Automatic
21814 * modes will allow the photocam object to automatically adjust zoom mode
21815 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
21816 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
21817 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
21818 * pixels within the frame are left unfilled.
21820 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
21822 * @brief Get the zoom mode
21824 * @param obj The photocam object
21825 * @return The current zoom mode
21827 * This gets the current zoom mode of the photocam object.
21829 * @see elm_photocam_zoom_mode_set()
21831 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21833 * @brief Get the current image pixel width and height
21835 * @param obj The photocam object
21836 * @param w A pointer to the width return
21837 * @param h A pointer to the height return
21839 * This gets the current photo pixel width and height (for the original).
21840 * The size will be returned in the integers @p w and @p h that are pointed
21843 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
21845 * @brief Get the area of the image that is currently shown
21848 * @param x A pointer to the X-coordinate of region
21849 * @param y A pointer to the Y-coordinate of region
21850 * @param w A pointer to the width
21851 * @param h A pointer to the height
21853 * @see elm_photocam_image_region_show()
21854 * @see elm_photocam_image_region_bring_in()
21856 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
21858 * @brief Set the viewed portion of the image
21860 * @param obj The photocam object
21861 * @param x X-coordinate of region in image original pixels
21862 * @param y Y-coordinate of region in image original pixels
21863 * @param w Width of region in image original pixels
21864 * @param h Height of region in image original pixels
21866 * This shows the region of the image without using animation.
21868 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
21870 * @brief Bring in the viewed portion of the image
21872 * @param obj The photocam object
21873 * @param x X-coordinate of region in image original pixels
21874 * @param y Y-coordinate of region in image original pixels
21875 * @param w Width of region in image original pixels
21876 * @param h Height of region in image original pixels
21878 * This shows the region of the image using animation.
21880 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
21882 * @brief Set the paused state for photocam
21884 * @param obj The photocam object
21885 * @param paused The pause state to set
21887 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
21888 * photocam. The default is off. This will stop zooming using animation on
21889 * zoom levels changes and change instantly. This will stop any existing
21890 * animations that are running.
21892 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
21894 * @brief Get the paused state for photocam
21896 * @param obj The photocam object
21897 * @return The current paused state
21899 * This gets the current paused state for the photocam object.
21901 * @see elm_photocam_paused_set()
21903 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21905 * @brief Get the internal low-res image used for photocam
21907 * @param obj The photocam object
21908 * @return The internal image object handle, or NULL if none exists
21910 * This gets the internal image object inside photocam. Do not modify it. It
21911 * is for inspection only, and hooking callbacks to. Nothing else. It may be
21912 * deleted at any time as well.
21914 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21916 * @brief Set the photocam scrolling bouncing.
21918 * @param obj The photocam object
21919 * @param h_bounce bouncing for horizontal
21920 * @param v_bounce bouncing for vertical
21922 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
21924 * @brief Get the photocam scrolling bouncing.
21926 * @param obj The photocam object
21927 * @param h_bounce bouncing for horizontal
21928 * @param v_bounce bouncing for vertical
21930 * @see elm_photocam_bounce_set()
21932 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
21938 * @defgroup Map Map
21939 * @ingroup Elementary
21941 * @image html img/widget/map/preview-00.png
21942 * @image latex img/widget/map/preview-00.eps
21944 * This is a widget specifically for displaying a map. It uses basically
21945 * OpenStreetMap provider http://www.openstreetmap.org/,
21946 * but custom providers can be added.
21948 * It supports some basic but yet nice features:
21949 * @li zoom and scroll
21950 * @li markers with content to be displayed when user clicks over it
21951 * @li group of markers
21954 * Smart callbacks one can listen to:
21956 * - "clicked" - This is called when a user has clicked the map without
21958 * - "press" - This is called when a user has pressed down on the map.
21959 * - "longpressed" - This is called when a user has pressed down on the map
21960 * for a long time without dragging around.
21961 * - "clicked,double" - This is called when a user has double-clicked
21963 * - "load,detail" - Map detailed data load begins.
21964 * - "loaded,detail" - This is called when all currently visible parts of
21965 * the map are loaded.
21966 * - "zoom,start" - Zoom animation started.
21967 * - "zoom,stop" - Zoom animation stopped.
21968 * - "zoom,change" - Zoom changed when using an auto zoom mode.
21969 * - "scroll" - the content has been scrolled (moved).
21970 * - "scroll,anim,start" - scrolling animation has started.
21971 * - "scroll,anim,stop" - scrolling animation has stopped.
21972 * - "scroll,drag,start" - dragging the contents around has started.
21973 * - "scroll,drag,stop" - dragging the contents around has stopped.
21974 * - "downloaded" - This is called when all currently required map images
21976 * - "route,load" - This is called when route request begins.
21977 * - "route,loaded" - This is called when route request ends.
21978 * - "name,load" - This is called when name request begins.
21979 * - "name,loaded- This is called when name request ends.
21981 * Available style for map widget:
21984 * Available style for markers:
21989 * Available style for marker bubble:
21992 * List of examples:
21993 * @li @ref map_example_01
21994 * @li @ref map_example_02
21995 * @li @ref map_example_03
22004 * @enum _Elm_Map_Zoom_Mode
22005 * @typedef Elm_Map_Zoom_Mode
22007 * Set map's zoom behavior. It can be set to manual or automatic.
22009 * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
22011 * Values <b> don't </b> work as bitmask, only one can be choosen.
22013 * @note Valid sizes are 2^zoom, consequently the map may be smaller
22014 * than the scroller view.
22016 * @see elm_map_zoom_mode_set()
22017 * @see elm_map_zoom_mode_get()
22021 typedef enum _Elm_Map_Zoom_Mode
22023 ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
22024 ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
22025 ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
22026 ELM_MAP_ZOOM_MODE_LAST
22027 } Elm_Map_Zoom_Mode;
22030 * @enum _Elm_Map_Route_Sources
22031 * @typedef Elm_Map_Route_Sources
22033 * Set route service to be used. By default used source is
22034 * #ELM_MAP_ROUTE_SOURCE_YOURS.
22036 * @see elm_map_route_source_set()
22037 * @see elm_map_route_source_get()
22041 typedef enum _Elm_Map_Route_Sources
22043 ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
22044 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. */
22045 ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
22046 ELM_MAP_ROUTE_SOURCE_LAST
22047 } Elm_Map_Route_Sources;
22049 typedef enum _Elm_Map_Name_Sources
22051 ELM_MAP_NAME_SOURCE_NOMINATIM,
22052 ELM_MAP_NAME_SOURCE_LAST
22053 } Elm_Map_Name_Sources;
22056 * @enum _Elm_Map_Route_Type
22057 * @typedef Elm_Map_Route_Type
22059 * Set type of transport used on route.
22061 * @see elm_map_route_add()
22065 typedef enum _Elm_Map_Route_Type
22067 ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
22068 ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
22069 ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
22070 ELM_MAP_ROUTE_TYPE_LAST
22071 } Elm_Map_Route_Type;
22074 * @enum _Elm_Map_Route_Method
22075 * @typedef Elm_Map_Route_Method
22077 * Set the routing method, what should be priorized, time or distance.
22079 * @see elm_map_route_add()
22083 typedef enum _Elm_Map_Route_Method
22085 ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
22086 ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
22087 ELM_MAP_ROUTE_METHOD_LAST
22088 } Elm_Map_Route_Method;
22090 typedef enum _Elm_Map_Name_Method
22092 ELM_MAP_NAME_METHOD_SEARCH,
22093 ELM_MAP_NAME_METHOD_REVERSE,
22094 ELM_MAP_NAME_METHOD_LAST
22095 } Elm_Map_Name_Method;
22097 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(). */
22098 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(). */
22099 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(). */
22100 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(). */
22101 typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
22102 typedef struct _Elm_Map_Track Elm_Map_Track;
22104 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. */
22105 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
22106 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
22107 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
22109 typedef char *(*ElmMapModuleSourceFunc) (void);
22110 typedef int (*ElmMapModuleZoomMinFunc) (void);
22111 typedef int (*ElmMapModuleZoomMaxFunc) (void);
22112 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
22113 typedef int (*ElmMapModuleRouteSourceFunc) (void);
22114 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
22115 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
22116 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
22117 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
22120 * Add a new map widget to the given parent Elementary (container) object.
22122 * @param parent The parent object.
22123 * @return a new map widget handle or @c NULL, on errors.
22125 * This function inserts a new map widget on the canvas.
22129 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22132 * Set the zoom level of the map.
22134 * @param obj The map object.
22135 * @param zoom The zoom level to set.
22137 * This sets the zoom level.
22139 * It will respect limits defined by elm_map_source_zoom_min_set() and
22140 * elm_map_source_zoom_max_set().
22142 * By default these values are 0 (world map) and 18 (maximum zoom).
22144 * This function should be used when zoom mode is set to
22145 * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
22146 * with elm_map_zoom_mode_set().
22148 * @see elm_map_zoom_mode_set().
22149 * @see elm_map_zoom_get().
22153 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22156 * Get the zoom level of the map.
22158 * @param obj The map object.
22159 * @return The current zoom level.
22161 * This returns the current zoom level of the map object.
22163 * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
22164 * (which is the default), the zoom level may be changed at any time by the
22165 * map object itself to account for map size and map viewport size.
22167 * @see elm_map_zoom_set() for details.
22171 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22174 * Set the zoom mode used by the map object.
22176 * @param obj The map object.
22177 * @param mode The zoom mode of the map, being it one of
22178 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22179 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22181 * This sets the zoom mode to manual or one of the automatic levels.
22182 * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
22183 * elm_map_zoom_set() and will stay at that level until changed by code
22184 * or until zoom mode is changed. This is the default mode.
22186 * The Automatic modes will allow the map object to automatically
22187 * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
22188 * adjust zoom so the map fits inside the scroll frame with no pixels
22189 * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
22190 * ensure no pixels within the frame are left unfilled. Do not forget that
22191 * the valid sizes are 2^zoom, consequently the map may be smaller than
22192 * the scroller view.
22194 * @see elm_map_zoom_set()
22198 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22201 * Get the zoom mode used by the map object.
22203 * @param obj The map object.
22204 * @return The zoom mode of the map, being it one of
22205 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22206 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22208 * This function returns the current zoom mode used by the map object.
22210 * @see elm_map_zoom_mode_set() for more details.
22214 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22217 * Get the current coordinates of the map.
22219 * @param obj The map object.
22220 * @param lon Pointer where to store longitude.
22221 * @param lat Pointer where to store latitude.
22223 * This gets the current center coordinates of the map object. It can be
22224 * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
22226 * @see elm_map_geo_region_bring_in()
22227 * @see elm_map_geo_region_show()
22231 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
22234 * Animatedly bring in given coordinates to the center of the map.
22236 * @param obj The map object.
22237 * @param lon Longitude to center at.
22238 * @param lat Latitude to center at.
22240 * This causes map to jump to the given @p lat and @p lon coordinates
22241 * and show it (by scrolling) in the center of the viewport, if it is not
22242 * already centered. This will use animation to do so and take a period
22243 * of time to complete.
22245 * @see elm_map_geo_region_show() for a function to avoid animation.
22246 * @see elm_map_geo_region_get()
22250 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22253 * Show the given coordinates at the center of the map, @b immediately.
22255 * @param obj The map object.
22256 * @param lon Longitude to center at.
22257 * @param lat Latitude to center at.
22259 * This causes map to @b redraw its viewport's contents to the
22260 * region contining the given @p lat and @p lon, that will be moved to the
22261 * center of the map.
22263 * @see elm_map_geo_region_bring_in() for a function to move with animation.
22264 * @see elm_map_geo_region_get()
22268 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22271 * Pause or unpause the map.
22273 * @param obj The map object.
22274 * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
22277 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22280 * The default is off.
22282 * This will stop zooming using animation, changing zoom levels will
22283 * change instantly. This will stop any existing animations that are running.
22285 * @see elm_map_paused_get()
22289 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22292 * Get a value whether map is paused or not.
22294 * @param obj The map object.
22295 * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
22296 * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
22298 * This gets the current paused state for the map object.
22300 * @see elm_map_paused_set() for details.
22304 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22307 * Set to show markers during zoom level changes or not.
22309 * @param obj The map object.
22310 * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
22313 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22316 * The default is off.
22318 * This will stop zooming using animation, changing zoom levels will
22319 * change instantly. This will stop any existing animations that are running.
22321 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22324 * The default is off.
22326 * Enabling it will force the map to stop displaying the markers during
22327 * zoom level changes. Set to on if you have a large number of markers.
22329 * @see elm_map_paused_markers_get()
22333 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22336 * Get a value whether markers will be displayed on zoom level changes or not
22338 * @param obj The map object.
22339 * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
22340 * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
22342 * This gets the current markers paused state for the map object.
22344 * @see elm_map_paused_markers_set() for details.
22348 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22351 * Get the information of downloading status.
22353 * @param obj The map object.
22354 * @param try_num Pointer where to store number of tiles being downloaded.
22355 * @param finish_num Pointer where to store number of tiles successfully
22358 * This gets the current downloading status for the map object, the number
22359 * of tiles being downloaded and the number of tiles already downloaded.
22363 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
22366 * Convert a pixel coordinate (x,y) into a geographic coordinate
22367 * (longitude, latitude).
22369 * @param obj The map object.
22370 * @param x the coordinate.
22371 * @param y the coordinate.
22372 * @param size the size in pixels of the map.
22373 * The map is a square and generally his size is : pow(2.0, zoom)*256.
22374 * @param lon Pointer where to store the longitude that correspond to x.
22375 * @param lat Pointer where to store the latitude that correspond to y.
22377 * @note Origin pixel point is the top left corner of the viewport.
22378 * Map zoom and size are taken on account.
22380 * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
22384 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);
22387 * Convert a geographic coordinate (longitude, latitude) into a pixel
22388 * coordinate (x, y).
22390 * @param obj The map object.
22391 * @param lon the longitude.
22392 * @param lat the latitude.
22393 * @param size the size in pixels of the map. The map is a square
22394 * and generally his size is : pow(2.0, zoom)*256.
22395 * @param x Pointer where to store the horizontal pixel coordinate that
22396 * correspond to the longitude.
22397 * @param y Pointer where to store the vertical pixel coordinate that
22398 * correspond to the latitude.
22400 * @note Origin pixel point is the top left corner of the viewport.
22401 * Map zoom and size are taken on account.
22403 * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
22407 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);
22410 * Convert a geographic coordinate (longitude, latitude) into a name
22413 * @param obj The map object.
22414 * @param lon the longitude.
22415 * @param lat the latitude.
22416 * @return name A #Elm_Map_Name handle for this coordinate.
22418 * To get the string for this address, elm_map_name_address_get()
22421 * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
22425 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22428 * Convert a name (address) into a geographic coordinate
22429 * (longitude, latitude).
22431 * @param obj The map object.
22432 * @param name The address.
22433 * @return name A #Elm_Map_Name handle for this address.
22435 * To get the longitude and latitude, elm_map_name_region_get()
22438 * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
22442 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
22445 * Convert a pixel coordinate into a rotated pixel coordinate.
22447 * @param obj The map object.
22448 * @param x horizontal coordinate of the point to rotate.
22449 * @param y vertical coordinate of the point to rotate.
22450 * @param cx rotation's center horizontal position.
22451 * @param cy rotation's center vertical position.
22452 * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
22453 * @param xx Pointer where to store rotated x.
22454 * @param yy Pointer where to store rotated y.
22458 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);
22461 * Add a new marker to the map object.
22463 * @param obj The map object.
22464 * @param lon The longitude of the marker.
22465 * @param lat The latitude of the marker.
22466 * @param clas The class, to use when marker @b isn't grouped to others.
22467 * @param clas_group The class group, to use when marker is grouped to others
22468 * @param data The data passed to the callbacks.
22470 * @return The created marker or @c NULL upon failure.
22472 * A marker will be created and shown in a specific point of the map, defined
22473 * by @p lon and @p lat.
22475 * It will be displayed using style defined by @p class when this marker
22476 * is displayed alone (not grouped). A new class can be created with
22477 * elm_map_marker_class_new().
22479 * If the marker is grouped to other markers, it will be displayed with
22480 * style defined by @p class_group. Markers with the same group are grouped
22481 * if they are close. A new group class can be created with
22482 * elm_map_marker_group_class_new().
22484 * Markers created with this method can be deleted with
22485 * elm_map_marker_remove().
22487 * A marker can have associated content to be displayed by a bubble,
22488 * when a user click over it, as well as an icon. These objects will
22489 * be fetch using class' callback functions.
22491 * @see elm_map_marker_class_new()
22492 * @see elm_map_marker_group_class_new()
22493 * @see elm_map_marker_remove()
22497 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);
22500 * Set the maximum numbers of markers' content to be displayed in a group.
22502 * @param obj The map object.
22503 * @param max The maximum numbers of items displayed in a bubble.
22505 * A bubble will be displayed when the user clicks over the group,
22506 * and will place the content of markers that belong to this group
22509 * A group can have a long list of markers, consequently the creation
22510 * of the content of the bubble can be very slow.
22512 * In order to avoid this, a maximum number of items is displayed
22515 * By default this number is 30.
22517 * Marker with the same group class are grouped if they are close.
22519 * @see elm_map_marker_add()
22523 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
22526 * Remove a marker from the map.
22528 * @param marker The marker to remove.
22530 * @see elm_map_marker_add()
22534 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22537 * Get the current coordinates of the marker.
22539 * @param marker marker.
22540 * @param lat Pointer where to store the marker's latitude.
22541 * @param lon Pointer where to store the marker's longitude.
22543 * These values are set when adding markers, with function
22544 * elm_map_marker_add().
22546 * @see elm_map_marker_add()
22550 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
22553 * Animatedly bring in given marker to the center of the map.
22555 * @param marker The marker to center at.
22557 * This causes map to jump to the given @p marker's coordinates
22558 * and show it (by scrolling) in the center of the viewport, if it is not
22559 * already centered. This will use animation to do so and take a period
22560 * of time to complete.
22562 * @see elm_map_marker_show() for a function to avoid animation.
22563 * @see elm_map_marker_region_get()
22567 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22570 * Show the given marker at the center of the map, @b immediately.
22572 * @param marker The marker to center at.
22574 * This causes map to @b redraw its viewport's contents to the
22575 * region contining the given @p marker's coordinates, that will be
22576 * moved to the center of the map.
22578 * @see elm_map_marker_bring_in() for a function to move with animation.
22579 * @see elm_map_markers_list_show() if more than one marker need to be
22581 * @see elm_map_marker_region_get()
22585 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22588 * Move and zoom the map to display a list of markers.
22590 * @param markers A list of #Elm_Map_Marker handles.
22592 * The map will be centered on the center point of the markers in the list.
22593 * Then the map will be zoomed in order to fit the markers using the maximum
22594 * zoom which allows display of all the markers.
22596 * @warning All the markers should belong to the same map object.
22598 * @see elm_map_marker_show() to show a single marker.
22599 * @see elm_map_marker_bring_in()
22603 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
22606 * Get the Evas object returned by the ElmMapMarkerGetFunc callback
22608 * @param marker The marker wich content should be returned.
22609 * @return Return the evas object if it exists, else @c NULL.
22611 * To set callback function #ElmMapMarkerGetFunc for the marker class,
22612 * elm_map_marker_class_get_cb_set() should be used.
22614 * This content is what will be inside the bubble that will be displayed
22615 * when an user clicks over the marker.
22617 * This returns the actual Evas object used to be placed inside
22618 * the bubble. This may be @c NULL, as it may
22619 * not have been created or may have been deleted, at any time, by
22620 * the map. <b>Do not modify this object</b> (move, resize,
22621 * show, hide, etc.), as the map is controlling it. This
22622 * function is for querying, emitting custom signals or hooking
22623 * lower level callbacks for events on that object. Do not delete
22624 * this object under any circumstances.
22628 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22631 * Update the marker
22633 * @param marker The marker to be updated.
22635 * If a content is set to this marker, it will call function to delete it,
22636 * #ElmMapMarkerDelFunc, and then will fetch the content again with
22637 * #ElmMapMarkerGetFunc.
22639 * These functions are set for the marker class with
22640 * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
22644 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22647 * Close all the bubbles opened by the user.
22649 * @param obj The map object.
22651 * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
22652 * when the user clicks on a marker.
22654 * This functions is set for the marker class with
22655 * elm_map_marker_class_get_cb_set().
22659 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
22662 * Create a new group class.
22664 * @param obj The map object.
22665 * @return Returns the new group class.
22667 * Each marker must be associated to a group class. Markers in the same
22668 * group are grouped if they are close.
22670 * The group class defines the style of the marker when a marker is grouped
22671 * to others markers. When it is alone, another class will be used.
22673 * A group class will need to be provided when creating a marker with
22674 * elm_map_marker_add().
22676 * Some properties and functions can be set by class, as:
22677 * - style, with elm_map_group_class_style_set()
22678 * - data - to be associated to the group class. It can be set using
22679 * elm_map_group_class_data_set().
22680 * - min zoom to display markers, set with
22681 * elm_map_group_class_zoom_displayed_set().
22682 * - max zoom to group markers, set using
22683 * elm_map_group_class_zoom_grouped_set().
22684 * - visibility - set if markers will be visible or not, set with
22685 * elm_map_group_class_hide_set().
22686 * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
22687 * It can be set using elm_map_group_class_icon_cb_set().
22689 * @see elm_map_marker_add()
22690 * @see elm_map_group_class_style_set()
22691 * @see elm_map_group_class_data_set()
22692 * @see elm_map_group_class_zoom_displayed_set()
22693 * @see elm_map_group_class_zoom_grouped_set()
22694 * @see elm_map_group_class_hide_set()
22695 * @see elm_map_group_class_icon_cb_set()
22699 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
22702 * Set the marker's style of a group class.
22704 * @param clas The group class.
22705 * @param style The style to be used by markers.
22707 * Each marker must be associated to a group class, and will use the style
22708 * defined by such class when grouped to other markers.
22710 * The following styles are provided by default theme:
22711 * @li @c radio - blue circle
22712 * @li @c radio2 - green circle
22715 * @see elm_map_group_class_new() for more details.
22716 * @see elm_map_marker_add()
22720 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
22723 * Set the icon callback function of a group class.
22725 * @param clas The group class.
22726 * @param icon_get The callback function that will return the icon.
22728 * Each marker must be associated to a group class, and it can display a
22729 * custom icon. The function @p icon_get must return this icon.
22731 * @see elm_map_group_class_new() for more details.
22732 * @see elm_map_marker_add()
22736 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
22739 * Set the data associated to the group class.
22741 * @param clas The group class.
22742 * @param data The new user data.
22744 * This data will be passed for callback functions, like icon get callback,
22745 * that can be set with elm_map_group_class_icon_cb_set().
22747 * If a data was previously set, the object will lose the pointer for it,
22748 * so if needs to be freed, you must do it yourself.
22750 * @see elm_map_group_class_new() for more details.
22751 * @see elm_map_group_class_icon_cb_set()
22752 * @see elm_map_marker_add()
22756 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
22759 * Set the minimum zoom from where the markers are displayed.
22761 * @param clas The group class.
22762 * @param zoom The minimum zoom.
22764 * Markers only will be displayed when the map is displayed at @p zoom
22767 * @see elm_map_group_class_new() for more details.
22768 * @see elm_map_marker_add()
22772 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
22775 * Set the zoom from where the markers are no more grouped.
22777 * @param clas The group class.
22778 * @param zoom The maximum zoom.
22780 * Markers only will be grouped when the map is displayed at
22781 * less than @p zoom.
22783 * @see elm_map_group_class_new() for more details.
22784 * @see elm_map_marker_add()
22788 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
22791 * Set if the markers associated to the group class @clas are hidden or not.
22793 * @param clas The group class.
22794 * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
22797 * If @p hide is @c EINA_TRUE the markers will be hidden, but default
22802 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
22805 * Create a new marker class.
22807 * @param obj The map object.
22808 * @return Returns the new group class.
22810 * Each marker must be associated to a class.
22812 * The marker class defines the style of the marker when a marker is
22813 * displayed alone, i.e., not grouped to to others markers. When grouped
22814 * it will use group class style.
22816 * A marker class will need to be provided when creating a marker with
22817 * elm_map_marker_add().
22819 * Some properties and functions can be set by class, as:
22820 * - style, with elm_map_marker_class_style_set()
22821 * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
22822 * It can be set using elm_map_marker_class_icon_cb_set().
22823 * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
22824 * Set using elm_map_marker_class_get_cb_set().
22825 * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
22826 * Set using elm_map_marker_class_del_cb_set().
22828 * @see elm_map_marker_add()
22829 * @see elm_map_marker_class_style_set()
22830 * @see elm_map_marker_class_icon_cb_set()
22831 * @see elm_map_marker_class_get_cb_set()
22832 * @see elm_map_marker_class_del_cb_set()
22836 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
22839 * Set the marker's style of a marker class.
22841 * @param clas The marker class.
22842 * @param style The style to be used by markers.
22844 * Each marker must be associated to a marker class, and will use the style
22845 * defined by such class when alone, i.e., @b not grouped to other markers.
22847 * The following styles are provided by default theme:
22852 * @see elm_map_marker_class_new() for more details.
22853 * @see elm_map_marker_add()
22857 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
22860 * Set the icon callback function of a marker class.
22862 * @param clas The marker class.
22863 * @param icon_get The callback function that will return the icon.
22865 * Each marker must be associated to a marker class, and it can display a
22866 * custom icon. The function @p icon_get must return this icon.
22868 * @see elm_map_marker_class_new() for more details.
22869 * @see elm_map_marker_add()
22873 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
22876 * Set the bubble content callback function of a marker class.
22878 * @param clas The marker class.
22879 * @param get The callback function that will return the content.
22881 * Each marker must be associated to a marker class, and it can display a
22882 * a content on a bubble that opens when the user click over the marker.
22883 * The function @p get must return this content object.
22885 * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
22888 * @see elm_map_marker_class_new() for more details.
22889 * @see elm_map_marker_class_del_cb_set()
22890 * @see elm_map_marker_add()
22894 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
22897 * Set the callback function used to delete bubble content of a marker class.
22899 * @param clas The marker class.
22900 * @param del The callback function that will delete the content.
22902 * Each marker must be associated to a marker class, and it can display a
22903 * a content on a bubble that opens when the user click over the marker.
22904 * The function to return such content can be set with
22905 * elm_map_marker_class_get_cb_set().
22907 * If this content must be freed, a callback function need to be
22908 * set for that task with this function.
22910 * If this callback is defined it will have to delete (or not) the
22911 * object inside, but if the callback is not defined the object will be
22912 * destroyed with evas_object_del().
22914 * @see elm_map_marker_class_new() for more details.
22915 * @see elm_map_marker_class_get_cb_set()
22916 * @see elm_map_marker_add()
22920 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
22923 * Get the list of available sources.
22925 * @param obj The map object.
22926 * @return The source names list.
22928 * It will provide a list with all available sources, that can be set as
22929 * current source with elm_map_source_name_set(), or get with
22930 * elm_map_source_name_get().
22932 * Available sources:
22938 * @see elm_map_source_name_set() for more details.
22939 * @see elm_map_source_name_get()
22943 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22946 * Set the source of the map.
22948 * @param obj The map object.
22949 * @param source The source to be used.
22951 * Map widget retrieves images that composes the map from a web service.
22952 * This web service can be set with this method.
22954 * A different service can return a different maps with different
22955 * information and it can use different zoom values.
22957 * The @p source_name need to match one of the names provided by
22958 * elm_map_source_names_get().
22960 * The current source can be get using elm_map_source_name_get().
22962 * @see elm_map_source_names_get()
22963 * @see elm_map_source_name_get()
22968 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
22971 * Get the name of currently used source.
22973 * @param obj The map object.
22974 * @return Returns the name of the source in use.
22976 * @see elm_map_source_name_set() for more details.
22980 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22983 * Set the source of the route service to be used by the map.
22985 * @param obj The map object.
22986 * @param source The route service to be used, being it one of
22987 * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
22988 * and #ELM_MAP_ROUTE_SOURCE_ORS.
22990 * Each one has its own algorithm, so the route retrieved may
22991 * differ depending on the source route. Now, only the default is working.
22993 * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
22994 * http://www.yournavigation.org/.
22996 * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
22997 * assumptions. Its routing core is based on Contraction Hierarchies.
22999 * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
23001 * @see elm_map_route_source_get().
23005 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
23008 * Get the current route source.
23010 * @param obj The map object.
23011 * @return The source of the route service used by the map.
23013 * @see elm_map_route_source_set() for details.
23017 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23020 * Set the minimum zoom of the source.
23022 * @param obj The map object.
23023 * @param zoom New minimum zoom value to be used.
23025 * By default, it's 0.
23029 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23032 * Get the minimum zoom of the source.
23034 * @param obj The map object.
23035 * @return Returns the minimum zoom of the source.
23037 * @see elm_map_source_zoom_min_set() for details.
23041 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23044 * Set the maximum zoom of the source.
23046 * @param obj The map object.
23047 * @param zoom New maximum zoom value to be used.
23049 * By default, it's 18.
23053 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23056 * Get the maximum zoom of the source.
23058 * @param obj The map object.
23059 * @return Returns the maximum zoom of the source.
23061 * @see elm_map_source_zoom_min_set() for details.
23065 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23068 * Set the user agent used by the map object to access routing services.
23070 * @param obj The map object.
23071 * @param user_agent The user agent to be used by the map.
23073 * User agent is a client application implementing a network protocol used
23074 * in communications within a client–server distributed computing system
23076 * The @p user_agent identification string will transmitted in a header
23077 * field @c User-Agent.
23079 * @see elm_map_user_agent_get()
23083 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
23086 * Get the user agent used by the map object.
23088 * @param obj The map object.
23089 * @return The user agent identification string used by the map.
23091 * @see elm_map_user_agent_set() for details.
23095 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23098 * Add a new route to the map object.
23100 * @param obj The map object.
23101 * @param type The type of transport to be considered when tracing a route.
23102 * @param method The routing method, what should be priorized.
23103 * @param flon The start longitude.
23104 * @param flat The start latitude.
23105 * @param tlon The destination longitude.
23106 * @param tlat The destination latitude.
23108 * @return The created route or @c NULL upon failure.
23110 * A route will be traced by point on coordinates (@p flat, @p flon)
23111 * to point on coordinates (@p tlat, @p tlon), using the route service
23112 * set with elm_map_route_source_set().
23114 * It will take @p type on consideration to define the route,
23115 * depending if the user will be walking or driving, the route may vary.
23116 * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
23117 * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
23119 * Another parameter is what the route should priorize, the minor distance
23120 * or the less time to be spend on the route. So @p method should be one
23121 * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
23123 * Routes created with this method can be deleted with
23124 * elm_map_route_remove(), colored with elm_map_route_color_set(),
23125 * and distance can be get with elm_map_route_distance_get().
23127 * @see elm_map_route_remove()
23128 * @see elm_map_route_color_set()
23129 * @see elm_map_route_distance_get()
23130 * @see elm_map_route_source_set()
23134 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);
23137 * Remove a route from the map.
23139 * @param route The route to remove.
23141 * @see elm_map_route_add()
23145 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23148 * Set the route color.
23150 * @param route The route object.
23151 * @param r Red channel value, from 0 to 255.
23152 * @param g Green channel value, from 0 to 255.
23153 * @param b Blue channel value, from 0 to 255.
23154 * @param a Alpha channel value, from 0 to 255.
23156 * It uses an additive color model, so each color channel represents
23157 * how much of each primary colors must to be used. 0 represents
23158 * ausence of this color, so if all of the three are set to 0,
23159 * the color will be black.
23161 * These component values should be integers in the range 0 to 255,
23162 * (single 8-bit byte).
23164 * This sets the color used for the route. By default, it is set to
23165 * solid red (r = 255, g = 0, b = 0, a = 255).
23167 * For alpha channel, 0 represents completely transparent, and 255, opaque.
23169 * @see elm_map_route_color_get()
23173 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
23176 * Get the route color.
23178 * @param route The route object.
23179 * @param r Pointer where to store the red channel value.
23180 * @param g Pointer where to store the green channel value.
23181 * @param b Pointer where to store the blue channel value.
23182 * @param a Pointer where to store the alpha channel value.
23184 * @see elm_map_route_color_set() for details.
23188 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
23191 * Get the route distance in kilometers.
23193 * @param route The route object.
23194 * @return The distance of route (unit : km).
23198 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23201 * Get the information of route nodes.
23203 * @param route The route object.
23204 * @return Returns a string with the nodes of route.
23208 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23211 * Get the information of route waypoint.
23213 * @param route the route object.
23214 * @return Returns a string with information about waypoint of route.
23218 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23221 * Get the address of the name.
23223 * @param name The name handle.
23224 * @return Returns the address string of @p name.
23226 * This gets the coordinates of the @p name, created with one of the
23227 * conversion functions.
23229 * @see elm_map_utils_convert_name_into_coord()
23230 * @see elm_map_utils_convert_coord_into_name()
23234 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23237 * Get the current coordinates of the name.
23239 * @param name The name handle.
23240 * @param lat Pointer where to store the latitude.
23241 * @param lon Pointer where to store The longitude.
23243 * This gets the coordinates of the @p name, created with one of the
23244 * conversion functions.
23246 * @see elm_map_utils_convert_name_into_coord()
23247 * @see elm_map_utils_convert_coord_into_name()
23251 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
23254 * Remove a name from the map.
23256 * @param name The name to remove.
23258 * Basically the struct handled by @p name will be freed, so convertions
23259 * between address and coordinates will be lost.
23261 * @see elm_map_utils_convert_name_into_coord()
23262 * @see elm_map_utils_convert_coord_into_name()
23266 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23271 * @param obj The map object.
23272 * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
23273 * @param cx Rotation's center horizontal position.
23274 * @param cy Rotation's center vertical position.
23276 * @see elm_map_rotate_get()
23280 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
23283 * Get the rotate degree of the map
23285 * @param obj The map object
23286 * @param degree Pointer where to store degrees from 0.0 to 360.0
23287 * to rotate arount Z axis.
23288 * @param cx Pointer where to store rotation's center horizontal position.
23289 * @param cy Pointer where to store rotation's center vertical position.
23291 * @see elm_map_rotate_set() to set map rotation.
23295 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);
23298 * Enable or disable mouse wheel to be used to zoom in / out the map.
23300 * @param obj The map object.
23301 * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
23304 * Mouse wheel can be used for the user to zoom in or zoom out the map.
23306 * It's disabled by default.
23308 * @see elm_map_wheel_disabled_get()
23312 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
23315 * Get a value whether mouse wheel is enabled or not.
23317 * @param obj The map object.
23318 * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
23319 * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23321 * Mouse wheel can be used for the user to zoom in or zoom out the map.
23323 * @see elm_map_wheel_disabled_set() for details.
23327 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23331 * Add a track on the map
23333 * @param obj The map object.
23334 * @param emap The emap route object.
23335 * @return The route object. This is an elm object of type Route.
23337 * @see elm_route_add() for details.
23341 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
23345 * Remove a track from the map
23347 * @param obj The map object.
23348 * @param route The track to remove.
23352 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
23359 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
23361 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
23363 EAPI double elm_route_lon_min_get(Evas_Object *obj);
23364 EAPI double elm_route_lat_min_get(Evas_Object *obj);
23365 EAPI double elm_route_lon_max_get(Evas_Object *obj);
23366 EAPI double elm_route_lat_max_get(Evas_Object *obj);
23370 * @defgroup Panel Panel
23372 * @image html img/widget/panel/preview-00.png
23373 * @image latex img/widget/panel/preview-00.eps
23375 * @brief A panel is a type of animated container that contains subobjects.
23376 * It can be expanded or contracted by clicking the button on it's edge.
23378 * Orientations are as follows:
23379 * @li ELM_PANEL_ORIENT_TOP
23380 * @li ELM_PANEL_ORIENT_LEFT
23381 * @li ELM_PANEL_ORIENT_RIGHT
23383 * @ref tutorial_panel shows one way to use this widget.
23386 typedef enum _Elm_Panel_Orient
23388 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
23389 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
23390 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
23391 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
23392 } Elm_Panel_Orient;
23394 * @brief Adds a panel object
23396 * @param parent The parent object
23398 * @return The panel object, or NULL on failure
23400 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23402 * @brief Sets the orientation of the panel
23404 * @param parent The parent object
23405 * @param orient The panel orientation. Can be one of the following:
23406 * @li ELM_PANEL_ORIENT_TOP
23407 * @li ELM_PANEL_ORIENT_LEFT
23408 * @li ELM_PANEL_ORIENT_RIGHT
23410 * Sets from where the panel will (dis)appear.
23412 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
23414 * @brief Get the orientation of the panel.
23416 * @param obj The panel object
23417 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
23419 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23421 * @brief Set the content of the panel.
23423 * @param obj The panel object
23424 * @param content The panel content
23426 * Once the content object is set, a previously set one will be deleted.
23427 * If you want to keep that old content object, use the
23428 * elm_panel_content_unset() function.
23430 EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23432 * @brief Get the content of the panel.
23434 * @param obj The panel object
23435 * @return The content that is being used
23437 * Return the content object which is set for this widget.
23439 * @see elm_panel_content_set()
23441 EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23443 * @brief Unset the content of the panel.
23445 * @param obj The panel object
23446 * @return The content that was being used
23448 * Unparent and return the content object which was set for this widget.
23450 * @see elm_panel_content_set()
23452 EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23454 * @brief Set the state of the panel.
23456 * @param obj The panel object
23457 * @param hidden If true, the panel will run the animation to contract
23459 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
23461 * @brief Get the state of the panel.
23463 * @param obj The panel object
23464 * @param hidden If true, the panel is in the "hide" state
23466 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23468 * @brief Toggle the hidden state of the panel from code
23470 * @param obj The panel object
23472 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
23478 * @defgroup Panes Panes
23479 * @ingroup Elementary
23481 * @image html img/widget/panes/preview-00.png
23482 * @image latex img/widget/panes/preview-00.eps width=\textwidth
23484 * @image html img/panes.png
23485 * @image latex img/panes.eps width=\textwidth
23487 * The panes adds a dragable bar between two contents. When dragged
23488 * this bar will resize contents size.
23490 * Panes can be displayed vertically or horizontally, and contents
23491 * size proportion can be customized (homogeneous by default).
23493 * Smart callbacks one can listen to:
23494 * - "press" - The panes has been pressed (button wasn't released yet).
23495 * - "unpressed" - The panes was released after being pressed.
23496 * - "clicked" - The panes has been clicked>
23497 * - "clicked,double" - The panes has been double clicked
23499 * Available styles for it:
23502 * Here is an example on its usage:
23503 * @li @ref panes_example
23507 * @addtogroup Panes
23512 * Add a new panes widget to the given parent Elementary
23513 * (container) object.
23515 * @param parent The parent object.
23516 * @return a new panes widget handle or @c NULL, on errors.
23518 * This function inserts a new panes widget on the canvas.
23522 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23525 * Set the left content of the panes widget.
23527 * @param obj The panes object.
23528 * @param content The new left content object.
23530 * Once the content object is set, a previously set one will be deleted.
23531 * If you want to keep that old content object, use the
23532 * elm_panes_content_left_unset() function.
23534 * If panes is displayed vertically, left content will be displayed at
23537 * @see elm_panes_content_left_get()
23538 * @see elm_panes_content_right_set() to set content on the other side.
23542 EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23545 * Set the right content of the panes widget.
23547 * @param obj The panes object.
23548 * @param content The new right content object.
23550 * Once the content object is set, a previously set one will be deleted.
23551 * If you want to keep that old content object, use the
23552 * elm_panes_content_right_unset() function.
23554 * If panes is displayed vertically, left content will be displayed at
23557 * @see elm_panes_content_right_get()
23558 * @see elm_panes_content_left_set() to set content on the other side.
23562 EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23565 * Get the left content of the panes.
23567 * @param obj The panes object.
23568 * @return The left content object that is being used.
23570 * Return the left content object which is set for this widget.
23572 * @see elm_panes_content_left_set() for details.
23576 EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23579 * Get the right content of the panes.
23581 * @param obj The panes object
23582 * @return The right content object that is being used
23584 * Return the right content object which is set for this widget.
23586 * @see elm_panes_content_right_set() for details.
23590 EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23593 * Unset the left content used for the panes.
23595 * @param obj The panes object.
23596 * @return The left content object that was being used.
23598 * Unparent and return the left content object which was set for this widget.
23600 * @see elm_panes_content_left_set() for details.
23601 * @see elm_panes_content_left_get().
23605 EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23608 * Unset the right content used for the panes.
23610 * @param obj The panes object.
23611 * @return The right content object that was being used.
23613 * Unparent and return the right content object which was set for this
23616 * @see elm_panes_content_right_set() for details.
23617 * @see elm_panes_content_right_get().
23621 EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23624 * Get the size proportion of panes widget's left side.
23626 * @param obj The panes object.
23627 * @return float value between 0.0 and 1.0 representing size proportion
23630 * @see elm_panes_content_left_size_set() for more details.
23634 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23637 * Set the size proportion of panes widget's left side.
23639 * @param obj The panes object.
23640 * @param size Value between 0.0 and 1.0 representing size proportion
23643 * By default it's homogeneous, i.e., both sides have the same size.
23645 * If something different is required, it can be set with this function.
23646 * For example, if the left content should be displayed over
23647 * 75% of the panes size, @p size should be passed as @c 0.75.
23648 * This way, right content will be resized to 25% of panes size.
23650 * If displayed vertically, left content is displayed at top, and
23651 * right content at bottom.
23653 * @note This proportion will change when user drags the panes bar.
23655 * @see elm_panes_content_left_size_get()
23659 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
23662 * Set the orientation of a given panes widget.
23664 * @param obj The panes object.
23665 * @param horizontal Use @c EINA_TRUE to make @p obj to be
23666 * @b horizontal, @c EINA_FALSE to make it @b vertical.
23668 * Use this function to change how your panes is to be
23669 * disposed: vertically or horizontally.
23671 * By default it's displayed horizontally.
23673 * @see elm_panes_horizontal_get()
23677 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
23680 * Retrieve the orientation of a given panes widget.
23682 * @param obj The panes object.
23683 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
23684 * @c EINA_FALSE if it's @b vertical (and on errors).
23686 * @see elm_panes_horizontal_set() for more details.
23690 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23691 EAPI void elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
23692 EAPI Eina_Bool elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23699 * @defgroup Flip Flip
23701 * @image html img/widget/flip/preview-00.png
23702 * @image latex img/widget/flip/preview-00.eps
23704 * This widget holds 2 content objects(Evas_Object): one on the front and one
23705 * on the back. It allows you to flip from front to back and vice-versa using
23706 * various animations.
23708 * If either the front or back contents are not set the flip will treat that
23709 * as transparent. So if you wore to set the front content but not the back,
23710 * and then call elm_flip_go() you would see whatever is below the flip.
23712 * For a list of supported animations see elm_flip_go().
23714 * Signals that you can add callbacks for are:
23715 * "animate,begin" - when a flip animation was started
23716 * "animate,done" - when a flip animation is finished
23718 * @ref tutorial_flip show how to use most of the API.
23722 typedef enum _Elm_Flip_Mode
23724 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
23725 ELM_FLIP_ROTATE_X_CENTER_AXIS,
23726 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
23727 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
23728 ELM_FLIP_CUBE_LEFT,
23729 ELM_FLIP_CUBE_RIGHT,
23731 ELM_FLIP_CUBE_DOWN,
23732 ELM_FLIP_PAGE_LEFT,
23733 ELM_FLIP_PAGE_RIGHT,
23737 typedef enum _Elm_Flip_Interaction
23739 ELM_FLIP_INTERACTION_NONE,
23740 ELM_FLIP_INTERACTION_ROTATE,
23741 ELM_FLIP_INTERACTION_CUBE,
23742 ELM_FLIP_INTERACTION_PAGE
23743 } Elm_Flip_Interaction;
23744 typedef enum _Elm_Flip_Direction
23746 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
23747 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
23748 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
23749 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
23750 } Elm_Flip_Direction;
23752 * @brief Add a new flip to the parent
23754 * @param parent The parent object
23755 * @return The new object or NULL if it cannot be created
23757 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23759 * @brief Set the front content of the flip widget.
23761 * @param obj The flip object
23762 * @param content The new front content object
23764 * Once the content object is set, a previously set one will be deleted.
23765 * If you want to keep that old content object, use the
23766 * elm_flip_content_front_unset() function.
23768 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23770 * @brief Set the back content of the flip widget.
23772 * @param obj The flip object
23773 * @param content The new back content object
23775 * Once the content object is set, a previously set one will be deleted.
23776 * If you want to keep that old content object, use the
23777 * elm_flip_content_back_unset() function.
23779 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23781 * @brief Get the front content used for the flip
23783 * @param obj The flip object
23784 * @return The front content object that is being used
23786 * Return the front content object which is set for this widget.
23788 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23790 * @brief Get the back content used for the flip
23792 * @param obj The flip object
23793 * @return The back content object that is being used
23795 * Return the back content object which is set for this widget.
23797 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23799 * @brief Unset the front content used for the flip
23801 * @param obj The flip object
23802 * @return The front content object that was being used
23804 * Unparent and return the front content object which was set for this widget.
23806 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23808 * @brief Unset the back content used for the flip
23810 * @param obj The flip object
23811 * @return The back content object that was being used
23813 * Unparent and return the back content object which was set for this widget.
23815 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23817 * @brief Get flip front visibility state
23819 * @param obj The flip objct
23820 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
23823 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23825 * @brief Set flip perspective
23827 * @param obj The flip object
23828 * @param foc The coordinate to set the focus on
23829 * @param x The X coordinate
23830 * @param y The Y coordinate
23832 * @warning This function currently does nothing.
23834 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
23836 * @brief Runs the flip animation
23838 * @param obj The flip object
23839 * @param mode The mode type
23841 * Flips the front and back contents using the @p mode animation. This
23842 * efectively hides the currently visible content and shows the hidden one.
23844 * There a number of possible animations to use for the flipping:
23845 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
23846 * around a horizontal axis in the middle of its height, the other content
23847 * is shown as the other side of the flip.
23848 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
23849 * around a vertical axis in the middle of its width, the other content is
23850 * shown as the other side of the flip.
23851 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
23852 * around a diagonal axis in the middle of its width, the other content is
23853 * shown as the other side of the flip.
23854 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
23855 * around a diagonal axis in the middle of its height, the other content is
23856 * shown as the other side of the flip.
23857 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
23858 * as if the flip was a cube, the other content is show as the right face of
23860 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
23861 * right as if the flip was a cube, the other content is show as the left
23862 * face of the cube.
23863 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
23864 * flip was a cube, the other content is show as the bottom face of the cube.
23865 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
23866 * the flip was a cube, the other content is show as the upper face of the
23868 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
23869 * if the flip was a book, the other content is shown as the page below that.
23870 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
23871 * as if the flip was a book, the other content is shown as the page below
23873 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
23874 * flip was a book, the other content is shown as the page below that.
23875 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
23876 * flip was a book, the other content is shown as the page below that.
23878 * @image html elm_flip.png
23879 * @image latex elm_flip.eps width=\textwidth
23881 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
23883 * @brief Set the interactive flip mode
23885 * @param obj The flip object
23886 * @param mode The interactive flip mode to use
23888 * This sets if the flip should be interactive (allow user to click and
23889 * drag a side of the flip to reveal the back page and cause it to flip).
23890 * By default a flip is not interactive. You may also need to set which
23891 * sides of the flip are "active" for flipping and how much space they use
23892 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
23893 * and elm_flip_interacton_direction_hitsize_set()
23895 * The four avilable mode of interaction are:
23896 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
23897 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
23898 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
23899 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
23901 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
23902 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
23903 * happen, those can only be acheived with elm_flip_go();
23905 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
23907 * @brief Get the interactive flip mode
23909 * @param obj The flip object
23910 * @return The interactive flip mode
23912 * Returns the interactive flip mode set by elm_flip_interaction_set()
23914 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
23916 * @brief Set which directions of the flip respond to interactive flip
23918 * @param obj The flip object
23919 * @param dir The direction to change
23920 * @param enabled If that direction is enabled or not
23922 * By default all directions are disabled, so you may want to enable the
23923 * desired directions for flipping if you need interactive flipping. You must
23924 * call this function once for each direction that should be enabled.
23926 * @see elm_flip_interaction_set()
23928 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
23930 * @brief Get the enabled state of that flip direction
23932 * @param obj The flip object
23933 * @param dir The direction to check
23934 * @return If that direction is enabled or not
23936 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
23938 * @see elm_flip_interaction_set()
23940 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
23942 * @brief Set the amount of the flip that is sensitive to interactive flip
23944 * @param obj The flip object
23945 * @param dir The direction to modify
23946 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
23948 * Set the amount of the flip that is sensitive to interactive flip, with 0
23949 * representing no area in the flip and 1 representing the entire flip. There
23950 * is however a consideration to be made in that the area will never be
23951 * smaller than the finger size set(as set in your Elementary configuration).
23953 * @see elm_flip_interaction_set()
23955 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
23957 * @brief Get the amount of the flip that is sensitive to interactive flip
23959 * @param obj The flip object
23960 * @param dir The direction to check
23961 * @return The size set for that direction
23963 * Returns the amount os sensitive area set by
23964 * elm_flip_interacton_direction_hitsize_set().
23966 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
23971 /* scrolledentry */
23972 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23973 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
23974 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23975 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
23976 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23977 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
23978 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23979 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
23980 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23981 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23982 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
23983 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
23984 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
23985 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23986 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
23987 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
23988 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
23989 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
23990 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
23991 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
23992 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
23993 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
23994 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
23995 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
23996 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
23997 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
23998 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23999 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24000 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24001 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24002 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24003 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
24004 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
24005 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
24006 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24007 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);
24008 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24009 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24010 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);
24011 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24012 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);
24013 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
24014 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24015 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24016 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24017 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
24018 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24019 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24020 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24021 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);
24022 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);
24023 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);
24024 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);
24025 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);
24026 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);
24027 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
24028 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
24029 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
24030 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
24031 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24032 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
24033 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
24036 * @defgroup Conformant Conformant
24037 * @ingroup Elementary
24039 * @image html img/widget/conformant/preview-00.png
24040 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
24042 * @image html img/conformant.png
24043 * @image latex img/conformant.eps width=\textwidth
24045 * The aim is to provide a widget that can be used in elementary apps to
24046 * account for space taken up by the indicator, virtual keypad & softkey
24047 * windows when running the illume2 module of E17.
24049 * So conformant content will be sized and positioned considering the
24050 * space required for such stuff, and when they popup, as a keyboard
24051 * shows when an entry is selected, conformant content won't change.
24053 * Available styles for it:
24056 * See how to use this widget in this example:
24057 * @ref conformant_example
24061 * @addtogroup Conformant
24066 * Add a new conformant widget to the given parent Elementary
24067 * (container) object.
24069 * @param parent The parent object.
24070 * @return A new conformant widget handle or @c NULL, on errors.
24072 * This function inserts a new conformant widget on the canvas.
24074 * @ingroup Conformant
24076 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24079 * Set the content of the conformant widget.
24081 * @param obj The conformant object.
24082 * @param content The content to be displayed by the conformant.
24084 * Content will be sized and positioned considering the space required
24085 * to display a virtual keyboard. So it won't fill all the conformant
24086 * size. This way is possible to be sure that content won't resize
24087 * or be re-positioned after the keyboard is displayed.
24089 * Once the content object is set, a previously set one will be deleted.
24090 * If you want to keep that old content object, use the
24091 * elm_conformat_content_unset() function.
24093 * @see elm_conformant_content_unset()
24094 * @see elm_conformant_content_get()
24096 * @ingroup Conformant
24098 EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24101 * Get the content of the conformant widget.
24103 * @param obj The conformant object.
24104 * @return The content that is being used.
24106 * Return the content object which is set for this widget.
24107 * It won't be unparent from conformant. For that, use
24108 * elm_conformant_content_unset().
24110 * @see elm_conformant_content_set() for more details.
24111 * @see elm_conformant_content_unset()
24113 * @ingroup Conformant
24115 EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24118 * Unset the content of the conformant widget.
24120 * @param obj The conformant object.
24121 * @return The content that was being used.
24123 * Unparent and return the content object which was set for this widget.
24125 * @see elm_conformant_content_set() for more details.
24127 * @ingroup Conformant
24129 EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24132 * Returns the Evas_Object that represents the content area.
24134 * @param obj The conformant object.
24135 * @return The content area of the widget.
24137 * @ingroup Conformant
24139 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24146 * @defgroup Mapbuf Mapbuf
24147 * @ingroup Elementary
24149 * @image html img/widget/mapbuf/preview-00.png
24150 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
24152 * This holds one content object and uses an Evas Map of transformation
24153 * points to be later used with this content. So the content will be
24154 * moved, resized, etc as a single image. So it will improve performance
24155 * when you have a complex interafce, with a lot of elements, and will
24156 * need to resize or move it frequently (the content object and its
24159 * See how to use this widget in this example:
24160 * @ref mapbuf_example
24164 * @addtogroup Mapbuf
24169 * Add a new mapbuf widget to the given parent Elementary
24170 * (container) object.
24172 * @param parent The parent object.
24173 * @return A new mapbuf widget handle or @c NULL, on errors.
24175 * This function inserts a new mapbuf widget on the canvas.
24179 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24182 * Set the content of the mapbuf.
24184 * @param obj The mapbuf object.
24185 * @param content The content that will be filled in this mapbuf object.
24187 * Once the content object is set, a previously set one will be deleted.
24188 * If you want to keep that old content object, use the
24189 * elm_mapbuf_content_unset() function.
24191 * To enable map, elm_mapbuf_enabled_set() should be used.
24195 EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24198 * Get the content of the mapbuf.
24200 * @param obj The mapbuf object.
24201 * @return The content that is being used.
24203 * Return the content object which is set for this widget.
24205 * @see elm_mapbuf_content_set() for details.
24209 EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24212 * Unset the content of the mapbuf.
24214 * @param obj The mapbuf object.
24215 * @return The content that was being used.
24217 * Unparent and return the content object which was set for this widget.
24219 * @see elm_mapbuf_content_set() for details.
24223 EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24226 * Enable or disable the map.
24228 * @param obj The mapbuf object.
24229 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
24231 * This enables the map that is set or disables it. On enable, the object
24232 * geometry will be saved, and the new geometry will change (position and
24233 * size) to reflect the map geometry set.
24235 * Also, when enabled, alpha and smooth states will be used, so if the
24236 * content isn't solid, alpha should be enabled, for example, otherwise
24237 * a black retangle will fill the content.
24239 * When disabled, the stored map will be freed and geometry prior to
24240 * enabling the map will be restored.
24242 * It's disabled by default.
24244 * @see elm_mapbuf_alpha_set()
24245 * @see elm_mapbuf_smooth_set()
24249 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
24252 * Get a value whether map is enabled or not.
24254 * @param obj The mapbuf object.
24255 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
24256 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24258 * @see elm_mapbuf_enabled_set() for details.
24262 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24265 * Enable or disable smooth map rendering.
24267 * @param obj The mapbuf object.
24268 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
24271 * This sets smoothing for map rendering. If the object is a type that has
24272 * its own smoothing settings, then both the smooth settings for this object
24273 * and the map must be turned off.
24275 * By default smooth maps are enabled.
24279 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
24282 * Get a value whether smooth map rendering is enabled or not.
24284 * @param obj The mapbuf object.
24285 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
24286 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24288 * @see elm_mapbuf_smooth_set() for details.
24292 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24295 * Set or unset alpha flag for map rendering.
24297 * @param obj The mapbuf object.
24298 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
24301 * This sets alpha flag for map rendering. If the object is a type that has
24302 * its own alpha settings, then this will take precedence. Only image objects
24303 * have this currently. It stops alpha blending of the map area, and is
24304 * useful if you know the object and/or all sub-objects is 100% solid.
24306 * Alpha is enabled by default.
24310 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
24313 * Get a value whether alpha blending is enabled or not.
24315 * @param obj The mapbuf object.
24316 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
24317 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24319 * @see elm_mapbuf_alpha_set() for details.
24323 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24330 * @defgroup Flipselector Flip Selector
24332 * @image html img/widget/flipselector/preview-00.png
24333 * @image latex img/widget/flipselector/preview-00.eps
24335 * A flip selector is a widget to show a set of @b text items, one
24336 * at a time, with the same sheet switching style as the @ref Clock
24337 * "clock" widget, when one changes the current displaying sheet
24338 * (thus, the "flip" in the name).
24340 * User clicks to flip sheets which are @b held for some time will
24341 * make the flip selector to flip continuosly and automatically for
24342 * the user. The interval between flips will keep growing in time,
24343 * so that it helps the user to reach an item which is distant from
24344 * the current selection.
24346 * Smart callbacks one can register to:
24347 * - @c "selected" - when the widget's selected text item is changed
24348 * - @c "overflowed" - when the widget's current selection is changed
24349 * from the first item in its list to the last
24350 * - @c "underflowed" - when the widget's current selection is changed
24351 * from the last item in its list to the first
24353 * Available styles for it:
24356 * Here is an example on its usage:
24357 * @li @ref flipselector_example
24361 * @addtogroup Flipselector
24365 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
24368 * Add a new flip selector widget to the given parent Elementary
24369 * (container) widget
24371 * @param parent The parent object
24372 * @return a new flip selector widget handle or @c NULL, on errors
24374 * This function inserts a new flip selector widget on the canvas.
24376 * @ingroup Flipselector
24378 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24381 * Programmatically select the next item of a flip selector widget
24383 * @param obj The flipselector object
24385 * @note The selection will be animated. Also, if it reaches the
24386 * end of its list of member items, it will continue with the first
24389 * @ingroup Flipselector
24391 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24394 * Programmatically select the previous item of a flip selector
24397 * @param obj The flipselector object
24399 * @note The selection will be animated. Also, if it reaches the
24400 * beginning of its list of member items, it will continue with the
24401 * last one backwards.
24403 * @ingroup Flipselector
24405 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24408 * Append a (text) item to a flip selector widget
24410 * @param obj The flipselector object
24411 * @param label The (text) label of the new item
24412 * @param func Convenience callback function to take place when
24414 * @param data Data passed to @p func, above
24415 * @return A handle to the item added or @c NULL, on errors
24417 * The widget's list of labels to show will be appended with the
24418 * given value. If the user wishes so, a callback function pointer
24419 * can be passed, which will get called when this same item is
24422 * @note The current selection @b won't be modified by appending an
24423 * element to the list.
24425 * @note The maximum length of the text label is going to be
24426 * determined <b>by the widget's theme</b>. Strings larger than
24427 * that value are going to be @b truncated.
24429 * @ingroup Flipselector
24431 EAPI Elm_Flipselector_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24434 * Prepend a (text) item to a flip selector widget
24436 * @param obj The flipselector object
24437 * @param label The (text) label of the new item
24438 * @param func Convenience callback function to take place when
24440 * @param data Data passed to @p func, above
24441 * @return A handle to the item added or @c NULL, on errors
24443 * The widget's list of labels to show will be prepended with the
24444 * given value. If the user wishes so, a callback function pointer
24445 * can be passed, which will get called when this same item is
24448 * @note The current selection @b won't be modified by prepending
24449 * an element to the list.
24451 * @note The maximum length of the text label is going to be
24452 * determined <b>by the widget's theme</b>. Strings larger than
24453 * that value are going to be @b truncated.
24455 * @ingroup Flipselector
24457 EAPI Elm_Flipselector_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24460 * Get the internal list of items in a given flip selector widget.
24462 * @param obj The flipselector object
24463 * @return The list of items (#Elm_Flipselector_Item as data) or
24464 * @c NULL on errors.
24466 * This list is @b not to be modified in any way and must not be
24467 * freed. Use the list members with functions like
24468 * elm_flipselector_item_label_set(),
24469 * elm_flipselector_item_label_get(),
24470 * elm_flipselector_item_del(),
24471 * elm_flipselector_item_selected_get(),
24472 * elm_flipselector_item_selected_set().
24474 * @warning This list is only valid until @p obj object's internal
24475 * items list is changed. It should be fetched again with another
24476 * call to this function when changes happen.
24478 * @ingroup Flipselector
24480 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24483 * Get the first item in the given flip selector widget's list of
24486 * @param obj The flipselector object
24487 * @return The first item or @c NULL, if it has no items (and on
24490 * @see elm_flipselector_item_append()
24491 * @see elm_flipselector_last_item_get()
24493 * @ingroup Flipselector
24495 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24498 * Get the last item in the given flip selector widget's list of
24501 * @param obj The flipselector object
24502 * @return The last item or @c NULL, if it has no items (and on
24505 * @see elm_flipselector_item_prepend()
24506 * @see elm_flipselector_first_item_get()
24508 * @ingroup Flipselector
24510 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24513 * Get the currently selected item in a flip selector widget.
24515 * @param obj The flipselector object
24516 * @return The selected item or @c NULL, if the widget has no items
24519 * @ingroup Flipselector
24521 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24524 * Set whether a given flip selector widget's item should be the
24525 * currently selected one.
24527 * @param item The flip selector item
24528 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
24530 * This sets whether @p item is or not the selected (thus, under
24531 * display) one. If @p item is different than one under display,
24532 * the latter will be unselected. If the @p item is set to be
24533 * unselected, on the other hand, the @b first item in the widget's
24534 * internal members list will be the new selected one.
24536 * @see elm_flipselector_item_selected_get()
24538 * @ingroup Flipselector
24540 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
24543 * Get whether a given flip selector widget's item is the currently
24546 * @param item The flip selector item
24547 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
24550 * @see elm_flipselector_item_selected_set()
24552 * @ingroup Flipselector
24554 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24557 * Delete a given item from a flip selector widget.
24559 * @param item The item to delete
24561 * @ingroup Flipselector
24563 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24566 * Get the label of a given flip selector widget's item.
24568 * @param item The item to get label from
24569 * @return The text label of @p item or @c NULL, on errors
24571 * @see elm_flipselector_item_label_set()
24573 * @ingroup Flipselector
24575 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24578 * Set the label of a given flip selector widget's item.
24580 * @param item The item to set label on
24581 * @param label The text label string, in UTF-8 encoding
24583 * @see elm_flipselector_item_label_get()
24585 * @ingroup Flipselector
24587 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
24590 * Gets the item before @p item in a flip selector widget's
24591 * internal list of items.
24593 * @param item The item to fetch previous from
24594 * @return The item before the @p item, in its parent's list. If
24595 * there is no previous item for @p item or there's an
24596 * error, @c NULL is returned.
24598 * @see elm_flipselector_item_next_get()
24600 * @ingroup Flipselector
24602 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24605 * Gets the item after @p item in a flip selector widget's
24606 * internal list of items.
24608 * @param item The item to fetch next from
24609 * @return The item after the @p item, in its parent's list. If
24610 * there is no next item for @p item or there's an
24611 * error, @c NULL is returned.
24613 * @see elm_flipselector_item_next_get()
24615 * @ingroup Flipselector
24617 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24620 * Set the interval on time updates for an user mouse button hold
24621 * on a flip selector widget.
24623 * @param obj The flip selector object
24624 * @param interval The (first) interval value in seconds
24626 * This interval value is @b decreased while the user holds the
24627 * mouse pointer either flipping up or flipping doww a given flip
24630 * This helps the user to get to a given item distant from the
24631 * current one easier/faster, as it will start to flip quicker and
24632 * quicker on mouse button holds.
24634 * The calculation for the next flip interval value, starting from
24635 * the one set with this call, is the previous interval divided by
24636 * 1.05, so it decreases a little bit.
24638 * The default starting interval value for automatic flips is
24641 * @see elm_flipselector_interval_get()
24643 * @ingroup Flipselector
24645 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
24648 * Get the interval on time updates for an user mouse button hold
24649 * on a flip selector widget.
24651 * @param obj The flip selector object
24652 * @return The (first) interval value, in seconds, set on it
24654 * @see elm_flipselector_interval_set() for more details
24656 * @ingroup Flipselector
24658 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24664 * @addtogroup Calendar
24669 * @enum _Elm_Calendar_Mark_Repeat
24670 * @typedef Elm_Calendar_Mark_Repeat
24672 * Event periodicity, used to define if a mark should be repeated
24673 * @b beyond event's day. It's set when a mark is added.
24675 * So, for a mark added to 13th May with periodicity set to WEEKLY,
24676 * there will be marks every week after this date. Marks will be displayed
24677 * at 13th, 20th, 27th, 3rd June ...
24679 * Values don't work as bitmask, only one can be choosen.
24681 * @see elm_calendar_mark_add()
24683 * @ingroup Calendar
24685 typedef enum _Elm_Calendar_Mark_Repeat
24687 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
24688 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
24689 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
24690 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*/
24691 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. */
24692 } Elm_Calendar_Mark_Repeat;
24694 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(). */
24697 * Add a new calendar widget to the given parent Elementary
24698 * (container) object.
24700 * @param parent The parent object.
24701 * @return a new calendar widget handle or @c NULL, on errors.
24703 * This function inserts a new calendar widget on the canvas.
24705 * @ref calendar_example_01
24707 * @ingroup Calendar
24709 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24712 * Get weekdays names displayed by the calendar.
24714 * @param obj The calendar object.
24715 * @return Array of seven strings to be used as weekday names.
24717 * By default, weekdays abbreviations get from system are displayed:
24718 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
24719 * The first string is related to Sunday, the second to Monday...
24721 * @see elm_calendar_weekdays_name_set()
24723 * @ref calendar_example_05
24725 * @ingroup Calendar
24727 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24730 * Set weekdays names to be displayed by the calendar.
24732 * @param obj The calendar object.
24733 * @param weekdays Array of seven strings to be used as weekday names.
24734 * @warning It must have 7 elements, or it will access invalid memory.
24735 * @warning The strings must be NULL terminated ('@\0').
24737 * By default, weekdays abbreviations get from system are displayed:
24738 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
24740 * The first string should be related to Sunday, the second to Monday...
24742 * The usage should be like this:
24744 * const char *weekdays[] =
24746 * "Sunday", "Monday", "Tuesday", "Wednesday",
24747 * "Thursday", "Friday", "Saturday"
24749 * elm_calendar_weekdays_names_set(calendar, weekdays);
24752 * @see elm_calendar_weekdays_name_get()
24754 * @ref calendar_example_02
24756 * @ingroup Calendar
24758 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
24761 * Set the minimum and maximum values for the year
24763 * @param obj The calendar object
24764 * @param min The minimum year, greater than 1901;
24765 * @param max The maximum year;
24767 * Maximum must be greater than minimum, except if you don't wan't to set
24769 * Default values are 1902 and -1.
24771 * If the maximum year is a negative value, it will be limited depending
24772 * on the platform architecture (year 2037 for 32 bits);
24774 * @see elm_calendar_min_max_year_get()
24776 * @ref calendar_example_03
24778 * @ingroup Calendar
24780 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
24783 * Get the minimum and maximum values for the year
24785 * @param obj The calendar object.
24786 * @param min The minimum year.
24787 * @param max The maximum year.
24789 * Default values are 1902 and -1.
24791 * @see elm_calendar_min_max_year_get() for more details.
24793 * @ref calendar_example_05
24795 * @ingroup Calendar
24797 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
24800 * Enable or disable day selection
24802 * @param obj The calendar object.
24803 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
24806 * Enabled by default. If disabled, the user still can select months,
24807 * but not days. Selected days are highlighted on calendar.
24808 * It should be used if you won't need such selection for the widget usage.
24810 * When a day is selected, or month is changed, smart callbacks for
24811 * signal "changed" will be called.
24813 * @see elm_calendar_day_selection_enable_get()
24815 * @ref calendar_example_04
24817 * @ingroup Calendar
24819 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
24822 * Get a value whether day selection is enabled or not.
24824 * @see elm_calendar_day_selection_enable_set() for details.
24826 * @param obj The calendar object.
24827 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
24828 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
24830 * @ref calendar_example_05
24832 * @ingroup Calendar
24834 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24838 * Set selected date to be highlighted on calendar.
24840 * @param obj The calendar object.
24841 * @param selected_time A @b tm struct to represent the selected date.
24843 * Set the selected date, changing the displayed month if needed.
24844 * Selected date changes when the user goes to next/previous month or
24845 * select a day pressing over it on calendar.
24847 * @see elm_calendar_selected_time_get()
24849 * @ref calendar_example_04
24851 * @ingroup Calendar
24853 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
24856 * Get selected date.
24858 * @param obj The calendar object
24859 * @param selected_time A @b tm struct to point to selected date
24860 * @return EINA_FALSE means an error ocurred and returned time shouldn't
24863 * Get date selected by the user or set by function
24864 * elm_calendar_selected_time_set().
24865 * Selected date changes when the user goes to next/previous month or
24866 * select a day pressing over it on calendar.
24868 * @see elm_calendar_selected_time_get()
24870 * @ref calendar_example_05
24872 * @ingroup Calendar
24874 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
24877 * Set a function to format the string that will be used to display
24880 * @param obj The calendar object
24881 * @param format_function Function to set the month-year string given
24882 * the selected date
24884 * By default it uses strftime with "%B %Y" format string.
24885 * It should allocate the memory that will be used by the string,
24886 * that will be freed by the widget after usage.
24887 * A pointer to the string and a pointer to the time struct will be provided.
24892 * _format_month_year(struct tm *selected_time)
24895 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
24896 * return strdup(buf);
24899 * elm_calendar_format_function_set(calendar, _format_month_year);
24902 * @ref calendar_example_02
24904 * @ingroup Calendar
24906 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
24909 * Add a new mark to the calendar
24911 * @param obj The calendar object
24912 * @param mark_type A string used to define the type of mark. It will be
24913 * emitted to the theme, that should display a related modification on these
24914 * days representation.
24915 * @param mark_time A time struct to represent the date of inclusion of the
24916 * mark. For marks that repeats it will just be displayed after the inclusion
24917 * date in the calendar.
24918 * @param repeat Repeat the event following this periodicity. Can be a unique
24919 * mark (that don't repeat), daily, weekly, monthly or annually.
24920 * @return The created mark or @p NULL upon failure.
24922 * Add a mark that will be drawn in the calendar respecting the insertion
24923 * time and periodicity. It will emit the type as signal to the widget theme.
24924 * Default theme supports "holiday" and "checked", but it can be extended.
24926 * It won't immediately update the calendar, drawing the marks.
24927 * For this, call elm_calendar_marks_draw(). However, when user selects
24928 * next or previous month calendar forces marks drawn.
24930 * Marks created with this method can be deleted with
24931 * elm_calendar_mark_del().
24935 * struct tm selected_time;
24936 * time_t current_time;
24938 * current_time = time(NULL) + 5 * 84600;
24939 * localtime_r(¤t_time, &selected_time);
24940 * elm_calendar_mark_add(cal, "holiday", selected_time,
24941 * ELM_CALENDAR_ANNUALLY);
24943 * current_time = time(NULL) + 1 * 84600;
24944 * localtime_r(¤t_time, &selected_time);
24945 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
24947 * elm_calendar_marks_draw(cal);
24950 * @see elm_calendar_marks_draw()
24951 * @see elm_calendar_mark_del()
24953 * @ref calendar_example_06
24955 * @ingroup Calendar
24957 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);
24960 * Delete mark from the calendar.
24962 * @param mark The mark to be deleted.
24964 * If deleting all calendar marks is required, elm_calendar_marks_clear()
24965 * should be used instead of getting marks list and deleting each one.
24967 * @see elm_calendar_mark_add()
24969 * @ref calendar_example_06
24971 * @ingroup Calendar
24973 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
24976 * Remove all calendar's marks
24978 * @param obj The calendar object.
24980 * @see elm_calendar_mark_add()
24981 * @see elm_calendar_mark_del()
24983 * @ingroup Calendar
24985 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24989 * Get a list of all the calendar marks.
24991 * @param obj The calendar object.
24992 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
24994 * @see elm_calendar_mark_add()
24995 * @see elm_calendar_mark_del()
24996 * @see elm_calendar_marks_clear()
24998 * @ingroup Calendar
25000 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25003 * Draw calendar marks.
25005 * @param obj The calendar object.
25007 * Should be used after adding, removing or clearing marks.
25008 * It will go through the entire marks list updating the calendar.
25009 * If lots of marks will be added, add all the marks and then call
25012 * When the month is changed, i.e. user selects next or previous month,
25013 * marks will be drawed.
25015 * @see elm_calendar_mark_add()
25016 * @see elm_calendar_mark_del()
25017 * @see elm_calendar_marks_clear()
25019 * @ref calendar_example_06
25021 * @ingroup Calendar
25023 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
25026 * Set a day text color to the same that represents Saturdays.
25028 * @param obj The calendar object.
25029 * @param pos The text position. Position is the cell counter, from left
25030 * to right, up to down. It starts on 0 and ends on 41.
25032 * @deprecated use elm_calendar_mark_add() instead like:
25035 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
25036 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25039 * @see elm_calendar_mark_add()
25041 * @ingroup Calendar
25043 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25046 * Set a day text color to the same that represents Sundays.
25048 * @param obj The calendar object.
25049 * @param pos The text position. Position is the cell counter, from left
25050 * to right, up to down. It starts on 0 and ends on 41.
25052 * @deprecated use elm_calendar_mark_add() instead like:
25055 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
25056 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25059 * @see elm_calendar_mark_add()
25061 * @ingroup Calendar
25063 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25066 * Set a day text color to the same that represents Weekdays.
25068 * @param obj The calendar object
25069 * @param pos The text position. Position is the cell counter, from left
25070 * to right, up to down. It starts on 0 and ends on 41.
25072 * @deprecated use elm_calendar_mark_add() instead like:
25075 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
25077 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
25078 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25079 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
25080 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25081 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
25082 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25083 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
25084 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25085 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
25088 * @see elm_calendar_mark_add()
25090 * @ingroup Calendar
25092 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25095 * Set the interval on time updates for an user mouse button hold
25096 * on calendar widgets' month selection.
25098 * @param obj The calendar object
25099 * @param interval The (first) interval value in seconds
25101 * This interval value is @b decreased while the user holds the
25102 * mouse pointer either selecting next or previous month.
25104 * This helps the user to get to a given month distant from the
25105 * current one easier/faster, as it will start to change quicker and
25106 * quicker on mouse button holds.
25108 * The calculation for the next change interval value, starting from
25109 * the one set with this call, is the previous interval divided by
25110 * 1.05, so it decreases a little bit.
25112 * The default starting interval value for automatic changes is
25115 * @see elm_calendar_interval_get()
25117 * @ingroup Calendar
25119 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25122 * Get the interval on time updates for an user mouse button hold
25123 * on calendar widgets' month selection.
25125 * @param obj The calendar object
25126 * @return The (first) interval value, in seconds, set on it
25128 * @see elm_calendar_interval_set() for more details
25130 * @ingroup Calendar
25132 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25139 * @defgroup Diskselector Diskselector
25140 * @ingroup Elementary
25142 * @image html img/widget/diskselector/preview-00.png
25143 * @image latex img/widget/diskselector/preview-00.eps
25145 * A diskselector is a kind of list widget. It scrolls horizontally,
25146 * and can contain label and icon objects. Three items are displayed
25147 * with the selected one in the middle.
25149 * It can act like a circular list with round mode and labels can be
25150 * reduced for a defined length for side items.
25152 * Smart callbacks one can listen to:
25153 * - "selected" - when item is selected, i.e. scroller stops.
25155 * Available styles for it:
25158 * List of examples:
25159 * @li @ref diskselector_example_01
25160 * @li @ref diskselector_example_02
25164 * @addtogroup Diskselector
25168 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(). */
25171 * Add a new diskselector widget to the given parent Elementary
25172 * (container) object.
25174 * @param parent The parent object.
25175 * @return a new diskselector widget handle or @c NULL, on errors.
25177 * This function inserts a new diskselector widget on the canvas.
25179 * @ingroup Diskselector
25181 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25184 * Enable or disable round mode.
25186 * @param obj The diskselector object.
25187 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
25190 * Disabled by default. If round mode is enabled the items list will
25191 * work like a circle list, so when the user reaches the last item,
25192 * the first one will popup.
25194 * @see elm_diskselector_round_get()
25196 * @ingroup Diskselector
25198 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
25201 * Get a value whether round mode is enabled or not.
25203 * @see elm_diskselector_round_set() for details.
25205 * @param obj The diskselector object.
25206 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
25207 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25209 * @ingroup Diskselector
25211 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25214 * Get the side labels max length.
25216 * @deprecated use elm_diskselector_side_label_length_get() instead:
25218 * @param obj The diskselector object.
25219 * @return The max length defined for side labels, or 0 if not a valid
25222 * @ingroup Diskselector
25224 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25227 * Set the side labels max length.
25229 * @deprecated use elm_diskselector_side_label_length_set() instead:
25231 * @param obj The diskselector object.
25232 * @param len The max length defined for side labels.
25234 * @ingroup Diskselector
25236 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25239 * Get the side labels max length.
25241 * @see elm_diskselector_side_label_length_set() for details.
25243 * @param obj The diskselector object.
25244 * @return The max length defined for side labels, or 0 if not a valid
25247 * @ingroup Diskselector
25249 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25252 * Set the side labels max length.
25254 * @param obj The diskselector object.
25255 * @param len The max length defined for side labels.
25257 * Length is the number of characters of items' label that will be
25258 * visible when it's set on side positions. It will just crop
25259 * the string after defined size. E.g.:
25261 * An item with label "January" would be displayed on side position as
25262 * "Jan" if max length is set to 3, or "Janu", if this property
25265 * When it's selected, the entire label will be displayed, except for
25266 * width restrictions. In this case label will be cropped and "..."
25267 * will be concatenated.
25269 * Default side label max length is 3.
25271 * This property will be applyed over all items, included before or
25272 * later this function call.
25274 * @ingroup Diskselector
25276 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25279 * Set the number of items to be displayed.
25281 * @param obj The diskselector object.
25282 * @param num The number of items the diskselector will display.
25284 * Default value is 3, and also it's the minimun. If @p num is less
25285 * than 3, it will be set to 3.
25287 * Also, it can be set on theme, using data item @c display_item_num
25288 * on group "elm/diskselector/item/X", where X is style set.
25291 * group { name: "elm/diskselector/item/X";
25293 * item: "display_item_num" "5";
25296 * @ingroup Diskselector
25298 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
25301 * Get the number of items in the diskselector object.
25303 * @param obj The diskselector object.
25305 * @ingroup Diskselector
25307 EAPI int elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25310 * Set bouncing behaviour when the scrolled content reaches an edge.
25312 * Tell the internal scroller object whether it should bounce or not
25313 * when it reaches the respective edges for each axis.
25315 * @param obj The diskselector object.
25316 * @param h_bounce Whether to bounce or not in the horizontal axis.
25317 * @param v_bounce Whether to bounce or not in the vertical axis.
25319 * @see elm_scroller_bounce_set()
25321 * @ingroup Diskselector
25323 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
25326 * Get the bouncing behaviour of the internal scroller.
25328 * Get whether the internal scroller should bounce when the edge of each
25329 * axis is reached scrolling.
25331 * @param obj The diskselector object.
25332 * @param h_bounce Pointer where to store the bounce state of the horizontal
25334 * @param v_bounce Pointer where to store the bounce state of the vertical
25337 * @see elm_scroller_bounce_get()
25338 * @see elm_diskselector_bounce_set()
25340 * @ingroup Diskselector
25342 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
25345 * Get the scrollbar policy.
25347 * @see elm_diskselector_scroller_policy_get() for details.
25349 * @param obj The diskselector object.
25350 * @param policy_h Pointer where to store horizontal scrollbar policy.
25351 * @param policy_v Pointer where to store vertical scrollbar policy.
25353 * @ingroup Diskselector
25355 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);
25358 * Set the scrollbar policy.
25360 * @param obj The diskselector object.
25361 * @param policy_h Horizontal scrollbar policy.
25362 * @param policy_v Vertical scrollbar policy.
25364 * This sets the scrollbar visibility policy for the given scroller.
25365 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
25366 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
25367 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
25368 * This applies respectively for the horizontal and vertical scrollbars.
25370 * The both are disabled by default, i.e., are set to
25371 * #ELM_SCROLLER_POLICY_OFF.
25373 * @ingroup Diskselector
25375 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
25378 * Remove all diskselector's items.
25380 * @param obj The diskselector object.
25382 * @see elm_diskselector_item_del()
25383 * @see elm_diskselector_item_append()
25385 * @ingroup Diskselector
25387 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25390 * Get a list of all the diskselector items.
25392 * @param obj The diskselector object.
25393 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
25394 * or @c NULL on failure.
25396 * @see elm_diskselector_item_append()
25397 * @see elm_diskselector_item_del()
25398 * @see elm_diskselector_clear()
25400 * @ingroup Diskselector
25402 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25405 * Appends a new item to the diskselector object.
25407 * @param obj The diskselector object.
25408 * @param label The label of the diskselector item.
25409 * @param icon The icon object to use at left side of the item. An
25410 * icon can be any Evas object, but usually it is an icon created
25411 * with elm_icon_add().
25412 * @param func The function to call when the item is selected.
25413 * @param data The data to associate with the item for related callbacks.
25415 * @return The created item or @c NULL upon failure.
25417 * A new item will be created and appended to the diskselector, i.e., will
25418 * be set as last item. Also, if there is no selected item, it will
25419 * be selected. This will always happens for the first appended item.
25421 * If no icon is set, label will be centered on item position, otherwise
25422 * the icon will be placed at left of the label, that will be shifted
25425 * Items created with this method can be deleted with
25426 * elm_diskselector_item_del().
25428 * Associated @p data can be properly freed when item is deleted if a
25429 * callback function is set with elm_diskselector_item_del_cb_set().
25431 * If a function is passed as argument, it will be called everytime this item
25432 * is selected, i.e., the user stops the diskselector with this
25433 * item on center position. If such function isn't needed, just passing
25434 * @c NULL as @p func is enough. The same should be done for @p data.
25436 * Simple example (with no function callback or data associated):
25438 * disk = elm_diskselector_add(win);
25439 * ic = elm_icon_add(win);
25440 * elm_icon_file_set(ic, "path/to/image", NULL);
25441 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
25442 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
25445 * @see elm_diskselector_item_del()
25446 * @see elm_diskselector_item_del_cb_set()
25447 * @see elm_diskselector_clear()
25448 * @see elm_icon_add()
25450 * @ingroup Diskselector
25452 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);
25456 * Delete them item from the diskselector.
25458 * @param it The item of diskselector to be deleted.
25460 * If deleting all diskselector items is required, elm_diskselector_clear()
25461 * should be used instead of getting items list and deleting each one.
25463 * @see elm_diskselector_clear()
25464 * @see elm_diskselector_item_append()
25465 * @see elm_diskselector_item_del_cb_set()
25467 * @ingroup Diskselector
25469 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25472 * Set the function called when a diskselector item is freed.
25474 * @param it The item to set the callback on
25475 * @param func The function called
25477 * If there is a @p func, then it will be called prior item's memory release.
25478 * That will be called with the following arguments:
25480 * @li item's Evas object;
25483 * This way, a data associated to a diskselector item could be properly
25486 * @ingroup Diskselector
25488 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
25491 * Get the data associated to the item.
25493 * @param it The diskselector item
25494 * @return The data associated to @p it
25496 * The return value is a pointer to data associated to @p item when it was
25497 * created, with function elm_diskselector_item_append(). If no data
25498 * was passed as argument, it will return @c NULL.
25500 * @see elm_diskselector_item_append()
25502 * @ingroup Diskselector
25504 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25507 * Set the icon associated to the item.
25509 * @param it The diskselector item
25510 * @param icon The icon object to associate with @p it
25512 * The icon object to use at left side of the item. An
25513 * icon can be any Evas object, but usually it is an icon created
25514 * with elm_icon_add().
25516 * Once the icon object is set, a previously set one will be deleted.
25517 * @warning Setting the same icon for two items will cause the icon to
25518 * dissapear from the first item.
25520 * If an icon was passed as argument on item creation, with function
25521 * elm_diskselector_item_append(), it will be already
25522 * associated to the item.
25524 * @see elm_diskselector_item_append()
25525 * @see elm_diskselector_item_icon_get()
25527 * @ingroup Diskselector
25529 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
25532 * Get the icon associated to the item.
25534 * @param it The diskselector item
25535 * @return The icon associated to @p it
25537 * The return value is a pointer to the icon associated to @p item when it was
25538 * created, with function elm_diskselector_item_append(), or later
25539 * with function elm_diskselector_item_icon_set. If no icon
25540 * was passed as argument, it will return @c NULL.
25542 * @see elm_diskselector_item_append()
25543 * @see elm_diskselector_item_icon_set()
25545 * @ingroup Diskselector
25547 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25550 * Set the label of item.
25552 * @param it The item of diskselector.
25553 * @param label The label of item.
25555 * The label to be displayed by the item.
25557 * If no icon is set, label will be centered on item position, otherwise
25558 * the icon will be placed at left of the label, that will be shifted
25561 * An item with label "January" would be displayed on side position as
25562 * "Jan" if max length is set to 3 with function
25563 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
25566 * When this @p item is selected, the entire label will be displayed,
25567 * except for width restrictions.
25568 * In this case label will be cropped and "..." will be concatenated,
25569 * but only for display purposes. It will keep the entire string, so
25570 * if diskselector is resized the remaining characters will be displayed.
25572 * If a label was passed as argument on item creation, with function
25573 * elm_diskselector_item_append(), it will be already
25574 * displayed by the item.
25576 * @see elm_diskselector_side_label_lenght_set()
25577 * @see elm_diskselector_item_label_get()
25578 * @see elm_diskselector_item_append()
25580 * @ingroup Diskselector
25582 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
25585 * Get the label of item.
25587 * @param it The item of diskselector.
25588 * @return The label of item.
25590 * The return value is a pointer to the label associated to @p item when it was
25591 * created, with function elm_diskselector_item_append(), or later
25592 * with function elm_diskselector_item_label_set. If no label
25593 * was passed as argument, it will return @c NULL.
25595 * @see elm_diskselector_item_label_set() for more details.
25596 * @see elm_diskselector_item_append()
25598 * @ingroup Diskselector
25600 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25603 * Get the selected item.
25605 * @param obj The diskselector object.
25606 * @return The selected diskselector item.
25608 * The selected item can be unselected with function
25609 * elm_diskselector_item_selected_set(), and the first item of
25610 * diskselector will be selected.
25612 * The selected item always will be centered on diskselector, with
25613 * full label displayed, i.e., max lenght set to side labels won't
25614 * apply on the selected item. More details on
25615 * elm_diskselector_side_label_length_set().
25617 * @ingroup Diskselector
25619 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25622 * Set the selected state of an item.
25624 * @param it The diskselector item
25625 * @param selected The selected state
25627 * This sets the selected state of the given item @p it.
25628 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
25630 * If a new item is selected the previosly selected will be unselected.
25631 * Previoulsy selected item can be get with function
25632 * elm_diskselector_selected_item_get().
25634 * If the item @p it is unselected, the first item of diskselector will
25637 * Selected items will be visible on center position of diskselector.
25638 * So if it was on another position before selected, or was invisible,
25639 * diskselector will animate items until the selected item reaches center
25642 * @see elm_diskselector_item_selected_get()
25643 * @see elm_diskselector_selected_item_get()
25645 * @ingroup Diskselector
25647 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
25650 * Get whether the @p item is selected or not.
25652 * @param it The diskselector item.
25653 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
25654 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
25656 * @see elm_diskselector_selected_item_set() for details.
25657 * @see elm_diskselector_item_selected_get()
25659 * @ingroup Diskselector
25661 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25664 * Get the first item of the diskselector.
25666 * @param obj The diskselector object.
25667 * @return The first item, or @c NULL if none.
25669 * The list of items follows append order. So it will return the first
25670 * item appended to the widget that wasn't deleted.
25672 * @see elm_diskselector_item_append()
25673 * @see elm_diskselector_items_get()
25675 * @ingroup Diskselector
25677 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25680 * Get the last item of the diskselector.
25682 * @param obj The diskselector object.
25683 * @return The last item, or @c NULL if none.
25685 * The list of items follows append order. So it will return last first
25686 * item appended to the widget that wasn't deleted.
25688 * @see elm_diskselector_item_append()
25689 * @see elm_diskselector_items_get()
25691 * @ingroup Diskselector
25693 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25696 * Get the item before @p item in diskselector.
25698 * @param it The diskselector item.
25699 * @return The item before @p item, or @c NULL if none or on failure.
25701 * The list of items follows append order. So it will return item appended
25702 * just before @p item and that wasn't deleted.
25704 * If it is the first item, @c NULL will be returned.
25705 * First item can be get by elm_diskselector_first_item_get().
25707 * @see elm_diskselector_item_append()
25708 * @see elm_diskselector_items_get()
25710 * @ingroup Diskselector
25712 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25715 * Get the item after @p item in diskselector.
25717 * @param it The diskselector item.
25718 * @return The item after @p item, or @c NULL if none or on failure.
25720 * The list of items follows append order. So it will return item appended
25721 * just after @p item and that wasn't deleted.
25723 * If it is the last item, @c NULL will be returned.
25724 * Last item can be get by elm_diskselector_last_item_get().
25726 * @see elm_diskselector_item_append()
25727 * @see elm_diskselector_items_get()
25729 * @ingroup Diskselector
25731 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25734 * Set the text to be shown in the diskselector item.
25736 * @param item Target item
25737 * @param text The text to set in the content
25739 * Setup the text as tooltip to object. The item can have only one tooltip,
25740 * so any previous tooltip data is removed.
25742 * @see elm_object_tooltip_text_set() for more details.
25744 * @ingroup Diskselector
25746 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
25749 * Set the content to be shown in the tooltip item.
25751 * Setup the tooltip to item. The item can have only one tooltip,
25752 * so any previous tooltip data is removed. @p func(with @p data) will
25753 * be called every time that need show the tooltip and it should
25754 * return a valid Evas_Object. This object is then managed fully by
25755 * tooltip system and is deleted when the tooltip is gone.
25757 * @param item the diskselector item being attached a tooltip.
25758 * @param func the function used to create the tooltip contents.
25759 * @param data what to provide to @a func as callback data/context.
25760 * @param del_cb called when data is not needed anymore, either when
25761 * another callback replaces @p func, the tooltip is unset with
25762 * elm_diskselector_item_tooltip_unset() or the owner @a item
25763 * dies. This callback receives as the first parameter the
25764 * given @a data, and @c event_info is the item.
25766 * @see elm_object_tooltip_content_cb_set() for more details.
25768 * @ingroup Diskselector
25770 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);
25773 * Unset tooltip from item.
25775 * @param item diskselector item to remove previously set tooltip.
25777 * Remove tooltip from item. The callback provided as del_cb to
25778 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
25779 * it is not used anymore.
25781 * @see elm_object_tooltip_unset() for more details.
25782 * @see elm_diskselector_item_tooltip_content_cb_set()
25784 * @ingroup Diskselector
25786 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25790 * Sets a different style for this item tooltip.
25792 * @note before you set a style you should define a tooltip with
25793 * elm_diskselector_item_tooltip_content_cb_set() or
25794 * elm_diskselector_item_tooltip_text_set()
25796 * @param item diskselector item with tooltip already set.
25797 * @param style the theme style to use (default, transparent, ...)
25799 * @see elm_object_tooltip_style_set() for more details.
25801 * @ingroup Diskselector
25803 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
25806 * Get the style for this item tooltip.
25808 * @param item diskselector item with tooltip already set.
25809 * @return style the theme style in use, defaults to "default". If the
25810 * object does not have a tooltip set, then NULL is returned.
25812 * @see elm_object_tooltip_style_get() for more details.
25813 * @see elm_diskselector_item_tooltip_style_set()
25815 * @ingroup Diskselector
25817 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25820 * Set the cursor to be shown when mouse is over the diskselector item
25822 * @param item Target item
25823 * @param cursor the cursor name to be used.
25825 * @see elm_object_cursor_set() for more details.
25827 * @ingroup Diskselector
25829 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
25832 * Get the cursor to be shown when mouse is over the diskselector item
25834 * @param item diskselector item with cursor already set.
25835 * @return the cursor name.
25837 * @see elm_object_cursor_get() for more details.
25838 * @see elm_diskselector_cursor_set()
25840 * @ingroup Diskselector
25842 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25846 * Unset the cursor to be shown when mouse is over the diskselector item
25848 * @param item Target item
25850 * @see elm_object_cursor_unset() for more details.
25851 * @see elm_diskselector_cursor_set()
25853 * @ingroup Diskselector
25855 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25858 * Sets a different style for this item cursor.
25860 * @note before you set a style you should define a cursor with
25861 * elm_diskselector_item_cursor_set()
25863 * @param item diskselector item with cursor already set.
25864 * @param style the theme style to use (default, transparent, ...)
25866 * @see elm_object_cursor_style_set() for more details.
25868 * @ingroup Diskselector
25870 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
25874 * Get the style for this item cursor.
25876 * @param item diskselector item with cursor already set.
25877 * @return style the theme style in use, defaults to "default". If the
25878 * object does not have a cursor set, then @c NULL is returned.
25880 * @see elm_object_cursor_style_get() for more details.
25881 * @see elm_diskselector_item_cursor_style_set()
25883 * @ingroup Diskselector
25885 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25889 * Set if the cursor set should be searched on the theme or should use
25890 * the provided by the engine, only.
25892 * @note before you set if should look on theme you should define a cursor
25893 * with elm_diskselector_item_cursor_set().
25894 * By default it will only look for cursors provided by the engine.
25896 * @param item widget item with cursor already set.
25897 * @param engine_only boolean to define if cursors set with
25898 * elm_diskselector_item_cursor_set() should be searched only
25899 * between cursors provided by the engine or searched on widget's
25902 * @see elm_object_cursor_engine_only_set() for more details.
25904 * @ingroup Diskselector
25906 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
25909 * Get the cursor engine only usage for this item cursor.
25911 * @param item widget item with cursor already set.
25912 * @return engine_only boolean to define it cursors should be looked only
25913 * between the provided by the engine or searched on widget's theme as well.
25914 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
25916 * @see elm_object_cursor_engine_only_get() for more details.
25917 * @see elm_diskselector_item_cursor_engine_only_set()
25919 * @ingroup Diskselector
25921 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25928 * @defgroup Colorselector Colorselector
25932 * @image html img/widget/colorselector/preview-00.png
25933 * @image latex img/widget/colorselector/preview-00.eps
25935 * @brief Widget for user to select a color.
25937 * Signals that you can add callbacks for are:
25938 * "changed" - When the color value changes(event_info is NULL).
25940 * See @ref tutorial_colorselector.
25943 * @brief Add a new colorselector to the parent
25945 * @param parent The parent object
25946 * @return The new object or NULL if it cannot be created
25948 * @ingroup Colorselector
25950 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25952 * Set a color for the colorselector
25954 * @param obj Colorselector object
25955 * @param r r-value of color
25956 * @param g g-value of color
25957 * @param b b-value of color
25958 * @param a a-value of color
25960 * @ingroup Colorselector
25962 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
25964 * Get a color from the colorselector
25966 * @param obj Colorselector object
25967 * @param r integer pointer for r-value of color
25968 * @param g integer pointer for g-value of color
25969 * @param b integer pointer for b-value of color
25970 * @param a integer pointer for a-value of color
25972 * @ingroup Colorselector
25974 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
25980 * @defgroup Ctxpopup Ctxpopup
25982 * @image html img/widget/ctxpopup/preview-00.png
25983 * @image latex img/widget/ctxpopup/preview-00.eps
25985 * @brief Context popup widet.
25987 * A ctxpopup is a widget that, when shown, pops up a list of items.
25988 * It automatically chooses an area inside its parent object's view
25989 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
25990 * optimally fit into it. In the default theme, it will also point an
25991 * arrow to it's top left position at the time one shows it. Ctxpopup
25992 * items have a label and/or an icon. It is intended for a small
25993 * number of items (hence the use of list, not genlist).
25995 * @note Ctxpopup is a especialization of @ref Hover.
25997 * Signals that you can add callbacks for are:
25998 * "dismissed" - the ctxpopup was dismissed
26000 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
26003 typedef enum _Elm_Ctxpopup_Direction
26005 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
26007 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
26008 the clicked area */
26009 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
26010 the clicked area */
26011 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
26013 ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
26014 } Elm_Ctxpopup_Direction;
26017 * @brief Add a new Ctxpopup object to the parent.
26019 * @param parent Parent object
26020 * @return New object or @c NULL, if it cannot be created
26022 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26024 * @brief Set the Ctxpopup's parent
26026 * @param obj The ctxpopup object
26027 * @param area The parent to use
26029 * Set the parent object.
26031 * @note elm_ctxpopup_add() will automatically call this function
26032 * with its @c parent argument.
26034 * @see elm_ctxpopup_add()
26035 * @see elm_hover_parent_set()
26037 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
26039 * @brief Get the Ctxpopup's parent
26041 * @param obj The ctxpopup object
26043 * @see elm_ctxpopup_hover_parent_set() for more information
26045 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26047 * @brief Clear all items in the given ctxpopup object.
26049 * @param obj Ctxpopup object
26051 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26053 * @brief Change the ctxpopup's orientation to horizontal or vertical.
26055 * @param obj Ctxpopup object
26056 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
26058 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
26060 * @brief Get the value of current ctxpopup object's orientation.
26062 * @param obj Ctxpopup object
26063 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
26065 * @see elm_ctxpopup_horizontal_set()
26067 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26069 * @brief Add a new item to a ctxpopup object.
26071 * @param obj Ctxpopup object
26072 * @param icon Icon to be set on new item
26073 * @param label The Label of the new item
26074 * @param func Convenience function called when item selected
26075 * @param data Data passed to @p func
26076 * @return A handle to the item added or @c NULL, on errors
26078 * @warning Ctxpopup can't hold both an item list and a content at the same
26079 * time. When an item is added, any previous content will be removed.
26081 * @see elm_ctxpopup_content_set()
26083 Elm_Object_Item *elm_ctxpopup_item_append(Evas_Object *obj, const char *label, Evas_Object *icon, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
26085 * @brief Delete the given item in a ctxpopup object.
26087 * @param it Ctxpopup item to be deleted
26089 * @see elm_ctxpopup_item_append()
26091 EAPI void elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26093 * @brief Set the ctxpopup item's state as disabled or enabled.
26095 * @param it Ctxpopup item to be enabled/disabled
26096 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
26098 * When disabled the item is greyed out to indicate it's state.
26100 EAPI void elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
26102 * @brief Get the ctxpopup item's disabled/enabled state.
26104 * @param it Ctxpopup item to be enabled/disabled
26105 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
26107 * @see elm_ctxpopup_item_disabled_set()
26109 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26111 * @brief Get the icon object for the given ctxpopup item.
26113 * @param it Ctxpopup item
26114 * @return icon object or @c NULL, if the item does not have icon or an error
26117 * @see elm_ctxpopup_item_append()
26118 * @see elm_ctxpopup_item_icon_set()
26120 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26122 * @brief Sets the side icon associated with the ctxpopup item
26124 * @param it Ctxpopup item
26125 * @param icon Icon object to be set
26127 * Once the icon object is set, a previously set one will be deleted.
26128 * @warning Setting the same icon for two items will cause the icon to
26129 * dissapear from the first item.
26131 * @see elm_ctxpopup_item_append()
26133 EAPI void elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26135 * @brief Get the label for the given ctxpopup item.
26137 * @param it Ctxpopup item
26138 * @return label string or @c NULL, if the item does not have label or an
26141 * @see elm_ctxpopup_item_append()
26142 * @see elm_ctxpopup_item_label_set()
26144 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26146 * @brief (Re)set the label on the given ctxpopup item.
26148 * @param it Ctxpopup item
26149 * @param label String to set as label
26151 EAPI void elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26153 * @brief Set an elm widget as the content of the ctxpopup.
26155 * @param obj Ctxpopup object
26156 * @param content Content to be swallowed
26158 * If the content object is already set, a previous one will bedeleted. If
26159 * you want to keep that old content object, use the
26160 * elm_ctxpopup_content_unset() function.
26162 * @deprecated use elm_object_content_set()
26164 * @warning Ctxpopup can't hold both a item list and a content at the same
26165 * time. When a content is set, any previous items will be removed.
26167 EINA_DEPRECATED EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
26169 * @brief Unset the ctxpopup content
26171 * @param obj Ctxpopup object
26172 * @return The content that was being used
26174 * Unparent and return the content object which was set for this widget.
26176 * @deprecated use elm_object_content_unset()
26178 * @see elm_ctxpopup_content_set()
26180 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
26182 * @brief Set the direction priority of a ctxpopup.
26184 * @param obj Ctxpopup object
26185 * @param first 1st priority of direction
26186 * @param second 2nd priority of direction
26187 * @param third 3th priority of direction
26188 * @param fourth 4th priority of direction
26190 * This functions gives a chance to user to set the priority of ctxpopup
26191 * showing direction. This doesn't guarantee the ctxpopup will appear in the
26192 * requested direction.
26194 * @see Elm_Ctxpopup_Direction
26196 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);
26198 * @brief Get the direction priority of a ctxpopup.
26200 * @param obj Ctxpopup object
26201 * @param first 1st priority of direction to be returned
26202 * @param second 2nd priority of direction to be returned
26203 * @param third 3th priority of direction to be returned
26204 * @param fourth 4th priority of direction to be returned
26206 * @see elm_ctxpopup_direction_priority_set() for more information.
26208 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);
26211 * @brief Get the current direction of a ctxpopup.
26213 * @param obj Ctxpopup object
26214 * @return current direction of a ctxpopup
26216 * @warning Once the ctxpopup showed up, the direction would be determined
26218 EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26227 * @defgroup Transit Transit
26228 * @ingroup Elementary
26230 * Transit is designed to apply various animated transition effects to @c
26231 * Evas_Object, such like translation, rotation, etc. For using these
26232 * effects, create an @ref Elm_Transit and add the desired transition effects.
26234 * Once the effects are added into transit, they will be automatically
26235 * managed (their callback will be called until the duration is ended, and
26236 * they will be deleted on completion).
26240 * Elm_Transit *trans = elm_transit_add();
26241 * elm_transit_object_add(trans, obj);
26242 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
26243 * elm_transit_duration_set(transit, 1);
26244 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
26245 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
26246 * elm_transit_repeat_times_set(transit, 3);
26249 * Some transition effects are used to change the properties of objects. They
26251 * @li @ref elm_transit_effect_translation_add
26252 * @li @ref elm_transit_effect_color_add
26253 * @li @ref elm_transit_effect_rotation_add
26254 * @li @ref elm_transit_effect_wipe_add
26255 * @li @ref elm_transit_effect_zoom_add
26256 * @li @ref elm_transit_effect_resizing_add
26258 * Other transition effects are used to make one object disappear and another
26259 * object appear on its old place. These effects are:
26261 * @li @ref elm_transit_effect_flip_add
26262 * @li @ref elm_transit_effect_resizable_flip_add
26263 * @li @ref elm_transit_effect_fade_add
26264 * @li @ref elm_transit_effect_blend_add
26266 * It's also possible to make a transition chain with @ref
26267 * elm_transit_chain_transit_add.
26269 * @warning We strongly recommend to use elm_transit just when edje can not do
26270 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
26271 * animations can be manipulated inside the theme.
26273 * List of examples:
26274 * @li @ref transit_example_01_explained
26275 * @li @ref transit_example_02_explained
26276 * @li @ref transit_example_03_c
26277 * @li @ref transit_example_04_c
26283 * @enum Elm_Transit_Tween_Mode
26285 * The type of acceleration used in the transition.
26289 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
26290 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
26291 over time, then decrease again
26293 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
26295 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
26297 } Elm_Transit_Tween_Mode;
26300 * @enum Elm_Transit_Effect_Flip_Axis
26302 * The axis where flip effect should be applied.
26306 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
26307 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
26308 } Elm_Transit_Effect_Flip_Axis;
26310 * @enum Elm_Transit_Effect_Wipe_Dir
26312 * The direction where the wipe effect should occur.
26316 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
26317 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
26318 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
26319 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
26320 } Elm_Transit_Effect_Wipe_Dir;
26321 /** @enum Elm_Transit_Effect_Wipe_Type
26323 * Whether the wipe effect should show or hide the object.
26327 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
26329 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
26331 } Elm_Transit_Effect_Wipe_Type;
26334 * @typedef Elm_Transit
26336 * The Transit created with elm_transit_add(). This type has the information
26337 * about the objects which the transition will be applied, and the
26338 * transition effects that will be used. It also contains info about
26339 * duration, number of repetitions, auto-reverse, etc.
26341 typedef struct _Elm_Transit Elm_Transit;
26342 typedef void Elm_Transit_Effect;
26344 * @typedef Elm_Transit_Effect_Transition_Cb
26346 * Transition callback called for this effect on each transition iteration.
26348 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
26350 * Elm_Transit_Effect_End_Cb
26352 * Transition callback called for this effect when the transition is over.
26354 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
26357 * Elm_Transit_Del_Cb
26359 * A callback called when the transit is deleted.
26361 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
26366 * @note Is not necessary to delete the transit object, it will be deleted at
26367 * the end of its operation.
26368 * @note The transit will start playing when the program enter in the main loop, is not
26369 * necessary to give a start to the transit.
26371 * @return The transit object.
26375 EAPI Elm_Transit *elm_transit_add(void);
26378 * Stops the animation and delete the @p transit object.
26380 * Call this function if you wants to stop the animation before the duration
26381 * time. Make sure the @p transit object is still alive with
26382 * elm_transit_del_cb_set() function.
26383 * All added effects will be deleted, calling its repective data_free_cb
26384 * functions. The function setted by elm_transit_del_cb_set() will be called.
26386 * @see elm_transit_del_cb_set()
26388 * @param transit The transit object to be deleted.
26391 * @warning Just call this function if you are sure the transit is alive.
26393 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
26396 * Add a new effect to the transit.
26398 * @note The cb function and the data are the key to the effect. If you try to
26399 * add an already added effect, nothing is done.
26400 * @note After the first addition of an effect in @p transit, if its
26401 * effect list become empty again, the @p transit will be killed by
26402 * elm_transit_del(transit) function.
26406 * Elm_Transit *transit = elm_transit_add();
26407 * elm_transit_effect_add(transit,
26408 * elm_transit_effect_blend_op,
26409 * elm_transit_effect_blend_context_new(),
26410 * elm_transit_effect_blend_context_free);
26413 * @param transit The transit object.
26414 * @param transition_cb The operation function. It is called when the
26415 * animation begins, it is the function that actually performs the animation.
26416 * It is called with the @p data, @p transit and the time progression of the
26417 * animation (a double value between 0.0 and 1.0).
26418 * @param effect The context data of the effect.
26419 * @param end_cb The function to free the context data, it will be called
26420 * at the end of the effect, it must finalize the animation and free the
26424 * @warning The transit free the context data at the and of the transition with
26425 * the data_free_cb function, do not use the context data in another transit.
26427 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);
26430 * Delete an added effect.
26432 * This function will remove the effect from the @p transit, calling the
26433 * data_free_cb to free the @p data.
26435 * @see elm_transit_effect_add()
26437 * @note If the effect is not found, nothing is done.
26438 * @note If the effect list become empty, this function will call
26439 * elm_transit_del(transit), that is, it will kill the @p transit.
26441 * @param transit The transit object.
26442 * @param transition_cb The operation function.
26443 * @param effect The context data of the effect.
26447 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);
26450 * Add new object to apply the effects.
26452 * @note After the first addition of an object in @p transit, if its
26453 * object list become empty again, the @p transit will be killed by
26454 * elm_transit_del(transit) function.
26455 * @note If the @p obj belongs to another transit, the @p obj will be
26456 * removed from it and it will only belong to the @p transit. If the old
26457 * transit stays without objects, it will die.
26458 * @note When you add an object into the @p transit, its state from
26459 * evas_object_pass_events_get(obj) is saved, and it is applied when the
26460 * transit ends, if you change this state whith evas_object_pass_events_set()
26461 * after add the object, this state will change again when @p transit stops to
26464 * @param transit The transit object.
26465 * @param obj Object to be animated.
26468 * @warning It is not allowed to add a new object after transit begins to go.
26470 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
26473 * Removes an added object from the transit.
26475 * @note If the @p obj is not in the @p transit, nothing is done.
26476 * @note If the list become empty, this function will call
26477 * elm_transit_del(transit), that is, it will kill the @p transit.
26479 * @param transit The transit object.
26480 * @param obj Object to be removed from @p transit.
26483 * @warning It is not allowed to remove objects after transit begins to go.
26485 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
26488 * Get the objects of the transit.
26490 * @param transit The transit object.
26491 * @return a Eina_List with the objects from the transit.
26495 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26498 * Enable/disable keeping up the objects states.
26499 * If it is not kept, the objects states will be reset when transition ends.
26501 * @note @p transit can not be NULL.
26502 * @note One state includes geometry, color, map data.
26504 * @param transit The transit object.
26505 * @param state_keep Keeping or Non Keeping.
26509 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
26512 * Get a value whether the objects states will be reset or not.
26514 * @note @p transit can not be NULL
26516 * @see elm_transit_objects_final_state_keep_set()
26518 * @param transit The transit object.
26519 * @return EINA_TRUE means the states of the objects will be reset.
26520 * If @p transit is NULL, EINA_FALSE is returned
26524 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26527 * Set the event enabled when transit is operating.
26529 * If @p enabled is EINA_TRUE, the objects of the transit will receives
26530 * events from mouse and keyboard during the animation.
26531 * @note When you add an object with elm_transit_object_add(), its state from
26532 * evas_object_pass_events_get(obj) is saved, and it is applied when the
26533 * transit ends, if you change this state with evas_object_pass_events_set()
26534 * after adding the object, this state will change again when @p transit stops
26537 * @param transit The transit object.
26538 * @param enabled Events are received when enabled is @c EINA_TRUE, and
26539 * ignored otherwise.
26543 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
26546 * Get the value of event enabled status.
26548 * @see elm_transit_event_enabled_set()
26550 * @param transit The Transit object
26551 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
26552 * EINA_FALSE is returned
26556 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26559 * Set the user-callback function when the transit is deleted.
26561 * @note Using this function twice will overwrite the first function setted.
26562 * @note the @p transit object will be deleted after call @p cb function.
26564 * @param transit The transit object.
26565 * @param cb Callback function pointer. This function will be called before
26566 * the deletion of the transit.
26567 * @param data Callback funtion user data. It is the @p op parameter.
26571 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
26574 * Set reverse effect automatically.
26576 * If auto reverse is setted, after running the effects with the progress
26577 * parameter from 0 to 1, it will call the effecs again with the progress
26578 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
26579 * where the duration was setted with the function elm_transit_add and
26580 * the repeat with the function elm_transit_repeat_times_set().
26582 * @param transit The transit object.
26583 * @param reverse EINA_TRUE means the auto_reverse is on.
26587 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
26590 * Get if the auto reverse is on.
26592 * @see elm_transit_auto_reverse_set()
26594 * @param transit The transit object.
26595 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
26596 * EINA_FALSE is returned
26600 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26603 * Set the transit repeat count. Effect will be repeated by repeat count.
26605 * This function sets the number of repetition the transit will run after
26606 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
26607 * If the @p repeat is a negative number, it will repeat infinite times.
26609 * @note If this function is called during the transit execution, the transit
26610 * will run @p repeat times, ignoring the times it already performed.
26612 * @param transit The transit object
26613 * @param repeat Repeat count
26617 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
26620 * Get the transit repeat count.
26622 * @see elm_transit_repeat_times_set()
26624 * @param transit The Transit object.
26625 * @return The repeat count. If @p transit is NULL
26630 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26633 * Set the transit animation acceleration type.
26635 * This function sets the tween mode of the transit that can be:
26636 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
26637 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
26638 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
26639 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
26641 * @param transit The transit object.
26642 * @param tween_mode The tween type.
26646 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
26649 * Get the transit animation acceleration type.
26651 * @note @p transit can not be NULL
26653 * @param transit The transit object.
26654 * @return The tween type. If @p transit is NULL
26655 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
26659 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26662 * Set the transit animation time
26664 * @note @p transit can not be NULL
26666 * @param transit The transit object.
26667 * @param duration The animation time.
26671 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
26674 * Get the transit animation time
26676 * @note @p transit can not be NULL
26678 * @param transit The transit object.
26680 * @return The transit animation time.
26684 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26687 * Starts the transition.
26688 * Once this API is called, the transit begins to measure the time.
26690 * @note @p transit can not be NULL
26692 * @param transit The transit object.
26696 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
26699 * Pause/Resume the transition.
26701 * If you call elm_transit_go again, the transit will be started from the
26702 * beginning, and will be unpaused.
26704 * @note @p transit can not be NULL
26706 * @param transit The transit object.
26707 * @param paused Whether the transition should be paused or not.
26711 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
26714 * Get the value of paused status.
26716 * @see elm_transit_paused_set()
26718 * @note @p transit can not be NULL
26720 * @param transit The transit object.
26721 * @return EINA_TRUE means transition is paused. If @p transit is NULL
26722 * EINA_FALSE is returned
26726 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26729 * Get the time progression of the animation (a double value between 0.0 and 1.0).
26731 * The value returned is a fraction (current time / total time). It
26732 * represents the progression position relative to the total.
26734 * @note @p transit can not be NULL
26736 * @param transit The transit object.
26738 * @return The time progression value. If @p transit is NULL
26743 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26746 * Makes the chain relationship between two transits.
26748 * @note @p transit can not be NULL. Transit would have multiple chain transits.
26749 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
26751 * @param transit The transit object.
26752 * @param chain_transit The chain transit object. This transit will be operated
26753 * after transit is done.
26755 * This function adds @p chain_transit transition to a chain after the @p
26756 * transit, and will be started as soon as @p transit ends. See @ref
26757 * transit_example_02_explained for a full example.
26761 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
26764 * Cut off the chain relationship between two transits.
26766 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
26767 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
26769 * @param transit The transit object.
26770 * @param chain_transit The chain transit object.
26772 * This function remove the @p chain_transit transition from the @p transit.
26776 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
26779 * Get the current chain transit list.
26781 * @note @p transit can not be NULL.
26783 * @param transit The transit object.
26784 * @return chain transit list.
26788 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
26791 * Add the Resizing Effect to Elm_Transit.
26793 * @note This API is one of the facades. It creates resizing effect context
26794 * and add it's required APIs to elm_transit_effect_add.
26796 * @see elm_transit_effect_add()
26798 * @param transit Transit object.
26799 * @param from_w Object width size when effect begins.
26800 * @param from_h Object height size when effect begins.
26801 * @param to_w Object width size when effect ends.
26802 * @param to_h Object height size when effect ends.
26803 * @return Resizing effect context data.
26807 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);
26810 * Add the Translation Effect to Elm_Transit.
26812 * @note This API is one of the facades. It creates translation effect context
26813 * and add it's required APIs to elm_transit_effect_add.
26815 * @see elm_transit_effect_add()
26817 * @param transit Transit object.
26818 * @param from_dx X Position variation when effect begins.
26819 * @param from_dy Y Position variation when effect begins.
26820 * @param to_dx X Position variation when effect ends.
26821 * @param to_dy Y Position variation when effect ends.
26822 * @return Translation effect context data.
26825 * @warning It is highly recommended just create a transit with this effect when
26826 * the window that the objects of the transit belongs has already been created.
26827 * This is because this effect needs the geometry information about the objects,
26828 * and if the window was not created yet, it can get a wrong information.
26830 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);
26833 * Add the Zoom Effect to Elm_Transit.
26835 * @note This API is one of the facades. It creates zoom effect context
26836 * and add it's required APIs to elm_transit_effect_add.
26838 * @see elm_transit_effect_add()
26840 * @param transit Transit object.
26841 * @param from_rate Scale rate when effect begins (1 is current rate).
26842 * @param to_rate Scale rate when effect ends.
26843 * @return Zoom effect context data.
26846 * @warning It is highly recommended just create a transit with this effect when
26847 * the window that the objects of the transit belongs has already been created.
26848 * This is because this effect needs the geometry information about the objects,
26849 * and if the window was not created yet, it can get a wrong information.
26851 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
26854 * Add the Flip Effect to Elm_Transit.
26856 * @note This API is one of the facades. It creates flip effect context
26857 * and add it's required APIs to elm_transit_effect_add.
26858 * @note This effect is applied to each pair of objects in the order they are listed
26859 * in the transit list of objects. The first object in the pair will be the
26860 * "front" object and the second will be the "back" object.
26862 * @see elm_transit_effect_add()
26864 * @param transit Transit object.
26865 * @param axis Flipping Axis(X or Y).
26866 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
26867 * @return Flip effect context data.
26870 * @warning It is highly recommended just create a transit with this effect when
26871 * the window that the objects of the transit belongs has already been created.
26872 * This is because this effect needs the geometry information about the objects,
26873 * and if the window was not created yet, it can get a wrong information.
26875 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
26878 * Add the Resizable Flip Effect to Elm_Transit.
26880 * @note This API is one of the facades. It creates resizable flip effect context
26881 * and add it's required APIs to elm_transit_effect_add.
26882 * @note This effect is applied to each pair of objects in the order they are listed
26883 * in the transit list of objects. The first object in the pair will be the
26884 * "front" object and the second will be the "back" object.
26886 * @see elm_transit_effect_add()
26888 * @param transit Transit object.
26889 * @param axis Flipping Axis(X or Y).
26890 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
26891 * @return Resizable flip effect context data.
26894 * @warning It is highly recommended just create a transit with this effect when
26895 * the window that the objects of the transit belongs has already been created.
26896 * This is because this effect needs the geometry information about the objects,
26897 * and if the window was not created yet, it can get a wrong information.
26899 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
26902 * Add the Wipe Effect to Elm_Transit.
26904 * @note This API is one of the facades. It creates wipe effect context
26905 * and add it's required APIs to elm_transit_effect_add.
26907 * @see elm_transit_effect_add()
26909 * @param transit Transit object.
26910 * @param type Wipe type. Hide or show.
26911 * @param dir Wipe Direction.
26912 * @return Wipe effect context data.
26915 * @warning It is highly recommended just create a transit with this effect when
26916 * the window that the objects of the transit belongs has already been created.
26917 * This is because this effect needs the geometry information about the objects,
26918 * and if the window was not created yet, it can get a wrong information.
26920 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
26923 * Add the Color Effect to Elm_Transit.
26925 * @note This API is one of the facades. It creates color effect context
26926 * and add it's required APIs to elm_transit_effect_add.
26928 * @see elm_transit_effect_add()
26930 * @param transit Transit object.
26931 * @param from_r RGB R when effect begins.
26932 * @param from_g RGB G when effect begins.
26933 * @param from_b RGB B when effect begins.
26934 * @param from_a RGB A when effect begins.
26935 * @param to_r RGB R when effect ends.
26936 * @param to_g RGB G when effect ends.
26937 * @param to_b RGB B when effect ends.
26938 * @param to_a RGB A when effect ends.
26939 * @return Color effect context data.
26943 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);
26946 * Add the Fade Effect to Elm_Transit.
26948 * @note This API is one of the facades. It creates fade effect context
26949 * and add it's required APIs to elm_transit_effect_add.
26950 * @note This effect is applied to each pair of objects in the order they are listed
26951 * in the transit list of objects. The first object in the pair will be the
26952 * "before" object and the second will be the "after" object.
26954 * @see elm_transit_effect_add()
26956 * @param transit Transit object.
26957 * @return Fade effect context data.
26960 * @warning It is highly recommended just create a transit with this effect when
26961 * the window that the objects of the transit belongs has already been created.
26962 * This is because this effect needs the color information about the objects,
26963 * and if the window was not created yet, it can get a wrong information.
26965 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
26968 * Add the Blend Effect to Elm_Transit.
26970 * @note This API is one of the facades. It creates blend effect context
26971 * and add it's required APIs to elm_transit_effect_add.
26972 * @note This effect is applied to each pair of objects in the order they are listed
26973 * in the transit list of objects. The first object in the pair will be the
26974 * "before" object and the second will be the "after" object.
26976 * @see elm_transit_effect_add()
26978 * @param transit Transit object.
26979 * @return Blend effect context data.
26982 * @warning It is highly recommended just create a transit with this effect when
26983 * the window that the objects of the transit belongs has already been created.
26984 * This is because this effect needs the color information about the objects,
26985 * and if the window was not created yet, it can get a wrong information.
26987 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
26990 * Add the Rotation Effect to Elm_Transit.
26992 * @note This API is one of the facades. It creates rotation effect context
26993 * and add it's required APIs to elm_transit_effect_add.
26995 * @see elm_transit_effect_add()
26997 * @param transit Transit object.
26998 * @param from_degree Degree when effect begins.
26999 * @param to_degree Degree when effect is ends.
27000 * @return Rotation effect context data.
27003 * @warning It is highly recommended just create a transit with this effect when
27004 * the window that the objects of the transit belongs has already been created.
27005 * This is because this effect needs the geometry information about the objects,
27006 * and if the window was not created yet, it can get a wrong information.
27008 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
27011 * Add the ImageAnimation Effect to Elm_Transit.
27013 * @note This API is one of the facades. It creates image animation effect context
27014 * and add it's required APIs to elm_transit_effect_add.
27015 * The @p images parameter is a list images paths. This list and
27016 * its contents will be deleted at the end of the effect by
27017 * elm_transit_effect_image_animation_context_free() function.
27021 * char buf[PATH_MAX];
27022 * Eina_List *images = NULL;
27023 * Elm_Transit *transi = elm_transit_add();
27025 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
27026 * images = eina_list_append(images, eina_stringshare_add(buf));
27028 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
27029 * images = eina_list_append(images, eina_stringshare_add(buf));
27030 * elm_transit_effect_image_animation_add(transi, images);
27034 * @see elm_transit_effect_add()
27036 * @param transit Transit object.
27037 * @param images Eina_List of images file paths. This list and
27038 * its contents will be deleted at the end of the effect by
27039 * elm_transit_effect_image_animation_context_free() function.
27040 * @return Image Animation effect context data.
27044 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
27049 typedef struct _Elm_Store Elm_Store;
27050 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
27051 typedef struct _Elm_Store_Item Elm_Store_Item;
27052 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
27053 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
27054 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
27055 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
27056 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
27057 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
27058 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
27059 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
27061 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
27062 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
27063 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
27064 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
27068 ELM_STORE_ITEM_MAPPING_NONE = 0,
27069 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
27070 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
27071 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
27072 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
27073 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
27074 // can add more here as needed by common apps
27075 ELM_STORE_ITEM_MAPPING_LAST
27076 } Elm_Store_Item_Mapping_Type;
27078 struct _Elm_Store_Item_Mapping_Icon
27080 // FIXME: allow edje file icons
27082 Elm_Icon_Lookup_Order lookup_order;
27083 Eina_Bool standard_name : 1;
27084 Eina_Bool no_scale : 1;
27085 Eina_Bool smooth : 1;
27086 Eina_Bool scale_up : 1;
27087 Eina_Bool scale_down : 1;
27090 struct _Elm_Store_Item_Mapping_Empty
27095 struct _Elm_Store_Item_Mapping_Photo
27100 struct _Elm_Store_Item_Mapping_Custom
27102 Elm_Store_Item_Mapping_Cb func;
27105 struct _Elm_Store_Item_Mapping
27107 Elm_Store_Item_Mapping_Type type;
27112 Elm_Store_Item_Mapping_Empty empty;
27113 Elm_Store_Item_Mapping_Icon icon;
27114 Elm_Store_Item_Mapping_Photo photo;
27115 Elm_Store_Item_Mapping_Custom custom;
27116 // add more types here
27120 struct _Elm_Store_Item_Info
27122 Elm_Genlist_Item_Class *item_class;
27123 const Elm_Store_Item_Mapping *mapping;
27128 struct _Elm_Store_Item_Info_Filesystem
27130 Elm_Store_Item_Info base;
27134 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
27135 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
27137 EAPI void elm_store_free(Elm_Store *st);
27139 EAPI Elm_Store *elm_store_filesystem_new(void);
27140 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
27141 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27142 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27144 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
27146 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
27147 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27148 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27149 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27150 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
27151 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27153 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27154 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
27155 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27156 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
27157 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27158 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27159 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27162 * @defgroup SegmentControl SegmentControl
27163 * @ingroup Elementary
27165 * @image html img/widget/segment_control/preview-00.png
27166 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
27168 * @image html img/segment_control.png
27169 * @image latex img/segment_control.eps width=\textwidth
27171 * Segment control widget is a horizontal control made of multiple segment
27172 * items, each segment item functioning similar to discrete two state button.
27173 * A segment control groups the items together and provides compact
27174 * single button with multiple equal size segments.
27176 * Segment item size is determined by base widget
27177 * size and the number of items added.
27178 * Only one segment item can be at selected state. A segment item can display
27179 * combination of Text and any Evas_Object like Images or other widget.
27181 * Smart callbacks one can listen to:
27182 * - "changed" - When the user clicks on a segment item which is not
27183 * previously selected and get selected. The event_info parameter is the
27184 * segment item index.
27186 * Available styles for it:
27189 * Here is an example on its usage:
27190 * @li @ref segment_control_example
27194 * @addtogroup SegmentControl
27198 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
27201 * Add a new segment control widget to the given parent Elementary
27202 * (container) object.
27204 * @param parent The parent object.
27205 * @return a new segment control widget handle or @c NULL, on errors.
27207 * This function inserts a new segment control widget on the canvas.
27209 * @ingroup SegmentControl
27211 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27214 * Append a new item to the segment control object.
27216 * @param obj The segment control object.
27217 * @param icon The icon object to use for the left side of the item. An
27218 * icon can be any Evas object, but usually it is an icon created
27219 * with elm_icon_add().
27220 * @param label The label of the item.
27221 * Note that, NULL is different from empty string "".
27222 * @return The created item or @c NULL upon failure.
27224 * A new item will be created and appended to the segment control, i.e., will
27225 * be set as @b last item.
27227 * If it should be inserted at another position,
27228 * elm_segment_control_item_insert_at() should be used instead.
27230 * Items created with this function can be deleted with function
27231 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27233 * @note @p label set to @c NULL is different from empty string "".
27235 * only has icon, it will be displayed bigger and centered. If it has
27236 * icon and label, even that an empty string, icon will be smaller and
27237 * positioned at left.
27241 * sc = elm_segment_control_add(win);
27242 * ic = elm_icon_add(win);
27243 * elm_icon_file_set(ic, "path/to/image", NULL);
27244 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
27245 * elm_segment_control_item_add(sc, ic, "label");
27246 * evas_object_show(sc);
27249 * @see elm_segment_control_item_insert_at()
27250 * @see elm_segment_control_item_del()
27252 * @ingroup SegmentControl
27254 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
27257 * Insert a new item to the segment control object at specified position.
27259 * @param obj The segment control object.
27260 * @param icon The icon object to use for the left side of the item. An
27261 * icon can be any Evas object, but usually it is an icon created
27262 * with elm_icon_add().
27263 * @param label The label of the item.
27264 * @param index Item position. Value should be between 0 and items count.
27265 * @return The created item or @c NULL upon failure.
27267 * Index values must be between @c 0, when item will be prepended to
27268 * segment control, and items count, that can be get with
27269 * elm_segment_control_item_count_get(), case when item will be appended
27270 * to segment control, just like elm_segment_control_item_add().
27272 * Items created with this function can be deleted with function
27273 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27275 * @note @p label set to @c NULL is different from empty string "".
27277 * only has icon, it will be displayed bigger and centered. If it has
27278 * icon and label, even that an empty string, icon will be smaller and
27279 * positioned at left.
27281 * @see elm_segment_control_item_add()
27282 * @see elm_segment_control_item_count_get()
27283 * @see elm_segment_control_item_del()
27285 * @ingroup SegmentControl
27287 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);
27290 * Remove a segment control item from its parent, deleting it.
27292 * @param it The item to be removed.
27294 * Items can be added with elm_segment_control_item_add() or
27295 * elm_segment_control_item_insert_at().
27297 * @ingroup SegmentControl
27299 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27302 * Remove a segment control item at given index from its parent,
27305 * @param obj The segment control object.
27306 * @param index The position of the segment control item to be deleted.
27308 * Items can be added with elm_segment_control_item_add() or
27309 * elm_segment_control_item_insert_at().
27311 * @ingroup SegmentControl
27313 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27316 * Get the Segment items count from segment control.
27318 * @param obj The segment control object.
27319 * @return Segment items count.
27321 * It will just return the number of items added to segment control @p obj.
27323 * @ingroup SegmentControl
27325 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27328 * Get the item placed at specified index.
27330 * @param obj The segment control object.
27331 * @param index The index of the segment item.
27332 * @return The segment control item or @c NULL on failure.
27334 * Index is the position of an item in segment control widget. Its
27335 * range is from @c 0 to <tt> count - 1 </tt>.
27336 * Count is the number of items, that can be get with
27337 * elm_segment_control_item_count_get().
27339 * @ingroup SegmentControl
27341 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27344 * Get the label of item.
27346 * @param obj The segment control object.
27347 * @param index The index of the segment item.
27348 * @return The label of the item at @p index.
27350 * The return value is a pointer to the label associated to the item when
27351 * it was created, with function elm_segment_control_item_add(), or later
27352 * with function elm_segment_control_item_label_set. If no label
27353 * was passed as argument, it will return @c NULL.
27355 * @see elm_segment_control_item_label_set() for more details.
27356 * @see elm_segment_control_item_add()
27358 * @ingroup SegmentControl
27360 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27363 * Set the label of item.
27365 * @param it The item of segment control.
27366 * @param text The label of item.
27368 * The label to be displayed by the item.
27369 * Label will be at right of the icon (if set).
27371 * If a label was passed as argument on item creation, with function
27372 * elm_control_segment_item_add(), it will be already
27373 * displayed by the item.
27375 * @see elm_segment_control_item_label_get()
27376 * @see elm_segment_control_item_add()
27378 * @ingroup SegmentControl
27380 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
27383 * Get the icon associated to the item.
27385 * @param obj The segment control object.
27386 * @param index The index of the segment item.
27387 * @return The left side icon associated to the item at @p index.
27389 * The return value is a pointer to the icon associated to the item when
27390 * it was created, with function elm_segment_control_item_add(), or later
27391 * with function elm_segment_control_item_icon_set(). If no icon
27392 * was passed as argument, it will return @c NULL.
27394 * @see elm_segment_control_item_add()
27395 * @see elm_segment_control_item_icon_set()
27397 * @ingroup SegmentControl
27399 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27402 * Set the icon associated to the item.
27404 * @param it The segment control item.
27405 * @param icon The icon object to associate with @p it.
27407 * The icon object to use at left side of the item. An
27408 * icon can be any Evas object, but usually it is an icon created
27409 * with elm_icon_add().
27411 * Once the icon object is set, a previously set one will be deleted.
27412 * @warning Setting the same icon for two items will cause the icon to
27413 * dissapear from the first item.
27415 * If an icon was passed as argument on item creation, with function
27416 * elm_segment_control_item_add(), it will be already
27417 * associated to the item.
27419 * @see elm_segment_control_item_add()
27420 * @see elm_segment_control_item_icon_get()
27422 * @ingroup SegmentControl
27424 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
27427 * Get the index of an item.
27429 * @param it The segment control item.
27430 * @return The position of item in segment control widget.
27432 * Index is the position of an item in segment control widget. Its
27433 * range is from @c 0 to <tt> count - 1 </tt>.
27434 * Count is the number of items, that can be get with
27435 * elm_segment_control_item_count_get().
27437 * @ingroup SegmentControl
27439 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27442 * Get the base object of the item.
27444 * @param it The segment control item.
27445 * @return The base object associated with @p it.
27447 * Base object is the @c Evas_Object that represents that item.
27449 * @ingroup SegmentControl
27451 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27454 * Get the selected item.
27456 * @param obj The segment control object.
27457 * @return The selected item or @c NULL if none of segment items is
27460 * The selected item can be unselected with function
27461 * elm_segment_control_item_selected_set().
27463 * The selected item always will be highlighted on segment control.
27465 * @ingroup SegmentControl
27467 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27470 * Set the selected state of an item.
27472 * @param it The segment control item
27473 * @param select The selected state
27475 * This sets the selected state of the given item @p it.
27476 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
27478 * If a new item is selected the previosly selected will be unselected.
27479 * Previoulsy selected item can be get with function
27480 * elm_segment_control_item_selected_get().
27482 * The selected item always will be highlighted on segment control.
27484 * @see elm_segment_control_item_selected_get()
27486 * @ingroup SegmentControl
27488 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
27495 * @defgroup Grid Grid
27497 * The grid is a grid layout widget that lays out a series of children as a
27498 * fixed "grid" of widgets using a given percentage of the grid width and
27499 * height each using the child object.
27501 * The Grid uses a "Virtual resolution" that is stretched to fill the grid
27502 * widgets size itself. The default is 100 x 100, so that means the
27503 * position and sizes of children will effectively be percentages (0 to 100)
27504 * of the width or height of the grid widget
27510 * Add a new grid to the parent
27512 * @param parent The parent object
27513 * @return The new object or NULL if it cannot be created
27517 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
27520 * Set the virtual size of the grid
27522 * @param obj The grid object
27523 * @param w The virtual width of the grid
27524 * @param h The virtual height of the grid
27528 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
27531 * Get the virtual size of the grid
27533 * @param obj The grid object
27534 * @param w Pointer to integer to store the virtual width of the grid
27535 * @param h Pointer to integer to store the virtual height of the grid
27539 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
27542 * Pack child at given position and size
27544 * @param obj The grid object
27545 * @param subobj The child to pack
27546 * @param x The virtual x coord at which to pack it
27547 * @param y The virtual y coord at which to pack it
27548 * @param w The virtual width at which to pack it
27549 * @param h The virtual height at which to pack it
27553 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
27556 * Unpack a child from a grid object
27558 * @param obj The grid object
27559 * @param subobj The child to unpack
27563 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
27566 * Faster way to remove all child objects from a grid object.
27568 * @param obj The grid object
27569 * @param clear If true, it will delete just removed children
27573 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
27576 * Set packing of an existing child at to position and size
27578 * @param subobj The child to set packing of
27579 * @param x The virtual x coord at which to pack it
27580 * @param y The virtual y coord at which to pack it
27581 * @param w The virtual width at which to pack it
27582 * @param h The virtual height at which to pack it
27586 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
27589 * get packing of a child
27591 * @param subobj The child to query
27592 * @param x Pointer to integer to store the virtual x coord
27593 * @param y Pointer to integer to store the virtual y coord
27594 * @param w Pointer to integer to store the virtual width
27595 * @param h Pointer to integer to store the virtual height
27599 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
27605 EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
27606 EAPI void elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
27607 EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
27608 EAPI void elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
27609 EAPI Eina_Bool elm_factory_maxmin_mode_get(const Evas_Object *obj);
27610 EAPI void elm_factory_maxmin_reset_set(Evas_Object *obj);
27613 * @defgroup Video Video
27615 * @addtogroup Video
27618 * Elementary comes with two object that help design application that need
27619 * to display video. The main one, Elm_Video, display a video by using Emotion.
27620 * It does embedded the video inside an Edje object, so you can do some
27621 * animation depending on the video state change. It does also implement a
27622 * ressource management policy to remove this burden from the application writer.
27624 * The second one, Elm_Player is a video player that need to be linked with and Elm_Video.
27625 * It take care of updating its content according to Emotion event and provide a
27626 * way to theme itself. It also does automatically raise the priority of the
27627 * linked Elm_Video so it will use the video decoder if available. It also does
27628 * activate the remember function on the linked Elm_Video object.
27630 * Signals that you can add callback for are :
27632 * "forward,clicked" - the user clicked the forward button.
27633 * "info,clicked" - the user clicked the info button.
27634 * "next,clicked" - the user clicked the next button.
27635 * "pause,clicked" - the user clicked the pause button.
27636 * "play,clicked" - the user clicked the play button.
27637 * "prev,clicked" - the user clicked the prev button.
27638 * "rewind,clicked" - the user clicked the rewind button.
27639 * "stop,clicked" - the user clicked the stop button.
27643 * @brief Add a new Elm_Player object to the given parent Elementary (container) object.
27645 * @param parent The parent object
27646 * @return a new player widget handle or @c NULL, on errors.
27648 * This function inserts a new player widget on the canvas.
27650 * @see elm_player_video_set()
27654 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
27657 * @brief Link a Elm_Payer with an Elm_Video object.
27659 * @param player the Elm_Player object.
27660 * @param video The Elm_Video object.
27662 * This mean that action on the player widget will affect the
27663 * video object and the state of the video will be reflected in
27664 * the player itself.
27666 * @see elm_player_add()
27667 * @see elm_video_add()
27671 EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
27674 * @brief Add a new Elm_Video object to the given parent Elementary (container) object.
27676 * @param parent The parent object
27677 * @return a new video widget handle or @c NULL, on errors.
27679 * This function inserts a new video widget on the canvas.
27681 * @seeelm_video_file_set()
27682 * @see elm_video_uri_set()
27686 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
27689 * @brief Define the file that will be the video source.
27691 * @param video The video object to define the file for.
27692 * @param filename The file to target.
27694 * This function will explicitly define a filename as a source
27695 * for the video of the Elm_Video object.
27697 * @see elm_video_uri_set()
27698 * @see elm_video_add()
27699 * @see elm_player_add()
27703 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
27706 * @brief Define the uri that will be the video source.
27708 * @param video The video object to define the file for.
27709 * @param uri The uri to target.
27711 * This function will define an uri as a source for the video of the
27712 * Elm_Video object. URI could be remote source of video, like http:// or local source
27713 * like for example WebCam who are most of the time v4l2:// (but that depend and
27714 * you should use Emotion API to request and list the available Webcam on your system).
27716 * @see elm_video_file_set()
27717 * @see elm_video_add()
27718 * @see elm_player_add()
27722 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
27725 * @brief Get the underlying Emotion object.
27727 * @param video The video object to proceed the request on.
27728 * @return the underlying Emotion object.
27732 EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
27735 * @brief Start to play the video
27737 * @param video The video object to proceed the request on.
27739 * Start to play the video and cancel all suspend state.
27743 EAPI void elm_video_play(Evas_Object *video);
27746 * @brief Pause the video
27748 * @param video The video object to proceed the request on.
27750 * Pause the video and start a timer to trigger suspend mode.
27754 EAPI void elm_video_pause(Evas_Object *video);
27757 * @brief Stop the video
27759 * @param video The video object to proceed the request on.
27761 * Stop the video and put the emotion in deep sleep mode.
27765 EAPI void elm_video_stop(Evas_Object *video);
27768 * @brief Is the video actually playing.
27770 * @param video The video object to proceed the request on.
27771 * @return EINA_TRUE if the video is actually playing.
27773 * You should consider watching event on the object instead of polling
27774 * the object state.
27778 EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
27781 * @brief Is it possible to seek inside the video.
27783 * @param video The video object to proceed the request on.
27784 * @return EINA_TRUE if is possible to seek inside the video.
27788 EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
27791 * @brief Is the audio muted.
27793 * @param video The video object to proceed the request on.
27794 * @return EINA_TRUE if the audio is muted.
27798 EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
27801 * @brief Change the mute state of the Elm_Video object.
27803 * @param video The video object to proceed the request on.
27804 * @param mute The new mute state.
27808 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
27811 * @brief Get the audio level of the current video.
27813 * @param video The video object to proceed the request on.
27814 * @return the current audio level.
27818 EAPI double elm_video_audio_level_get(Evas_Object *video);
27821 * @brief Set the audio level of anElm_Video object.
27823 * @param video The video object to proceed the request on.
27824 * @param volume The new audio volume.
27828 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
27830 EAPI double elm_video_play_position_get(Evas_Object *video);
27831 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
27832 EAPI double elm_video_play_length_get(Evas_Object *video);
27833 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
27834 EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
27835 EAPI const char *elm_video_title_get(Evas_Object *video);
27841 * @defgroup Naviframe Naviframe
27842 * @ingroup Elementary
27844 * @brief Naviframe is a kind of view manager for the applications.
27846 * Naviframe provides functions to switch different pages with stack
27847 * mechanism. It means if one page(item) needs to be changed to the new one,
27848 * then naviframe would push the new page to it's internal stack. Of course,
27849 * it can be back to the previous page by popping the top page. Naviframe
27850 * provides some transition effect while the pages are switching (same as
27853 * Since each item could keep the different styles, users could keep the
27854 * same look & feel for the pages or different styles for the items in it's
27857 * Signals that you can add callback for are:
27859 * @li "transition,finished" - When the transition is finished in changing
27861 * @li "title,clicked" - User clicked title area
27863 * Default contents parts for the naviframe items that you can use for are:
27865 * @li "elm.swallow.content" - The main content of the page
27866 * @li "elm.swallow.prev_btn" - The button to go to the previous page
27867 * @li "elm.swallow.next_btn" - The button to go to the next page
27869 * Default text parts of naviframe items that you can be used are:
27871 * @li "elm.text.title" - The title label in the title area
27873 * @ref tutorial_naviframe gives a good overview of the usage of the API.
27877 * @addtogroup Naviframe
27882 * @brief Add a new Naviframe object to the parent.
27884 * @param parent Parent object
27885 * @return New object or @c NULL, if it cannot be created
27887 * @ingroup Naviframe
27889 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27891 * @brief Push a new item to the top of the naviframe stack (and show it).
27893 * @param obj The naviframe object
27894 * @param title_label The label in the title area. The name of the title
27895 * label part is "elm.text.title"
27896 * @param prev_btn The button to go to the previous item. If it is NULL,
27897 * then naviframe will create a back button automatically. The name of
27898 * the prev_btn part is "elm.swallow.prev_btn"
27899 * @param next_btn The button to go to the next item. Or It could be just an
27900 * extra function button. The name of the next_btn part is
27901 * "elm.swallow.next_btn"
27902 * @param content The main content object. The name of content part is
27903 * "elm.swallow.content"
27904 * @param item_style The current item style name. @c NULL would be default.
27905 * @return The created item or @c NULL upon failure.
27907 * The item pushed becomes one page of the naviframe, this item will be
27908 * deleted when it is popped.
27910 * @see also elm_naviframe_item_style_set()
27912 * The following styles are available for this item:
27915 * @ingroup Naviframe
27917 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);
27919 * @brief Pop an item that is on top of the stack
27921 * @param obj The naviframe object
27922 * @return @c NULL or the content object(if the
27923 * elm_naviframe_content_preserve_on_pop_get is true).
27925 * This pops an item that is on the top(visible) of the naviframe, makes it
27926 * disappear, then deletes the item. The item that was underneath it on the
27927 * stack will become visible.
27929 * @see also elm_naviframe_content_preserve_on_pop_get()
27931 * @ingroup Naviframe
27933 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
27935 * @brief Pop the items between the top and the above one on the given item.
27937 * @param it The naviframe item
27939 * @ingroup Naviframe
27941 EAPI void elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
27943 * @brief Delete the given item instantly.
27945 * @param it The naviframe item
27947 * This just deletes the given item from the naviframe item list instantly.
27948 * So this would not emit any signals for view transitions but just change
27949 * the current view if the given item is a top one.
27951 * @ingroup Naviframe
27953 EAPI void elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
27955 * @brief preserve the content objects when items are popped.
27957 * @param obj The naviframe object
27958 * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
27960 * @see also elm_naviframe_content_preserve_on_pop_get()
27962 * @ingroup Naviframe
27964 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
27966 * @brief Get a value whether preserve mode is enabled or not.
27968 * @param obj The naviframe object
27969 * @return If @c EINA_TRUE, preserve mode is enabled
27971 * @see also elm_naviframe_content_preserve_on_pop_set()
27973 * @ingroup Naviframe
27975 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27977 * @brief Get a top item on the naviframe stack
27979 * @param obj The naviframe object
27980 * @return The top item on the naviframe stack or @c NULL, if the stack is
27983 * @ingroup Naviframe
27985 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27987 * @brief Get a bottom item on the naviframe stack
27989 * @param obj The naviframe object
27990 * @return The bottom item on the naviframe stack or @c NULL, if the stack is
27993 * @ingroup Naviframe
27995 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27997 * @brief Set an item style
27999 * @param obj The naviframe item
28000 * @param item_style The current item style name. @c NULL would be default
28002 * The following styles are available for this item:
28005 * @see also elm_naviframe_item_style_get()
28007 * @ingroup Naviframe
28009 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
28011 * @brief Get an item style
28013 * @param obj The naviframe item
28014 * @return The current item style name
28016 * @see also elm_naviframe_item_style_set()
28018 * @ingroup Naviframe
28020 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28022 * @brief Show/Hide the title area
28024 * @param it The naviframe item
28025 * @param visible If @c EINA_TRUE, title area will be visible, hidden
28028 * When the title area is invisible, then the controls would be hidden so as * to expand the content area to full-size.
28030 * @see also elm_naviframe_item_title_visible_get()
28032 * @ingroup Naviframe
28034 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
28036 * @brief Get a value whether title area is visible or not.
28038 * @param it The naviframe item
28039 * @return If @c EINA_TRUE, title area is visible
28041 * @see also elm_naviframe_item_title_visible_set()
28043 * @ingroup Naviframe
28045 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);