3 * vim:ts=8:sw=3:sts=3:expandtab:cino=>5n-3f0^-2{2(0W1st0
8 @brief Elementary Widget Library
13 @image html elementary.png
17 @section intro What is Elementary?
19 This is a VERY SIMPLE toolkit. It is not meant for writing extensive desktop
20 applications (yet). Small simple ones with simple needs.
22 It is meant to make the programmers work almost brainless but give them lots
25 @li @ref Start - Go here to quickly get started with writing Apps
27 @section organization Organization
29 One can divide Elemementary into three main groups:
30 @li @ref infralist - These are modules that deal with Elementary as a whole.
31 @li @ref widgetslist - These are the widgets you'll compose your UI out of.
32 @li @ref containerslist - These are the containers which hold the widgets.
34 @section license License
36 LGPL v2 (see COPYING in the base of Elementary's source). This applies to
37 all files in the source tree.
39 @section ack Acknowledgements
40 There is a lot that goes into making a widget set, and they don't happen out of
41 nothing. It's like trying to make everyone everywhere happy, regardless of age,
42 gender, race or nationality - and that is really tough. So thanks to people and
43 organisations behind this, as listed in the @ref authors page.
48 * @defgroup Start Getting Started
50 * To write an Elementary app, you can get started with the following:
53 #include <Elementary.h>
55 elm_main(int argc, char **argv)
57 // create window(s) here and do any application init
58 elm_run(); // run main loop
59 elm_shutdown(); // after mainloop finishes running, shutdown
60 return 0; // exit 0 for exit code
65 * To use autotools (which helps in many ways in the long run, like being able
66 * to immediately create releases of your software directly from your tree
67 * and ensure everything needed to build it is there) you will need a
68 * configure.ac, Makefile.am and autogen.sh file.
73 AC_INIT(myapp, 0.0.0, myname@mydomain.com)
75 AC_CONFIG_SRCDIR(configure.ac)
76 AM_CONFIG_HEADER(config.h)
78 AM_INIT_AUTOMAKE(1.6 dist-bzip2)
79 PKG_CHECK_MODULES([ELEMENTARY], elementary)
86 AUTOMAKE_OPTIONS = 1.4 foreign
87 MAINTAINERCLEANFILES = Makefile.in aclocal.m4 config.h.in configure depcomp install-sh missing
89 INCLUDES = -I$(top_srcdir)
93 myapp_SOURCES = main.c
94 myapp_LDADD = @ELEMENTARY_LIBS@
95 myapp_CFLAGS = @ELEMENTARY_CFLAGS@
102 echo "Running aclocal..." ; aclocal $ACLOCAL_FLAGS || exit 1
103 echo "Running autoheader..." ; autoheader || exit 1
104 echo "Running autoconf..." ; autoconf || exit 1
105 echo "Running automake..." ; automake --add-missing --copy --gnu || exit 1
109 * To generate all the things needed to bootstrap just run:
115 * This will generate Makefile.in's, the confgure script and everything else.
116 * After this it works like all normal autotools projects:
123 * Note sudo was assumed to get root permissions, as this would install in
124 * /usr/local which is system-owned. Use any way you like to gain root, or
125 * specify a different prefix with configure:
128 ./confiugre --prefix=$HOME/mysoftware
131 * Also remember that autotools buys you some useful commands like:
136 * This uninstalls the software after it was installed with "make install".
137 * It is very useful to clear up what you built if you wish to clean the
144 * This firstly checks if your build tree is "clean" and ready for
145 * distribution. It also builds a tarball (myapp-0.0.0.tar.gz) that is
146 * ready to upload and distribute to the world, that contains the generated
147 * Makefile.in's and configure script. The users do not need to run
148 * autogen.sh - just configure and on. They don't need autotools installed.
149 * This tarball also builds cleanly, has all the sources it needs to build
150 * included (that is sources for your application, not libraries it depends
151 * on like Elementary). It builds cleanly in a buildroot and does not
152 * contain any files that are temporarily generated like binaries and other
153 * build-generated files, so the tarball is clean, and no need to worry
154 * about cleaning up your tree before packaging.
160 * This cleans up all build files (binaries, objects etc.) from the tree.
166 * This cleans out all files from the build and from configure's output too.
169 make maintainer-clean
172 * This deletes all the files autogen.sh will produce so the tree is clean
173 * to be put into a revision-control system (like CVS, SVN or GIT for example).
175 * There is a more advanced way of making use of the quicklaunch infrastructure
176 * in Elementary (which will not be covered here due to its more advanced
179 * Now let's actually create an interactive "Hello World" gui that you can
180 * click the ok button to exit. It's more code because this now does something
181 * much more significant, but it's still very simple:
184 #include <Elementary.h>
187 on_done(void *data, Evas_Object *obj, void *event_info)
189 // quit the mainloop (elm_run function will return)
194 elm_main(int argc, char **argv)
196 Evas_Object *win, *bg, *box, *lab, *btn;
198 // new window - do the usual and give it a name (hello) and title (Hello)
199 win = elm_win_util_standard_add("hello", "Hello");
200 // when the user clicks "close" on a window there is a request to delete
201 evas_object_smart_callback_add(win, "delete,request", on_done, NULL);
203 // add a box object - default is vertical. a box holds children in a row,
204 // either horizontally or vertically. nothing more.
205 box = elm_box_add(win);
206 // make the box hotizontal
207 elm_box_horizontal_set(box, EINA_TRUE);
208 // add object as a resize object for the window (controls window minimum
209 // size as well as gets resized if window is resized)
210 elm_win_resize_object_add(win, box);
211 evas_object_show(box);
213 // add a label widget, set the text and put it in the pad frame
214 lab = elm_label_add(win);
215 // set default text of the label
216 elm_object_text_set(lab, "Hello out there world!");
217 // pack the label at the end of the box
218 elm_box_pack_end(box, lab);
219 evas_object_show(lab);
222 btn = elm_button_add(win);
223 // set default text of button to "OK"
224 elm_object_text_set(btn, "OK");
225 // pack the button at the end of the box
226 elm_box_pack_end(box, btn);
227 evas_object_show(btn);
228 // call on_done when button is clicked
229 evas_object_smart_callback_add(btn, "clicked", on_done, NULL);
231 // now we are done, show the window
232 evas_object_show(win);
234 // run the mainloop and process events and callbacks
244 @page authors Authors
245 @author Carsten Haitzler <raster@@rasterman.com>
246 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
247 @author Cedric Bail <cedric.bail@@free.fr>
248 @author Vincent Torri <vtorri@@univ-evry.fr>
249 @author Daniel Kolesa <quaker66@@gmail.com>
250 @author Jaime Thomas <avi.thomas@@gmail.com>
251 @author Swisscom - http://www.swisscom.ch/
252 @author Christopher Michael <devilhorns@@comcast.net>
253 @author Marco Trevisan (TreviƱo) <mail@@3v1n0.net>
254 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
255 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
256 @author Brian Wang <brian.wang.0721@@gmail.com>
257 @author Mike Blumenkrantz (zmike) <mike@@zentific.com>
258 @author Samsung Electronics <tbd>
259 @author Samsung SAIT <tbd>
260 @author Brett Nash <nash@@nash.id.au>
261 @author Bruno Dilly <bdilly@@profusion.mobi>
262 @author Rafael Fonseca <rfonseca@@profusion.mobi>
263 @author Chuneon Park <hermet@@hermet.pe.kr>
264 @author Woohyun Jung <wh0705.jung@@samsung.com>
265 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
266 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
267 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
268 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
269 @author Gustavo Lima Chaves <glima@@profusion.mobi>
270 @author Fabiano FidĆŖncio <fidencio@@profusion.mobi>
271 @author Tiago FalcĆ£o <tiago@@profusion.mobi>
272 @author Otavio Pontes <otavio@@profusion.mobi>
273 @author Viktor Kojouharov <vkojouharov@@gmail.com>
274 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
275 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
276 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
277 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
278 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
279 @author Jihoon Kim <jihoon48.kim@@samsung.com>
280 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
281 @author Tom Hacohen <tom@@stosb.com>
282 @author Aharon Hillel <a.hillel@@partner.samsung.com>
283 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
284 @author Shinwoo Kim <kimcinoo@@gmail.com>
285 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
286 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
287 @author Sung W. Park <sungwoo@gmail.com>
288 @author Thierry el Borgi <thierry@substantiel.fr>
289 @author Shilpa Singh <shilpa.singh@samsung.com> <shilpasingh.o@gmail.com>
290 @author Chanwook Jung <joey.jung@samsung.com>
291 @author Hyoyoung Chang <hyoyoung.chang@samsung.com>
292 @author Guillaume "Kuri" Friloux <guillaume.friloux@asp64.com>
293 @author Kim Yunhan <spbear@gmail.com>
295 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
296 contact with the developers and maintainers.
304 * @brief Elementary's API
309 @ELM_UNIX_DEF@ ELM_UNIX
310 @ELM_WIN32_DEF@ ELM_WIN32
311 @ELM_WINCE_DEF@ ELM_WINCE
312 @ELM_EDBUS_DEF@ ELM_EDBUS
313 @ELM_EFREET_DEF@ ELM_EFREET
314 @ELM_ETHUMB_DEF@ ELM_ETHUMB
315 @ELM_WEB_DEF@ ELM_WEB
316 @ELM_EMAP_DEF@ ELM_EMAP
317 @ELM_DEBUG_DEF@ ELM_DEBUG
318 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
319 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
321 /* Standard headers for standard system calls etc. */
326 #include <sys/types.h>
327 #include <sys/stat.h>
328 #include <sys/time.h>
329 #include <sys/param.h>
341 # ifdef ELM_LIBINTL_H
342 # include <libintl.h>
353 #if defined (ELM_WIN32) || defined (ELM_WINCE)
356 # define alloca _alloca
367 #include <Ecore_Evas.h>
368 #include <Ecore_File.h>
369 #include <Ecore_IMF.h>
370 #include <Ecore_Con.h>
379 # include <Efreet_Mime.h>
380 # include <Efreet_Trash.h>
384 # include <Ethumb_Client.h>
396 # ifdef ELEMENTARY_BUILD
398 # define EAPI __declspec(dllexport)
401 # endif /* ! DLL_EXPORT */
403 # define EAPI __declspec(dllimport)
404 # endif /* ! EFL_EVAS_BUILD */
408 # define EAPI __attribute__ ((visibility("default")))
415 #endif /* ! _WIN32 */
420 # define EAPI_MAIN EAPI
423 /* allow usage from c++ */
428 #define ELM_VERSION_MAJOR @VMAJ@
429 #define ELM_VERSION_MINOR @VMIN@
431 typedef struct _Elm_Version
439 EAPI extern Elm_Version *elm_version;
442 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
443 #define ELM_PI 3.14159265358979323846
446 * @defgroup General General
448 * @brief General Elementary API. Functions that don't relate to
449 * Elementary objects specifically.
451 * Here are documented functions which init/shutdown the library,
452 * that apply to generic Elementary objects, that deal with
453 * configuration, et cetera.
455 * @ref general_functions_example_page "This" example contemplates
456 * some of these functions.
460 * @addtogroup General
465 * Defines couple of standard Evas_Object layers to be used
466 * with evas_object_layer_set().
468 * @note whenever extending with new values, try to keep some padding
469 * to siblings so there is room for further extensions.
471 typedef enum _Elm_Object_Layer
473 ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
474 ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
475 ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
476 ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
477 ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
478 ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
481 /**************************************************************************/
482 EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
485 * Emitted when the application has reconfigured elementary settings due
486 * to an external configuration tool asking it to.
488 EAPI extern int ELM_EVENT_CONFIG_ALL_CHANGED;
491 * Emitted when any Elementary's policy value is changed.
493 EAPI extern int ELM_EVENT_POLICY_CHANGED;
496 * @typedef Elm_Event_Policy_Changed
498 * Data on the event when an Elementary policy has changed
500 typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
503 * @struct _Elm_Event_Policy_Changed
505 * Data on the event when an Elementary policy has changed
507 struct _Elm_Event_Policy_Changed
509 unsigned int policy; /**< the policy identifier */
510 int new_value; /**< value the policy had before the change */
511 int old_value; /**< new value the policy got */
515 * Policy identifiers.
517 typedef enum _Elm_Policy
519 ELM_POLICY_QUIT, /**< under which circumstances the application
520 * should quit automatically. @see
524 } Elm_Policy; /**< Elementary policy identifiers/groups enumeration. @see elm_policy_set()
527 typedef enum _Elm_Policy_Quit
529 ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
531 ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
533 * window is closed */
534 } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
536 typedef enum _Elm_Focus_Direction
540 } Elm_Focus_Direction;
542 typedef enum _Elm_Text_Format
544 ELM_TEXT_FORMAT_PLAIN_UTF8,
545 ELM_TEXT_FORMAT_MARKUP_UTF8
549 * Line wrapping types.
551 typedef enum _Elm_Wrap_Type
553 ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
554 ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
555 ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
556 ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
562 ELM_INPUT_PANEL_LAYOUT_NORMAL, /**< Default layout */
563 ELM_INPUT_PANEL_LAYOUT_NUMBER, /**< Number layout */
564 ELM_INPUT_PANEL_LAYOUT_EMAIL, /**< Email layout */
565 ELM_INPUT_PANEL_LAYOUT_URL, /**< URL layout */
566 ELM_INPUT_PANEL_LAYOUT_PHONENUMBER, /**< Phone Number layout */
567 ELM_INPUT_PANEL_LAYOUT_IP, /**< IP layout */
568 ELM_INPUT_PANEL_LAYOUT_MONTH, /**< Month layout */
569 ELM_INPUT_PANEL_LAYOUT_NUMBERONLY, /**< Number Only layout */
570 ELM_INPUT_PANEL_LAYOUT_INVALID
571 } Elm_Input_Panel_Layout;
575 ELM_AUTOCAPITAL_TYPE_NONE,
576 ELM_AUTOCAPITAL_TYPE_WORD,
577 ELM_AUTOCAPITAL_TYPE_SENTENCE,
578 ELM_AUTOCAPITAL_TYPE_ALLCHARACTER,
579 } Elm_Autocapital_Type;
582 * @typedef Elm_Object_Item
583 * An Elementary Object item handle.
586 typedef struct _Elm_Object_Item Elm_Object_Item;
590 * Called back when a widget's tooltip is activated and needs content.
591 * @param data user-data given to elm_object_tooltip_content_cb_set()
592 * @param obj owner widget.
593 * @param tooltip The tooltip object (affix content to this!)
595 typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip);
598 * Called back when a widget's item tooltip is activated and needs content.
599 * @param data user-data given to elm_object_tooltip_content_cb_set()
600 * @param obj owner widget.
601 * @param tooltip The tooltip object (affix content to this!)
602 * @param item context dependent item. As an example, if tooltip was
603 * set on Elm_List_Item, then it is of this type.
605 typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
607 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. */
609 #ifndef ELM_LIB_QUICKLAUNCH
610 #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 */
612 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
615 /**************************************************************************/
619 * Initialize Elementary
621 * @param[in] argc System's argument count value
622 * @param[in] argv System's pointer to array of argument strings
623 * @return The init counter value.
625 * This function initializes Elementary and increments a counter of
626 * the number of calls to it. It returns the new counter's value.
628 * @warning This call is exported only for use by the @c ELM_MAIN()
629 * macro. There is no need to use this if you use this macro (which
630 * is highly advisable). An elm_main() should contain the entry
631 * point code for your application, having the same prototype as
632 * elm_init(), and @b not being static (putting the @c EAPI symbol
633 * in front of its type declaration is advisable). The @c
634 * ELM_MAIN() call should be placed just after it.
637 * @dontinclude bg_example_01.c
641 * See the full @ref bg_example_01_c "example".
643 * @see elm_shutdown().
646 EAPI int elm_init(int argc, char **argv);
649 * Shut down Elementary
651 * @return The init counter value.
653 * This should be called at the end of your application, just
654 * before it ceases to do any more processing. This will clean up
655 * any permanent resources your application may have allocated via
656 * Elementary that would otherwise persist.
658 * @see elm_init() for an example
662 EAPI int elm_shutdown(void);
665 * Run Elementary's main loop
667 * This call should be issued just after all initialization is
668 * completed. This function will not return until elm_exit() is
669 * called. It will keep looping, running the main
670 * (event/processing) loop for Elementary.
672 * @see elm_init() for an example
676 EAPI void elm_run(void);
679 * Exit Elementary's main loop
681 * If this call is issued, it will flag the main loop to cease
682 * processing and return back to its parent function (usually your
683 * elm_main() function).
685 * @see elm_init() for an example. There, just after a request to
686 * close the window comes, the main loop will be left.
688 * @note By using the appropriate #ELM_POLICY_QUIT on your Elementary
689 * applications, you'll be able to get this function called automatically for you.
693 EAPI void elm_exit(void);
696 * Provide information in order to make Elementary determine the @b
697 * run time location of the software in question, so other data files
698 * such as images, sound files, executable utilities, libraries,
699 * modules and locale files can be found.
701 * @param mainfunc This is your application's main function name,
702 * whose binary's location is to be found. Providing @c NULL
703 * will make Elementary not to use it
704 * @param dom This will be used as the application's "domain", in the
705 * form of a prefix to any environment variables that may
706 * override prefix detection and the directory name, inside the
707 * standard share or data directories, where the software's
708 * data files will be looked for.
709 * @param checkfile This is an (optional) magic file's path to check
710 * for existence (and it must be located in the data directory,
711 * under the share directory provided above). Its presence will
712 * help determine the prefix found was correct. Pass @c NULL if
713 * the check is not to be done.
715 * This function allows one to re-locate the application somewhere
716 * else after compilation, if the developer wishes for easier
717 * distribution of pre-compiled binaries.
719 * The prefix system is designed to locate where the given software is
720 * installed (under a common path prefix) at run time and then report
721 * specific locations of this prefix and common directories inside
722 * this prefix like the binary, library, data and locale directories,
723 * through the @c elm_app_*_get() family of functions.
725 * Call elm_app_info_set() early on before you change working
726 * directory or anything about @c argv[0], so it gets accurate
729 * It will then try and trace back which file @p mainfunc comes from,
730 * if provided, to determine the application's prefix directory.
732 * The @p dom parameter provides a string prefix to prepend before
733 * environment variables, allowing a fallback to @b specific
734 * environment variables to locate the software. You would most
735 * probably provide a lowercase string there, because it will also
736 * serve as directory domain, explained next. For environment
737 * variables purposes, this string is made uppercase. For example if
738 * @c "myapp" is provided as the prefix, then the program would expect
739 * @c "MYAPP_PREFIX" as a master environment variable to specify the
740 * exact install prefix for the software, or more specific environment
741 * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
742 * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
743 * the user or scripts before launching. If not provided (@c NULL),
744 * environment variables will not be used to override compiled-in
745 * defaults or auto detections.
747 * The @p dom string also provides a subdirectory inside the system
748 * shared data directory for data files. For example, if the system
749 * directory is @c /usr/local/share, then this directory name is
750 * appended, creating @c /usr/local/share/myapp, if it @p was @c
751 * "myapp". It is expected that the application installs data files in
754 * The @p checkfile is a file name or path of something inside the
755 * share or data directory to be used to test that the prefix
756 * detection worked. For example, your app will install a wallpaper
757 * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
758 * check that this worked, provide @c "images/wallpaper.jpg" as the @p
761 * @see elm_app_compile_bin_dir_set()
762 * @see elm_app_compile_lib_dir_set()
763 * @see elm_app_compile_data_dir_set()
764 * @see elm_app_compile_locale_set()
765 * @see elm_app_prefix_dir_get()
766 * @see elm_app_bin_dir_get()
767 * @see elm_app_lib_dir_get()
768 * @see elm_app_data_dir_get()
769 * @see elm_app_locale_dir_get()
771 EAPI void elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
774 * Provide information on the @b fallback application's binaries
775 * directory, in scenarios where they get overriden by
776 * elm_app_info_set().
778 * @param dir The path to the default binaries directory (compile time
781 * @note Elementary will as well use this path to determine actual
782 * names of binaries' directory paths, maybe changing it to be @c
783 * something/local/bin instead of @c something/bin, only, for
786 * @warning You should call this function @b before
787 * elm_app_info_set().
789 EAPI void elm_app_compile_bin_dir_set(const char *dir);
792 * Provide information on the @b fallback application's libraries
793 * directory, on scenarios where they get overriden by
794 * elm_app_info_set().
796 * @param dir The path to the default libraries directory (compile
799 * @note Elementary will as well use this path to determine actual
800 * names of libraries' directory paths, maybe changing it to be @c
801 * something/lib32 or @c something/lib64 instead of @c something/lib,
804 * @warning You should call this function @b before
805 * elm_app_info_set().
807 EAPI void elm_app_compile_lib_dir_set(const char *dir);
810 * Provide information on the @b fallback application's data
811 * directory, on scenarios where they get overriden by
812 * elm_app_info_set().
814 * @param dir The path to the default data directory (compile time
817 * @note Elementary will as well use this path to determine actual
818 * names of data directory paths, maybe changing it to be @c
819 * something/local/share instead of @c something/share, only, for
822 * @warning You should call this function @b before
823 * elm_app_info_set().
825 EAPI void elm_app_compile_data_dir_set(const char *dir);
828 * Provide information on the @b fallback application's locale
829 * directory, on scenarios where they get overriden by
830 * elm_app_info_set().
832 * @param dir The path to the default locale directory (compile time
835 * @warning You should call this function @b before
836 * elm_app_info_set().
838 EAPI void elm_app_compile_locale_set(const char *dir);
841 * Retrieve the application's run time prefix directory, as set by
842 * elm_app_info_set() and the way (environment) the application was
845 * @return The directory prefix the application is actually using.
847 EAPI const char *elm_app_prefix_dir_get(void);
850 * Retrieve the application's run time binaries prefix directory, as
851 * set by elm_app_info_set() and the way (environment) the application
854 * @return The binaries directory prefix the application is actually
857 EAPI const char *elm_app_bin_dir_get(void);
860 * Retrieve the application's run time libraries prefix directory, as
861 * set by elm_app_info_set() and the way (environment) the application
864 * @return The libraries directory prefix the application is actually
867 EAPI const char *elm_app_lib_dir_get(void);
870 * Retrieve the application's run time data prefix directory, as
871 * set by elm_app_info_set() and the way (environment) the application
874 * @return The data directory prefix the application is actually
877 EAPI const char *elm_app_data_dir_get(void);
880 * Retrieve the application's run time locale prefix directory, as
881 * set by elm_app_info_set() and the way (environment) the application
884 * @return The locale directory prefix the application is actually
887 EAPI const char *elm_app_locale_dir_get(void);
889 EAPI void elm_quicklaunch_mode_set(Eina_Bool ql_on);
890 EAPI Eina_Bool elm_quicklaunch_mode_get(void);
891 EAPI int elm_quicklaunch_init(int argc, char **argv);
892 EAPI int elm_quicklaunch_sub_init(int argc, char **argv);
893 EAPI int elm_quicklaunch_sub_shutdown(void);
894 EAPI int elm_quicklaunch_shutdown(void);
895 EAPI void elm_quicklaunch_seed(void);
896 EAPI Eina_Bool elm_quicklaunch_prepare(int argc, char **argv);
897 EAPI Eina_Bool elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
898 EAPI void elm_quicklaunch_cleanup(void);
899 EAPI int elm_quicklaunch_fallback(int argc, char **argv);
900 EAPI char *elm_quicklaunch_exe_path_get(const char *exe);
902 EAPI Eina_Bool elm_need_efreet(void);
903 EAPI Eina_Bool elm_need_e_dbus(void);
906 * This must be called before any other function that deals with
907 * elm_thumb objects or ethumb_client instances.
911 EAPI Eina_Bool elm_need_ethumb(void);
914 * This must be called before any other function that deals with
915 * elm_web objects or ewk_view instances.
919 EAPI Eina_Bool elm_need_web(void);
922 * Set a new policy's value (for a given policy group/identifier).
924 * @param policy policy identifier, as in @ref Elm_Policy.
925 * @param value policy value, which depends on the identifier
927 * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
929 * Elementary policies define applications' behavior,
930 * somehow. These behaviors are divided in policy groups (see
931 * #Elm_Policy enumeration). This call will emit the Ecore event
932 * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
933 * handlers. An #Elm_Event_Policy_Changed struct will be passed,
936 * @note Currently, we have only one policy identifier/group
937 * (#ELM_POLICY_QUIT), which has two possible values.
941 EAPI Eina_Bool elm_policy_set(unsigned int policy, int value);
944 * Gets the policy value for given policy identifier.
946 * @param policy policy identifier, as in #Elm_Policy.
947 * @return The currently set policy value, for that
948 * identifier. Will be @c 0 if @p policy passed is invalid.
952 EAPI int elm_policy_get(unsigned int policy);
955 * Change the language of the current application
957 * The @p lang passed must be the full name of the locale to use, for
958 * example "en_US.utf8" or "es_ES@euro".
960 * Changing language with this function will make Elementary run through
961 * all its widgets, translating strings set with
962 * elm_object_domain_translatable_text_part_set(). This way, an entire
963 * UI can have its language changed without having to restart the program.
965 * For more complex cases, like having formatted strings that need
966 * translation, widgets will also emit a "language,changed" signal that
967 * the user can listen to to manually translate the text.
969 * @param lang Language to set, must be the full name of the locale
973 EAPI void elm_language_set(const char *lang);
976 * Set a label of an object
978 * @param obj The Elementary object
979 * @param part The text part name to set (NULL for the default label)
980 * @param label The new text of the label
982 * @note Elementary objects may have many labels (e.g. Action Slider)
986 EAPI void elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
988 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
991 * Get a label of an object
993 * @param obj The Elementary object
994 * @param part The text part name to get (NULL for the default label)
995 * @return text of the label or NULL for any error
997 * @note Elementary objects may have many labels (e.g. Action Slider)
1001 EAPI const char *elm_object_text_part_get(const Evas_Object *obj, const char *part);
1003 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
1006 * Set the text for an objects' part, marking it as translatable.
1008 * The string to set as @p text must be the original one. Do not pass the
1009 * return of @c gettext() here. Elementary will translate the string
1010 * internally and set it on the object using elm_object_text_part_set(),
1011 * also storing the original string so that it can be automatically
1012 * translated when the language is changed with elm_language_set().
1014 * The @p domain will be stored along to find the translation in the
1015 * correct catalog. It can be NULL, in which case it will use whatever
1016 * domain was set by the application with @c textdomain(). This is useful
1017 * in case you are building a library on top of Elementary that will have
1018 * its own translatable strings, that should not be mixed with those of
1019 * programs using the library.
1021 * @param obj The object containing the text part
1022 * @param part The name of the part to set
1023 * @param domain The translation domain to use
1024 * @param text The original, non-translated text to set
1028 EAPI void elm_object_domain_translatable_text_part_set(Evas_Object *obj, const char *part, const char *domain, const char *text);
1030 #define elm_object_domain_translatable_text_set(obj, domain, text) elm_object_domain_translatable_text_part_set((obj), NULL, (domain), (text))
1032 #define elm_object_translatable_text_set(obj, text) elm_object_domain_translatable_text_part_set((obj), NULL, NULL, (text))
1035 * Gets the original string set as translatable for an object
1037 * When setting translated strings, the function elm_object_text_part_get()
1038 * will return the translation returned by @c gettext(). To get the
1039 * original string use this function.
1041 * @param obj The object
1042 * @param part The name of the part that was set
1044 * @return The original, untranslated string
1048 EAPI const char *elm_object_translatable_text_part_get(const Evas_Object *obj, const char *part);
1050 #define elm_object_translatable_text_get(obj) elm_object_translatable_text_part_get((obj), NULL)
1053 * Set a content of an object
1055 * @param obj The Elementary object
1056 * @param part The content part name to set (NULL for the default content)
1057 * @param content The new content of the object
1059 * @note Elementary objects may have many contents
1063 EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
1065 #define elm_object_content_set(obj, content) elm_object_content_part_set((obj), NULL, (content))
1068 * Get a content of an object
1070 * @param obj The Elementary object
1071 * @param item The content part name to get (NULL for the default content)
1072 * @return content of the object or NULL for any error
1074 * @note Elementary objects may have many contents
1078 EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
1080 #define elm_object_content_get(obj) elm_object_content_part_get((obj), NULL)
1083 * Unset a content of an object
1085 * @param obj The Elementary object
1086 * @param item The content part name to unset (NULL for the default content)
1088 * @note Elementary objects may have many contents
1092 EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
1094 #define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
1097 * Get the widget object's handle which contains a given item
1099 * @param item The Elementary object item
1100 * @return The widget object
1102 * @note This returns the widget object itself that an item belongs to.
1106 EAPI Evas_Object *elm_object_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1109 * Set a content of an object item
1111 * @param it The Elementary object item
1112 * @param part The content part name to set (NULL for the default content)
1113 * @param content The new content of the object item
1115 * @note Elementary object items may have many contents
1119 EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1121 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
1124 * Get a content of an object item
1126 * @param it The Elementary object item
1127 * @param part The content part name to unset (NULL for the default content)
1128 * @return content of the object item or NULL for any error
1130 * @note Elementary object items may have many contents
1134 EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *part);
1136 #define elm_object_item_content_get(it) elm_object_item_content_part_get((it), NULL)
1139 * Unset a content of an object item
1141 * @param it The Elementary object item
1142 * @param part The content part name to unset (NULL for the default content)
1144 * @note Elementary object items may have many contents
1148 EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1150 #define elm_object_item_content_unset(it) elm_object_item_content_part_unset((it), NULL)
1153 * Set a label of an object item
1155 * @param it The Elementary object item
1156 * @param part The text part name to set (NULL for the default label)
1157 * @param label The new text of the label
1159 * @note Elementary object items may have many labels
1163 EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1165 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
1168 * Get a label of an object item
1170 * @param it The Elementary object item
1171 * @param part The text part name to get (NULL for the default label)
1172 * @return text of the label or NULL for any error
1174 * @note Elementary object items may have many labels
1178 EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1180 #define elm_object_item_text_get(it) elm_object_item_text_part_get((it), NULL)
1183 * Set the text to read out when in accessibility mode
1185 * @param obj The object which is to be described
1186 * @param txt The text that describes the widget to people with poor or no vision
1190 EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1193 * Set the text to read out when in accessibility mode
1195 * @param it The object item which is to be described
1196 * @param txt The text that describes the widget to people with poor or no vision
1200 EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1203 * Get the data associated with an object item
1204 * @param it The object item
1205 * @return The data associated with @p it
1209 EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
1212 * Set the data associated with an object item
1213 * @param it The object item
1214 * @param data The data to be associated with @p it
1218 EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
1221 * Send a signal to the edje object of the widget item.
1223 * This function sends a signal to the edje object of the obj item. An
1224 * edje program can respond to a signal by specifying matching
1225 * 'signal' and 'source' fields.
1227 * @param it The Elementary object item
1228 * @param emission The signal's name.
1229 * @param source The signal's source.
1232 EAPI void elm_object_item_signal_emit(Elm_Object_Item *it, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1239 * @defgroup Caches Caches
1241 * These are functions which let one fine-tune some cache values for
1242 * Elementary applications, thus allowing for performance adjustments.
1248 * @brief Flush all caches.
1250 * Frees all data that was in cache and is not currently being used to reduce
1251 * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1252 * to calling all of the following functions:
1253 * @li edje_file_cache_flush()
1254 * @li edje_collection_cache_flush()
1255 * @li eet_clearcache()
1256 * @li evas_image_cache_flush()
1257 * @li evas_font_cache_flush()
1258 * @li evas_render_dump()
1259 * @note Evas caches are flushed for every canvas associated with a window.
1263 EAPI void elm_all_flush(void);
1266 * Get the configured cache flush interval time
1268 * This gets the globally configured cache flush interval time, in
1271 * @return The cache flush interval time
1274 * @see elm_all_flush()
1276 EAPI int elm_cache_flush_interval_get(void);
1279 * Set the configured cache flush interval time
1281 * This sets the globally configured cache flush interval time, in ticks
1283 * @param size The cache flush interval time
1286 * @see elm_all_flush()
1288 EAPI void elm_cache_flush_interval_set(int size);
1291 * Set the configured cache flush interval time for all applications on the
1294 * This sets the globally configured cache flush interval time -- in ticks
1295 * -- for all applications on the display.
1297 * @param size The cache flush interval time
1300 EAPI void elm_cache_flush_interval_all_set(int size);
1303 * Get the configured cache flush enabled state
1305 * This gets the globally configured cache flush state - if it is enabled
1306 * or not. When cache flushing is enabled, elementary will regularly
1307 * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1308 * memory and allow usage to re-seed caches and data in memory where it
1309 * can do so. An idle application will thus minimise its memory usage as
1310 * data will be freed from memory and not be re-loaded as it is idle and
1311 * not rendering or doing anything graphically right now.
1313 * @return The cache flush state
1316 * @see elm_all_flush()
1318 EAPI Eina_Bool elm_cache_flush_enabled_get(void);
1321 * Set the configured cache flush enabled state
1323 * This sets the globally configured cache flush enabled state.
1325 * @param size The cache flush enabled state
1328 * @see elm_all_flush()
1330 EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
1333 * Set the configured cache flush enabled state for all applications on the
1336 * This sets the globally configured cache flush enabled state for all
1337 * applications on the display.
1339 * @param size The cache flush enabled state
1342 EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1345 * Get the configured font cache size
1347 * This gets the globally configured font cache size, in bytes.
1349 * @return The font cache size
1352 EAPI int elm_font_cache_get(void);
1355 * Set the configured font cache size
1357 * This sets the globally configured font cache size, in bytes
1359 * @param size The font cache size
1362 EAPI void elm_font_cache_set(int size);
1365 * Set the configured font cache size for all applications on the
1368 * This sets the globally configured font cache size -- in bytes
1369 * -- for all applications on the display.
1371 * @param size The font cache size
1374 EAPI void elm_font_cache_all_set(int size);
1377 * Get the configured image cache size
1379 * This gets the globally configured image cache size, in bytes
1381 * @return The image cache size
1384 EAPI int elm_image_cache_get(void);
1387 * Set the configured image cache size
1389 * This sets the globally configured image cache size, in bytes
1391 * @param size The image cache size
1394 EAPI void elm_image_cache_set(int size);
1397 * Set the configured image cache size for all applications on the
1400 * This sets the globally configured image cache size -- in bytes
1401 * -- for all applications on the display.
1403 * @param size The image cache size
1406 EAPI void elm_image_cache_all_set(int size);
1409 * Get the configured edje file cache size.
1411 * This gets the globally configured edje file cache size, in number
1414 * @return The edje file cache size
1417 EAPI int elm_edje_file_cache_get(void);
1420 * Set the configured edje file cache size
1422 * This sets the globally configured edje file cache size, in number
1425 * @param size The edje file cache size
1428 EAPI void elm_edje_file_cache_set(int size);
1431 * Set the configured edje file cache size for all applications on the
1434 * This sets the globally configured edje file cache size -- in number
1435 * of files -- for all applications on the display.
1437 * @param size The edje file cache size
1440 EAPI void elm_edje_file_cache_all_set(int size);
1443 * Get the configured edje collections (groups) cache size.
1445 * This gets the globally configured edje collections cache size, in
1446 * number of collections.
1448 * @return The edje collections cache size
1451 EAPI int elm_edje_collection_cache_get(void);
1454 * Set the configured edje collections (groups) cache size
1456 * This sets the globally configured edje collections cache size, in
1457 * number of collections.
1459 * @param size The edje collections cache size
1462 EAPI void elm_edje_collection_cache_set(int size);
1465 * Set the configured edje collections (groups) cache size for all
1466 * applications on the display
1468 * This sets the globally configured edje collections cache size -- in
1469 * number of collections -- for all applications on the display.
1471 * @param size The edje collections cache size
1474 EAPI void elm_edje_collection_cache_all_set(int size);
1481 * @defgroup Scaling Widget Scaling
1483 * Different widgets can be scaled independently. These functions
1484 * allow you to manipulate this scaling on a per-widget basis. The
1485 * object and all its children get their scaling factors multiplied
1486 * by the scale factor set. This is multiplicative, in that if a
1487 * child also has a scale size set it is in turn multiplied by its
1488 * parent's scale size. @c 1.0 means ādon't scaleā, @c 2.0 is
1489 * double size, @c 0.5 is half, etc.
1491 * @ref general_functions_example_page "This" example contemplates
1492 * some of these functions.
1496 * Get the global scaling factor
1498 * This gets the globally configured scaling factor that is applied to all
1501 * @return The scaling factor
1504 EAPI double elm_scale_get(void);
1507 * Set the global scaling factor
1509 * This sets the globally configured scaling factor that is applied to all
1512 * @param scale The scaling factor to set
1515 EAPI void elm_scale_set(double scale);
1518 * Set the global scaling factor for all applications on the display
1520 * This sets the globally configured scaling factor that is applied to all
1521 * objects for all applications.
1522 * @param scale The scaling factor to set
1525 EAPI void elm_scale_all_set(double scale);
1528 * Set the scaling factor for a given Elementary object
1530 * @param obj The Elementary to operate on
1531 * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1536 EAPI void elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1539 * Get the scaling factor for a given Elementary object
1541 * @param obj The object
1542 * @return The scaling factor set by elm_object_scale_set()
1546 EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1549 * @defgroup Password_last_show Password last input show
1551 * Last show feature of password mode enables user to view
1552 * the last input entered for few seconds before masking it.
1553 * These functions allow to set this feature in password mode
1554 * of entry widget and also allow to manipulate the duration
1555 * for which the input has to be visible.
1561 * Get show last setting of password mode.
1563 * This gets the show last input setting of password mode which might be
1564 * enabled or disabled.
1566 * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1568 * @ingroup Password_last_show
1570 EAPI Eina_Bool elm_password_show_last_get(void);
1573 * Set show last setting in password mode.
1575 * This enables or disables show last setting of password mode.
1577 * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1578 * @see elm_password_show_last_timeout_set()
1579 * @ingroup Password_last_show
1581 EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1584 * Get's the timeout value in last show password mode.
1586 * This gets the time out value for which the last input entered in password
1587 * mode will be visible.
1589 * @return The timeout value of last show password mode.
1590 * @ingroup Password_last_show
1592 EAPI double elm_password_show_last_timeout_get(void);
1595 * Set's the timeout value in last show password mode.
1597 * This sets the time out value for which the last input entered in password
1598 * mode will be visible.
1600 * @param password_show_last_timeout The timeout value.
1601 * @see elm_password_show_last_set()
1602 * @ingroup Password_last_show
1604 EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1611 * @defgroup UI-Mirroring Selective Widget mirroring
1613 * These functions allow you to set ui-mirroring on specific
1614 * widgets or the whole interface. Widgets can be in one of two
1615 * modes, automatic and manual. Automatic means they'll be changed
1616 * according to the system mirroring mode and manual means only
1617 * explicit changes will matter. You are not supposed to change
1618 * mirroring state of a widget set to automatic, will mostly work,
1619 * but the behavior is not really defined.
1624 EAPI Eina_Bool elm_mirrored_get(void);
1625 EAPI void elm_mirrored_set(Eina_Bool mirrored);
1628 * Get the system mirrored mode. This determines the default mirrored mode
1631 * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1633 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1636 * Set the system mirrored mode. This determines the default mirrored mode
1639 * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1641 EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1644 * Returns the widget's mirrored mode setting.
1646 * @param obj The widget.
1647 * @return mirrored mode setting of the object.
1650 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1653 * Sets the widget's mirrored mode setting.
1654 * When widget in automatic mode, it follows the system mirrored mode set by
1655 * elm_mirrored_set().
1656 * @param obj The widget.
1657 * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1659 EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1666 * Set the style to use by a widget
1668 * Sets the style name that will define the appearance of a widget. Styles
1669 * vary from widget to widget and may also be defined by other themes
1670 * by means of extensions and overlays.
1672 * @param obj The Elementary widget to style
1673 * @param style The style name to use
1675 * @see elm_theme_extension_add()
1676 * @see elm_theme_extension_del()
1677 * @see elm_theme_overlay_add()
1678 * @see elm_theme_overlay_del()
1682 EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1684 * Get the style used by the widget
1686 * This gets the style being used for that widget. Note that the string
1687 * pointer is only valid as longas the object is valid and the style doesn't
1690 * @param obj The Elementary widget to query for its style
1691 * @return The style name used
1693 * @see elm_object_style_set()
1697 EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1700 * @defgroup Styles Styles
1702 * Widgets can have different styles of look. These generic API's
1703 * set styles of widgets, if they support them (and if the theme(s)
1706 * @ref general_functions_example_page "This" example contemplates
1707 * some of these functions.
1711 * Set the disabled state of an Elementary object.
1713 * @param obj The Elementary object to operate on
1714 * @param disabled The state to put in in: @c EINA_TRUE for
1715 * disabled, @c EINA_FALSE for enabled
1717 * Elementary objects can be @b disabled, in which state they won't
1718 * receive input and, in general, will be themed differently from
1719 * their normal state, usually greyed out. Useful for contexts
1720 * where you don't want your users to interact with some of the
1721 * parts of you interface.
1723 * This sets the state for the widget, either disabling it or
1728 EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1731 * Get the disabled state of an Elementary object.
1733 * @param obj The Elementary object to operate on
1734 * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1735 * if it's enabled (or on errors)
1737 * This gets the state of the widget, which might be enabled or disabled.
1741 EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1744 * @defgroup WidgetNavigation Widget Tree Navigation.
1746 * How to check if an Evas Object is an Elementary widget? How to
1747 * get the first elementary widget that is parent of the given
1748 * object? These are all covered in widget tree navigation.
1750 * @ref general_functions_example_page "This" example contemplates
1751 * some of these functions.
1755 * Check if the given Evas Object is an Elementary widget.
1757 * @param obj the object to query.
1758 * @return @c EINA_TRUE if it is an elementary widget variant,
1759 * @c EINA_FALSE otherwise
1760 * @ingroup WidgetNavigation
1762 EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1765 * Get the first parent of the given object that is an Elementary
1768 * @param obj the Elementary object to query parent from.
1769 * @return the parent object that is an Elementary widget, or @c
1770 * NULL, if it was not found.
1772 * Use this to query for an object's parent widget.
1774 * @note Most of Elementary users wouldn't be mixing non-Elementary
1775 * smart objects in the objects tree of an application, as this is
1776 * an advanced usage of Elementary with Evas. So, except for the
1777 * application's window, which is the root of that tree, all other
1778 * objects would have valid Elementary widget parents.
1780 * @ingroup WidgetNavigation
1782 EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1785 * Get the top level parent of an Elementary widget.
1787 * @param obj The object to query.
1788 * @return The top level Elementary widget, or @c NULL if parent cannot be
1790 * @ingroup WidgetNavigation
1792 EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1795 * Get the string that represents this Elementary widget.
1797 * @note Elementary is weird and exposes itself as a single
1798 * Evas_Object_Smart_Class of type "elm_widget", so
1799 * evas_object_type_get() always return that, making debug and
1800 * language bindings hard. This function tries to mitigate this
1801 * problem, but the solution is to change Elementary to use
1802 * proper inheritance.
1804 * @param obj the object to query.
1805 * @return Elementary widget name, or @c NULL if not a valid widget.
1806 * @ingroup WidgetNavigation
1808 EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1811 * @defgroup Config Elementary Config
1813 * Elementary configuration is formed by a set options bounded to a
1814 * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1815 * "finger size", etc. These are functions with which one syncronizes
1816 * changes made to those values to the configuration storing files, de
1817 * facto. You most probably don't want to use the functions in this
1818 * group unlees you're writing an elementary configuration manager.
1824 * Save back Elementary's configuration, so that it will persist on
1827 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1830 * This function will take effect -- thus, do I/O -- immediately. Use
1831 * it when you want to apply all configuration changes at once. The
1832 * current configuration set will get saved onto the current profile
1833 * configuration file.
1836 EAPI Eina_Bool elm_config_save(void);
1839 * Reload Elementary's configuration, bounded to current selected
1842 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1845 * Useful when you want to force reloading of configuration values for
1846 * a profile. If one removes user custom configuration directories,
1847 * for example, it will force a reload with system values insted.
1850 EAPI void elm_config_reload(void);
1857 * @defgroup Profile Elementary Profile
1859 * Profiles are pre-set options that affect the whole look-and-feel of
1860 * Elementary-based applications. There are, for example, profiles
1861 * aimed at desktop computer applications and others aimed at mobile,
1862 * touchscreen-based ones. You most probably don't want to use the
1863 * functions in this group unlees you're writing an elementary
1864 * configuration manager.
1870 * Get Elementary's profile in use.
1872 * This gets the global profile that is applied to all Elementary
1875 * @return The profile's name
1878 EAPI const char *elm_profile_current_get(void);
1881 * Get an Elementary's profile directory path in the filesystem. One
1882 * may want to fetch a system profile's dir or an user one (fetched
1885 * @param profile The profile's name
1886 * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
1887 * or a system one (@c EINA_FALSE)
1888 * @return The profile's directory path.
1891 * @note You must free it with elm_profile_dir_free().
1893 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1896 * Free an Elementary's profile directory path, as returned by
1897 * elm_profile_dir_get().
1899 * @param p_dir The profile's path
1903 EAPI void elm_profile_dir_free(const char *p_dir);
1906 * Get Elementary's list of available profiles.
1908 * @return The profiles list. List node data are the profile name
1912 * @note One must free this list, after usage, with the function
1913 * elm_profile_list_free().
1915 EAPI Eina_List *elm_profile_list_get(void);
1918 * Free Elementary's list of available profiles.
1920 * @param l The profiles list, as returned by elm_profile_list_get().
1924 EAPI void elm_profile_list_free(Eina_List *l);
1927 * Set Elementary's profile.
1929 * This sets the global profile that is applied to Elementary
1930 * applications. Just the process the call comes from will be
1933 * @param profile The profile's name
1937 EAPI void elm_profile_set(const char *profile);
1940 * Set Elementary's profile.
1942 * This sets the global profile that is applied to all Elementary
1943 * applications. All running Elementary windows will be affected.
1945 * @param profile The profile's name
1949 EAPI void elm_profile_all_set(const char *profile);
1956 * @defgroup Engine Elementary Engine
1958 * These are functions setting and querying which rendering engine
1959 * Elementary will use for drawing its windows' pixels.
1961 * The following are the available engines:
1962 * @li "software_x11"
1965 * @li "software_16_x11"
1966 * @li "software_8_x11"
1969 * @li "software_gdi"
1970 * @li "software_16_wince_gdi"
1972 * @li "software_16_sdl"
1976 * @li "opengl_cocoa"
1983 * @brief Get Elementary's rendering engine in use.
1985 * @return The rendering engine's name
1986 * @note there's no need to free the returned string, here.
1988 * This gets the global rendering engine that is applied to all Elementary
1991 * @see elm_engine_set()
1993 EAPI const char *elm_engine_current_get(void);
1996 * @brief Set Elementary's rendering engine for use.
1998 * @param engine The rendering engine's name
2000 * This sets global rendering engine that is applied to all Elementary
2001 * applications. Note that it will take effect only to Elementary windows
2002 * created after this is called.
2004 * @see elm_win_add()
2006 EAPI void elm_engine_set(const char *engine);
2013 * @defgroup Fonts Elementary Fonts
2015 * These are functions dealing with font rendering, selection and the
2016 * like for Elementary applications. One might fetch which system
2017 * fonts are there to use and set custom fonts for individual classes
2018 * of UI items containing text (text classes).
2023 typedef struct _Elm_Text_Class
2029 typedef struct _Elm_Font_Overlay
2031 const char *text_class;
2033 Evas_Font_Size size;
2036 typedef struct _Elm_Font_Properties
2040 } Elm_Font_Properties;
2043 * Get Elementary's list of supported text classes.
2045 * @return The text classes list, with @c Elm_Text_Class blobs as data.
2048 * Release the list with elm_text_classes_list_free().
2050 EAPI const Eina_List *elm_text_classes_list_get(void);
2053 * Free Elementary's list of supported text classes.
2057 * @see elm_text_classes_list_get().
2059 EAPI void elm_text_classes_list_free(const Eina_List *list);
2062 * Get Elementary's list of font overlays, set with
2063 * elm_font_overlay_set().
2065 * @return The font overlays list, with @c Elm_Font_Overlay blobs as
2070 * For each text class, one can set a <b>font overlay</b> for it,
2071 * overriding the default font properties for that class coming from
2072 * the theme in use. There is no need to free this list.
2074 * @see elm_font_overlay_set() and elm_font_overlay_unset().
2076 EAPI const Eina_List *elm_font_overlay_list_get(void);
2079 * Set a font overlay for a given Elementary text class.
2081 * @param text_class Text class name
2082 * @param font Font name and style string
2083 * @param size Font size
2087 * @p font has to be in the format returned by
2088 * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
2089 * and elm_font_overlay_unset().
2091 EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
2094 * Unset a font overlay for a given Elementary text class.
2096 * @param text_class Text class name
2100 * This will bring back text elements belonging to text class
2101 * @p text_class back to their default font settings.
2103 EAPI void elm_font_overlay_unset(const char *text_class);
2106 * Apply the changes made with elm_font_overlay_set() and
2107 * elm_font_overlay_unset() on the current Elementary window.
2111 * This applies all font overlays set to all objects in the UI.
2113 EAPI void elm_font_overlay_apply(void);
2116 * Apply the changes made with elm_font_overlay_set() and
2117 * elm_font_overlay_unset() on all Elementary application windows.
2121 * This applies all font overlays set to all objects in the UI.
2123 EAPI void elm_font_overlay_all_apply(void);
2126 * Translate a font (family) name string in fontconfig's font names
2127 * syntax into an @c Elm_Font_Properties struct.
2129 * @param font The font name and styles string
2130 * @return the font properties struct
2134 * @note The reverse translation can be achived with
2135 * elm_font_fontconfig_name_get(), for one style only (single font
2136 * instance, not family).
2138 EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
2141 * Free font properties return by elm_font_properties_get().
2143 * @param efp the font properties struct
2147 EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
2150 * Translate a font name, bound to a style, into fontconfig's font names
2153 * @param name The font (family) name
2154 * @param style The given style (may be @c NULL)
2156 * @return the font name and style string
2160 * @note The reverse translation can be achived with
2161 * elm_font_properties_get(), for one style only (single font
2162 * instance, not family).
2164 EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
2167 * Free the font string return by elm_font_fontconfig_name_get().
2169 * @param efp the font properties struct
2173 EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
2176 * Create a font hash table of available system fonts.
2178 * One must call it with @p list being the return value of
2179 * evas_font_available_list(). The hash will be indexed by font
2180 * (family) names, being its values @c Elm_Font_Properties blobs.
2182 * @param list The list of available system fonts, as returned by
2183 * evas_font_available_list().
2184 * @return the font hash.
2188 * @note The user is supposed to get it populated at least with 3
2189 * default font families (Sans, Serif, Monospace), which should be
2190 * present on most systems.
2192 EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
2195 * Free the hash return by elm_font_available_hash_add().
2197 * @param hash the hash to be freed.
2201 EAPI void elm_font_available_hash_del(Eina_Hash *hash);
2208 * @defgroup Fingers Fingers
2210 * Elementary is designed to be finger-friendly for touchscreens,
2211 * and so in addition to scaling for display resolution, it can
2212 * also scale based on finger "resolution" (or size). You can then
2213 * customize the granularity of the areas meant to receive clicks
2216 * Different profiles may have pre-set values for finger sizes.
2218 * @ref general_functions_example_page "This" example contemplates
2219 * some of these functions.
2225 * Get the configured "finger size"
2227 * @return The finger size
2229 * This gets the globally configured finger size, <b>in pixels</b>
2233 EAPI Evas_Coord elm_finger_size_get(void);
2236 * Set the configured finger size
2238 * This sets the globally configured finger size in pixels
2240 * @param size The finger size
2243 EAPI void elm_finger_size_set(Evas_Coord size);
2246 * Set the configured finger size for all applications on the display
2248 * This sets the globally configured finger size in pixels for all
2249 * applications on the display
2251 * @param size The finger size
2254 EAPI void elm_finger_size_all_set(Evas_Coord size);
2261 * @defgroup Focus Focus
2263 * An Elementary application has, at all times, one (and only one)
2264 * @b focused object. This is what determines where the input
2265 * events go to within the application's window. Also, focused
2266 * objects can be decorated differently, in order to signal to the
2267 * user where the input is, at a given moment.
2269 * Elementary applications also have the concept of <b>focus
2270 * chain</b>: one can cycle through all the windows' focusable
2271 * objects by input (tab key) or programmatically. The default
2272 * focus chain for an application is the one define by the order in
2273 * which the widgets where added in code. One will cycle through
2274 * top level widgets, and, for each one containg sub-objects, cycle
2275 * through them all, before returning to the level
2276 * above. Elementary also allows one to set @b custom focus chains
2277 * for their applications.
2279 * Besides the focused decoration a widget may exhibit, when it
2280 * gets focus, Elementary has a @b global focus highlight object
2281 * that can be enabled for a window. If one chooses to do so, this
2282 * extra highlight effect will surround the current focused object,
2285 * @note Some Elementary widgets are @b unfocusable, after
2286 * creation, by their very nature: they are not meant to be
2287 * interacted with input events, but are there just for visual
2290 * @ref general_functions_example_page "This" example contemplates
2291 * some of these functions.
2295 * Get the enable status of the focus highlight
2297 * This gets whether the highlight on focused objects is enabled or not
2300 EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
2303 * Set the enable status of the focus highlight
2305 * Set whether to show or not the highlight on focused objects
2306 * @param enable Enable highlight if EINA_TRUE, disable otherwise
2309 EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
2312 * Get the enable status of the highlight animation
2314 * Get whether the focus highlight, if enabled, will animate its switch from
2315 * one object to the next
2318 EAPI Eina_Bool elm_focus_highlight_animate_get(void);
2321 * Set the enable status of the highlight animation
2323 * Set whether the focus highlight, if enabled, will animate its switch from
2324 * one object to the next
2325 * @param animate Enable animation if EINA_TRUE, disable otherwise
2328 EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
2331 * Get the whether an Elementary object has the focus or not.
2333 * @param obj The Elementary object to get the information from
2334 * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2335 * not (and on errors).
2337 * @see elm_object_focus_set()
2341 EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2344 * Set/unset focus to a given Elementary object.
2346 * @param obj The Elementary object to operate on.
2347 * @param enable @c EINA_TRUE Set focus to a given object,
2348 * @c EINA_FALSE Unset focus to a given object.
2350 * @note When you set focus to this object, if it can handle focus, will
2351 * take the focus away from the one who had it previously and will, for
2352 * now on, be the one receiving input events. Unsetting focus will remove
2353 * the focus from @p obj, passing it back to the previous element in the
2356 * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2360 EAPI void elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2363 * Make a given Elementary object the focused one.
2365 * @param obj The Elementary object to make focused.
2367 * @note This object, if it can handle focus, will take the focus
2368 * away from the one who had it previously and will, for now on, be
2369 * the one receiving input events.
2371 * @see elm_object_focus_get()
2372 * @deprecated use elm_object_focus_set() instead.
2376 EINA_DEPRECATED EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2379 * Remove the focus from an Elementary object
2381 * @param obj The Elementary to take focus from
2383 * This removes the focus from @p obj, passing it back to the
2384 * previous element in the focus chain list.
2386 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2387 * @deprecated use elm_object_focus_set() instead.
2391 EINA_DEPRECATED EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2394 * Set the ability for an Element object to be focused
2396 * @param obj The Elementary object to operate on
2397 * @param enable @c EINA_TRUE if the object can be focused, @c
2398 * EINA_FALSE if not (and on errors)
2400 * This sets whether the object @p obj is able to take focus or
2401 * not. Unfocusable objects do nothing when programmatically
2402 * focused, being the nearest focusable parent object the one
2403 * really getting focus. Also, when they receive mouse input, they
2404 * will get the event, but not take away the focus from where it
2409 EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2412 * Get whether an Elementary object is focusable or not
2414 * @param obj The Elementary object to operate on
2415 * @return @c EINA_TRUE if the object is allowed to be focused, @c
2416 * EINA_FALSE if not (and on errors)
2418 * @note Objects which are meant to be interacted with by input
2419 * events are created able to be focused, by default. All the
2424 EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2427 * Set custom focus chain.
2429 * This function overwrites any previous custom focus chain within
2430 * the list of objects. The previous list will be deleted and this list
2431 * will be managed by elementary. After it is set, don't modify it.
2433 * @note On focus cycle, only will be evaluated children of this container.
2435 * @param obj The container object
2436 * @param objs Chain of objects to pass focus
2439 EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2442 * Unset a custom focus chain on a given Elementary widget
2444 * @param obj The container object to remove focus chain from
2446 * Any focus chain previously set on @p obj (for its child objects)
2447 * is removed entirely after this call.
2451 EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2454 * Get custom focus chain
2456 * @param obj The container object
2459 EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2462 * Append object to custom focus chain.
2464 * @note If relative_child equal to NULL or not in custom chain, the object
2465 * will be added in end.
2467 * @note On focus cycle, only will be evaluated children of this container.
2469 * @param obj The container object
2470 * @param child The child to be added in custom chain
2471 * @param relative_child The relative object to position the child
2474 EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2477 * Prepend object to custom focus chain.
2479 * @note If relative_child equal to NULL or not in custom chain, the object
2480 * will be added in begin.
2482 * @note On focus cycle, only will be evaluated children of this container.
2484 * @param obj The container object
2485 * @param child The child to be added in custom chain
2486 * @param relative_child The relative object to position the child
2489 EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2492 * Give focus to next object in object tree.
2494 * Give focus to next object in focus chain of one object sub-tree.
2495 * If the last object of chain already have focus, the focus will go to the
2496 * first object of chain.
2498 * @param obj The object root of sub-tree
2499 * @param dir Direction to cycle the focus
2503 EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2506 * Give focus to near object in one direction.
2508 * Give focus to near object in direction of one object.
2509 * If none focusable object in given direction, the focus will not change.
2511 * @param obj The reference object
2512 * @param x Horizontal component of direction to focus
2513 * @param y Vertical component of direction to focus
2517 EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2520 * Make the elementary object and its children to be unfocusable
2523 * @param obj The Elementary object to operate on
2524 * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2525 * @c EINA_FALSE for focusable.
2527 * This sets whether the object @p obj and its children objects
2528 * are able to take focus or not. If the tree is set as unfocusable,
2529 * newest focused object which is not in this tree will get focus.
2530 * This API can be helpful for an object to be deleted.
2531 * When an object will be deleted soon, it and its children may not
2532 * want to get focus (by focus reverting or by other focus controls).
2533 * Then, just use this API before deleting.
2535 * @see elm_object_tree_unfocusable_get()
2539 EAPI void elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
2542 * Get whether an Elementary object and its children are unfocusable or not.
2544 * @param obj The Elementary object to get the information from
2545 * @return @c EINA_TRUE, if the tree is unfocussable,
2546 * @c EINA_FALSE if not (and on errors).
2548 * @see elm_object_tree_unfocusable_set()
2552 EAPI Eina_Bool elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
2555 * @defgroup Scrolling Scrolling
2557 * These are functions setting how scrollable views in Elementary
2558 * widgets should behave on user interaction.
2564 * Get whether scrollers should bounce when they reach their
2565 * viewport's edge during a scroll.
2567 * @return the thumb scroll bouncing state
2569 * This is the default behavior for touch screens, in general.
2570 * @ingroup Scrolling
2572 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
2575 * Set whether scrollers should bounce when they reach their
2576 * viewport's edge during a scroll.
2578 * @param enabled the thumb scroll bouncing state
2580 * @see elm_thumbscroll_bounce_enabled_get()
2581 * @ingroup Scrolling
2583 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2586 * Set whether scrollers should bounce when they reach their
2587 * viewport's edge during a scroll, for all Elementary application
2590 * @param enabled the thumb scroll bouncing state
2592 * @see elm_thumbscroll_bounce_enabled_get()
2593 * @ingroup Scrolling
2595 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2598 * Get the amount of inertia a scroller will impose at bounce
2601 * @return the thumb scroll bounce friction
2603 * @ingroup Scrolling
2605 EAPI double elm_scroll_bounce_friction_get(void);
2608 * Set the amount of inertia a scroller will impose at bounce
2611 * @param friction the thumb scroll bounce friction
2613 * @see elm_thumbscroll_bounce_friction_get()
2614 * @ingroup Scrolling
2616 EAPI void elm_scroll_bounce_friction_set(double friction);
2619 * Set the amount of inertia a scroller will impose at bounce
2620 * animations, for all Elementary application windows.
2622 * @param friction the thumb scroll bounce friction
2624 * @see elm_thumbscroll_bounce_friction_get()
2625 * @ingroup Scrolling
2627 EAPI void elm_scroll_bounce_friction_all_set(double friction);
2630 * Get the amount of inertia a <b>paged</b> scroller will impose at
2631 * page fitting animations.
2633 * @return the page scroll friction
2635 * @ingroup Scrolling
2637 EAPI double elm_scroll_page_scroll_friction_get(void);
2640 * Set the amount of inertia a <b>paged</b> scroller will impose at
2641 * page fitting animations.
2643 * @param friction the page scroll friction
2645 * @see elm_thumbscroll_page_scroll_friction_get()
2646 * @ingroup Scrolling
2648 EAPI void elm_scroll_page_scroll_friction_set(double friction);
2651 * Set the amount of inertia a <b>paged</b> scroller will impose at
2652 * page fitting animations, for all Elementary application windows.
2654 * @param friction the page scroll friction
2656 * @see elm_thumbscroll_page_scroll_friction_get()
2657 * @ingroup Scrolling
2659 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
2662 * Get the amount of inertia a scroller will impose at region bring
2665 * @return the bring in scroll friction
2667 * @ingroup Scrolling
2669 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
2672 * Set the amount of inertia a scroller will impose at region bring
2675 * @param friction the bring in scroll friction
2677 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2678 * @ingroup Scrolling
2680 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
2683 * Set the amount of inertia a scroller will impose at region bring
2684 * animations, for all Elementary application windows.
2686 * @param friction the bring in scroll friction
2688 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2689 * @ingroup Scrolling
2691 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
2694 * Get the amount of inertia scrollers will impose at animations
2695 * triggered by Elementary widgets' zooming API.
2697 * @return the zoom friction
2699 * @ingroup Scrolling
2701 EAPI double elm_scroll_zoom_friction_get(void);
2704 * Set the amount of inertia scrollers will impose at animations
2705 * triggered by Elementary widgets' zooming API.
2707 * @param friction the zoom friction
2709 * @see elm_thumbscroll_zoom_friction_get()
2710 * @ingroup Scrolling
2712 EAPI void elm_scroll_zoom_friction_set(double friction);
2715 * Set the amount of inertia scrollers will impose at animations
2716 * triggered by Elementary widgets' zooming API, for all Elementary
2717 * application windows.
2719 * @param friction the zoom friction
2721 * @see elm_thumbscroll_zoom_friction_get()
2722 * @ingroup Scrolling
2724 EAPI void elm_scroll_zoom_friction_all_set(double friction);
2727 * Get whether scrollers should be draggable from any point in their
2730 * @return the thumb scroll state
2732 * @note This is the default behavior for touch screens, in general.
2733 * @note All other functions namespaced with "thumbscroll" will only
2734 * have effect if this mode is enabled.
2736 * @ingroup Scrolling
2738 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
2741 * Set whether scrollers should be draggable from any point in their
2744 * @param enabled the thumb scroll state
2746 * @see elm_thumbscroll_enabled_get()
2747 * @ingroup Scrolling
2749 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2752 * Set whether scrollers should be draggable from any point in their
2753 * views, for all Elementary application windows.
2755 * @param enabled the thumb scroll state
2757 * @see elm_thumbscroll_enabled_get()
2758 * @ingroup Scrolling
2760 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2763 * Get the number of pixels one should travel while dragging a
2764 * scroller's view to actually trigger scrolling.
2766 * @return the thumb scroll threshould
2768 * One would use higher values for touch screens, in general, because
2769 * of their inherent imprecision.
2770 * @ingroup Scrolling
2772 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
2775 * Set the number of pixels one should travel while dragging a
2776 * scroller's view to actually trigger scrolling.
2778 * @param threshold the thumb scroll threshould
2780 * @see elm_thumbscroll_threshould_get()
2781 * @ingroup Scrolling
2783 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2786 * Set the number of pixels one should travel while dragging a
2787 * scroller's view to actually trigger scrolling, for all Elementary
2788 * application windows.
2790 * @param threshold the thumb scroll threshould
2792 * @see elm_thumbscroll_threshould_get()
2793 * @ingroup Scrolling
2795 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2798 * Get the minimum speed of mouse cursor movement which will trigger
2799 * list self scrolling animation after a mouse up event
2802 * @return the thumb scroll momentum threshould
2804 * @ingroup Scrolling
2806 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
2809 * Set the minimum speed of mouse cursor movement which will trigger
2810 * list self scrolling animation after a mouse up event
2813 * @param threshold the thumb scroll momentum threshould
2815 * @see elm_thumbscroll_momentum_threshould_get()
2816 * @ingroup Scrolling
2818 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
2821 * Set the minimum speed of mouse cursor movement which will trigger
2822 * list self scrolling animation after a mouse up event
2823 * (pixels/second), for all Elementary application windows.
2825 * @param threshold the thumb scroll momentum threshould
2827 * @see elm_thumbscroll_momentum_threshould_get()
2828 * @ingroup Scrolling
2830 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
2833 * Get the amount of inertia a scroller will impose at self scrolling
2836 * @return the thumb scroll friction
2838 * @ingroup Scrolling
2840 EAPI double elm_scroll_thumbscroll_friction_get(void);
2843 * Set the amount of inertia a scroller will impose at self scrolling
2846 * @param friction the thumb scroll friction
2848 * @see elm_thumbscroll_friction_get()
2849 * @ingroup Scrolling
2851 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
2854 * Set the amount of inertia a scroller will impose at self scrolling
2855 * animations, for all Elementary application windows.
2857 * @param friction the thumb scroll friction
2859 * @see elm_thumbscroll_friction_get()
2860 * @ingroup Scrolling
2862 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
2865 * Get the amount of lag between your actual mouse cursor dragging
2866 * movement and a scroller's view movement itself, while pushing it
2867 * into bounce state manually.
2869 * @return the thumb scroll border friction
2871 * @ingroup Scrolling
2873 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
2876 * Set the amount of lag between your actual mouse cursor dragging
2877 * movement and a scroller's view movement itself, while pushing it
2878 * into bounce state manually.
2880 * @param friction the thumb scroll border friction. @c 0.0 for
2881 * perfect synchrony between two movements, @c 1.0 for maximum
2884 * @see elm_thumbscroll_border_friction_get()
2885 * @note parameter value will get bound to 0.0 - 1.0 interval, always
2887 * @ingroup Scrolling
2889 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
2892 * Set the amount of lag between your actual mouse cursor dragging
2893 * movement and a scroller's view movement itself, while pushing it
2894 * into bounce state manually, for all Elementary application windows.
2896 * @param friction the thumb scroll border friction. @c 0.0 for
2897 * perfect synchrony between two movements, @c 1.0 for maximum
2900 * @see elm_thumbscroll_border_friction_get()
2901 * @note parameter value will get bound to 0.0 - 1.0 interval, always
2903 * @ingroup Scrolling
2905 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
2908 * Get the sensitivity amount which is be multiplied by the length of
2911 * @return the thumb scroll sensitivity friction
2913 * @ingroup Scrolling
2915 EAPI double elm_scroll_thumbscroll_sensitivity_friction_get(void);
2918 * Set the sensitivity amount which is be multiplied by the length of
2921 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
2922 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
2925 * @see elm_thumbscroll_sensitivity_friction_get()
2926 * @note parameter value will get bound to 0.1 - 1.0 interval, always
2928 * @ingroup Scrolling
2930 EAPI void elm_scroll_thumbscroll_sensitivity_friction_set(double friction);
2933 * Set the sensitivity amount which is be multiplied by the length of
2934 * mouse dragging, for all Elementary application windows.
2936 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
2937 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
2940 * @see elm_thumbscroll_sensitivity_friction_get()
2941 * @note parameter value will get bound to 0.1 - 1.0 interval, always
2943 * @ingroup Scrolling
2945 EAPI void elm_scroll_thumbscroll_sensitivity_friction_all_set(double friction);
2952 * @defgroup Scrollhints Scrollhints
2954 * Objects when inside a scroller can scroll, but this may not always be
2955 * desirable in certain situations. This allows an object to hint to itself
2956 * and parents to "not scroll" in one of 2 ways. If any child object of a
2957 * scroller has pushed a scroll freeze or hold then it affects all parent
2958 * scrollers until all children have released them.
2960 * 1. To hold on scrolling. This means just flicking and dragging may no
2961 * longer scroll, but pressing/dragging near an edge of the scroller will
2962 * still scroll. This is automatically used by the entry object when
2965 * 2. To totally freeze scrolling. This means it stops. until
2972 * Push the scroll hold by 1
2974 * This increments the scroll hold count by one. If it is more than 0 it will
2975 * take effect on the parents of the indicated object.
2977 * @param obj The object
2978 * @ingroup Scrollhints
2980 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2983 * Pop the scroll hold by 1
2985 * This decrements the scroll hold count by one. If it is more than 0 it will
2986 * take effect on the parents of the indicated object.
2988 * @param obj The object
2989 * @ingroup Scrollhints
2991 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2994 * Push the scroll freeze by 1
2996 * This increments the scroll freeze count by one. If it is more
2997 * than 0 it will take effect on the parents of the indicated
3000 * @param obj The object
3001 * @ingroup Scrollhints
3003 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3006 * Pop the scroll freeze by 1
3008 * This decrements the scroll freeze count by one. If it is more
3009 * than 0 it will take effect on the parents of the indicated
3012 * @param obj The object
3013 * @ingroup Scrollhints
3015 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3018 * Lock the scrolling of the given widget (and thus all parents)
3020 * This locks the given object from scrolling in the X axis (and implicitly
3021 * also locks all parent scrollers too from doing the same).
3023 * @param obj The object
3024 * @param lock The lock state (1 == locked, 0 == unlocked)
3025 * @ingroup Scrollhints
3027 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3030 * Lock the scrolling of the given widget (and thus all parents)
3032 * This locks the given object from scrolling in the Y axis (and implicitly
3033 * also locks all parent scrollers too from doing the same).
3035 * @param obj The object
3036 * @param lock The lock state (1 == locked, 0 == unlocked)
3037 * @ingroup Scrollhints
3039 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3042 * Get the scrolling lock of the given widget
3044 * This gets the lock for X axis scrolling.
3046 * @param obj The object
3047 * @ingroup Scrollhints
3049 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3052 * Get the scrolling lock of the given widget
3054 * This gets the lock for X axis scrolling.
3056 * @param obj The object
3057 * @ingroup Scrollhints
3059 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3066 * Send a signal to the widget edje object.
3068 * This function sends a signal to the edje object of the obj. An
3069 * edje program can respond to a signal by specifying matching
3070 * 'signal' and 'source' fields.
3072 * @param obj The object
3073 * @param emission The signal's name.
3074 * @param source The signal's source.
3077 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
3080 * Add a callback for a signal emitted by widget edje object.
3082 * This function connects a callback function to a signal emitted by the
3083 * edje object of the obj.
3084 * Globs can occur in either the emission or source name.
3086 * @param obj The object
3087 * @param emission The signal's name.
3088 * @param source The signal's source.
3089 * @param func The callback function to be executed when the signal is
3091 * @param data A pointer to data to pass in to the callback function.
3094 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);
3097 * Remove a signal-triggered callback from a widget edje object.
3099 * This function removes a callback, previoulsy attached to a
3100 * signal emitted by the edje object of the obj. The parameters
3101 * emission, source and func must match exactly those passed to a
3102 * previous call to elm_object_signal_callback_add(). The data
3103 * pointer that was passed to this call will be returned.
3105 * @param obj The object
3106 * @param emission The signal's name.
3107 * @param source The signal's source.
3108 * @param func The callback function to be executed when the signal is
3110 * @return The data pointer
3113 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);
3116 * Add a callback for input events (key up, key down, mouse wheel)
3117 * on a given Elementary widget
3119 * @param obj The widget to add an event callback on
3120 * @param func The callback function to be executed when the event
3122 * @param data Data to pass in to @p func
3124 * Every widget in an Elementary interface set to receive focus,
3125 * with elm_object_focus_allow_set(), will propagate @b all of its
3126 * key up, key down and mouse wheel input events up to its parent
3127 * object, and so on. All of the focusable ones in this chain which
3128 * had an event callback set, with this call, will be able to treat
3129 * those events. There are two ways of making the propagation of
3130 * these event upwards in the tree of widgets to @b cease:
3131 * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
3132 * the event was @b not processed, so the propagation will go on.
3133 * - The @c event_info pointer passed to @p func will contain the
3134 * event's structure and, if you OR its @c event_flags inner
3135 * value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
3136 * one has already handled it, thus killing the event's
3139 * @note Your event callback will be issued on those events taking
3140 * place only if no other child widget of @obj has consumed the
3143 * @note Not to be confused with @c
3144 * evas_object_event_callback_add(), which will add event callbacks
3145 * per type on general Evas objects (no event propagation
3146 * infrastructure taken in account).
3148 * @note Not to be confused with @c
3149 * elm_object_signal_callback_add(), which will add callbacks to @b
3150 * signals coming from a widget's theme, not input events.
3152 * @note Not to be confused with @c
3153 * edje_object_signal_callback_add(), which does the same as
3154 * elm_object_signal_callback_add(), but directly on an Edje
3157 * @note Not to be confused with @c
3158 * evas_object_smart_callback_add(), which adds callbacks to smart
3159 * objects' <b>smart events</b>, and not input events.
3161 * @see elm_object_event_callback_del()
3165 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3168 * Remove an event callback from a widget.
3170 * This function removes a callback, previoulsy attached to event emission
3172 * The parameters func and data must match exactly those passed to
3173 * a previous call to elm_object_event_callback_add(). The data pointer that
3174 * was passed to this call will be returned.
3176 * @param obj The object
3177 * @param func The callback function to be executed when the event is
3179 * @param data Data to pass in to the callback function.
3180 * @return The data pointer
3183 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3186 * Adjust size of an element for finger usage.
3188 * @param times_w How many fingers should fit horizontally
3189 * @param w Pointer to the width size to adjust
3190 * @param times_h How many fingers should fit vertically
3191 * @param h Pointer to the height size to adjust
3193 * This takes width and height sizes (in pixels) as input and a
3194 * size multiple (which is how many fingers you want to place
3195 * within the area, being "finger" the size set by
3196 * elm_finger_size_set()), and adjusts the size to be large enough
3197 * to accommodate the resulting size -- if it doesn't already
3198 * accommodate it. On return the @p w and @p h sizes pointed to by
3199 * these parameters will be modified, on those conditions.
3201 * @note This is kind of a low level Elementary call, most useful
3202 * on size evaluation times for widgets. An external user wouldn't
3203 * be calling, most of the time.
3207 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
3210 * Get the duration for occuring long press event.
3212 * @return Timeout for long press event
3213 * @ingroup Longpress
3215 EAPI double elm_longpress_timeout_get(void);
3218 * Set the duration for occuring long press event.
3220 * @param lonpress_timeout Timeout for long press event
3221 * @ingroup Longpress
3223 EAPI void elm_longpress_timeout_set(double longpress_timeout);
3226 * @defgroup Debug Debug
3227 * don't use it unless you are sure
3233 * Print Tree object hierarchy in stdout
3235 * @param obj The root object
3238 EAPI void elm_object_tree_dump(const Evas_Object *top);
3241 * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3243 * @param obj The root object
3244 * @param file The path of output file
3247 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3254 * @defgroup Theme Theme
3256 * Elementary uses Edje to theme its widgets, naturally. But for the most
3257 * part this is hidden behind a simpler interface that lets the user set
3258 * extensions and choose the style of widgets in a much easier way.
3260 * Instead of thinking in terms of paths to Edje files and their groups
3261 * each time you want to change the appearance of a widget, Elementary
3262 * works so you can add any theme file with extensions or replace the
3263 * main theme at one point in the application, and then just set the style
3264 * of widgets with elm_object_style_set() and related functions. Elementary
3265 * will then look in its list of themes for a matching group and apply it,
3266 * and when the theme changes midway through the application, all widgets
3267 * will be updated accordingly.
3269 * There are three concepts you need to know to understand how Elementary
3270 * theming works: default theme, extensions and overlays.
3272 * Default theme, obviously enough, is the one that provides the default
3273 * look of all widgets. End users can change the theme used by Elementary
3274 * by setting the @c ELM_THEME environment variable before running an
3275 * application, or globally for all programs using the @c elementary_config
3276 * utility. Applications can change the default theme using elm_theme_set(),
3277 * but this can go against the user wishes, so it's not an adviced practice.
3279 * Ideally, applications should find everything they need in the already
3280 * provided theme, but there may be occasions when that's not enough and
3281 * custom styles are required to correctly express the idea. For this
3282 * cases, Elementary has extensions.
3284 * Extensions allow the application developer to write styles of its own
3285 * to apply to some widgets. This requires knowledge of how each widget
3286 * is themed, as extensions will always replace the entire group used by
3287 * the widget, so important signals and parts need to be there for the
3288 * object to behave properly (see documentation of Edje for details).
3289 * Once the theme for the extension is done, the application needs to add
3290 * it to the list of themes Elementary will look into, using
3291 * elm_theme_extension_add(), and set the style of the desired widgets as
3292 * he would normally with elm_object_style_set().
3294 * Overlays, on the other hand, can replace the look of all widgets by
3295 * overriding the default style. Like extensions, it's up to the application
3296 * developer to write the theme for the widgets it wants, the difference
3297 * being that when looking for the theme, Elementary will check first the
3298 * list of overlays, then the set theme and lastly the list of extensions,
3299 * so with overlays it's possible to replace the default view and every
3300 * widget will be affected. This is very much alike to setting the whole
3301 * theme for the application and will probably clash with the end user
3302 * options, not to mention the risk of ending up with not matching styles
3303 * across the program. Unless there's a very special reason to use them,
3304 * overlays should be avoided for the resons exposed before.
3306 * All these theme lists are handled by ::Elm_Theme instances. Elementary
3307 * keeps one default internally and every function that receives one of
3308 * these can be called with NULL to refer to this default (except for
3309 * elm_theme_free()). It's possible to create a new instance of a
3310 * ::Elm_Theme to set other theme for a specific widget (and all of its
3311 * children), but this is as discouraged, if not even more so, than using
3312 * overlays. Don't use this unless you really know what you are doing.
3314 * But to be less negative about things, you can look at the following
3316 * @li @ref theme_example_01 "Using extensions"
3317 * @li @ref theme_example_02 "Using overlays"
3322 * @typedef Elm_Theme
3324 * Opaque handler for the list of themes Elementary looks for when
3325 * rendering widgets.
3327 * Stay out of this unless you really know what you are doing. For most
3328 * cases, sticking to the default is all a developer needs.
3330 typedef struct _Elm_Theme Elm_Theme;
3333 * Create a new specific theme
3335 * This creates an empty specific theme that only uses the default theme. A
3336 * specific theme has its own private set of extensions and overlays too
3337 * (which are empty by default). Specific themes do not fall back to themes
3338 * of parent objects. They are not intended for this use. Use styles, overlays
3339 * and extensions when needed, but avoid specific themes unless there is no
3340 * other way (example: you want to have a preview of a new theme you are
3341 * selecting in a "theme selector" window. The preview is inside a scroller
3342 * and should display what the theme you selected will look like, but not
3343 * actually apply it yet. The child of the scroller will have a specific
3344 * theme set to show this preview before the user decides to apply it to all
3347 EAPI Elm_Theme *elm_theme_new(void);
3349 * Free a specific theme
3351 * @param th The theme to free
3353 * This frees a theme created with elm_theme_new().
3355 EAPI void elm_theme_free(Elm_Theme *th);
3357 * Copy the theme fom the source to the destination theme
3359 * @param th The source theme to copy from
3360 * @param thdst The destination theme to copy data to
3362 * This makes a one-time static copy of all the theme config, extensions
3363 * and overlays from @p th to @p thdst. If @p th references a theme, then
3364 * @p thdst is also set to reference it, with all the theme settings,
3365 * overlays and extensions that @p th had.
3367 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3369 * Tell the source theme to reference the ref theme
3371 * @param th The theme that will do the referencing
3372 * @param thref The theme that is the reference source
3374 * This clears @p th to be empty and then sets it to refer to @p thref
3375 * so @p th acts as an override to @p thref, but where its overrides
3376 * don't apply, it will fall through to @p thref for configuration.
3378 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3380 * Return the theme referred to
3382 * @param th The theme to get the reference from
3383 * @return The referenced theme handle
3385 * This gets the theme set as the reference theme by elm_theme_ref_set().
3386 * If no theme is set as a reference, NULL is returned.
3388 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
3390 * Return the default theme
3392 * @return The default theme handle
3394 * This returns the internal default theme setup handle that all widgets
3395 * use implicitly unless a specific theme is set. This is also often use
3396 * as a shorthand of NULL.
3398 EAPI Elm_Theme *elm_theme_default_get(void);
3400 * Prepends a theme overlay to the list of overlays
3402 * @param th The theme to add to, or if NULL, the default theme
3403 * @param item The Edje file path to be used
3405 * Use this if your application needs to provide some custom overlay theme
3406 * (An Edje file that replaces some default styles of widgets) where adding
3407 * new styles, or changing system theme configuration is not possible. Do
3408 * NOT use this instead of a proper system theme configuration. Use proper
3409 * configuration files, profiles, environment variables etc. to set a theme
3410 * so that the theme can be altered by simple confiugration by a user. Using
3411 * this call to achieve that effect is abusing the API and will create lots
3414 * @see elm_theme_extension_add()
3416 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
3418 * Delete a theme overlay from the list of overlays
3420 * @param th The theme to delete from, or if NULL, the default theme
3421 * @param item The name of the theme overlay
3423 * @see elm_theme_overlay_add()
3425 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
3427 * Appends a theme extension to the list of extensions.
3429 * @param th The theme to add to, or if NULL, the default theme
3430 * @param item The Edje file path to be used
3432 * This is intended when an application needs more styles of widgets or new
3433 * widget themes that the default does not provide (or may not provide). The
3434 * application has "extended" usage by coming up with new custom style names
3435 * for widgets for specific uses, but as these are not "standard", they are
3436 * not guaranteed to be provided by a default theme. This means the
3437 * application is required to provide these extra elements itself in specific
3438 * Edje files. This call adds one of those Edje files to the theme search
3439 * path to be search after the default theme. The use of this call is
3440 * encouraged when default styles do not meet the needs of the application.
3441 * Use this call instead of elm_theme_overlay_add() for almost all cases.
3443 * @see elm_object_style_set()
3445 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
3447 * Deletes a theme extension from the list of extensions.
3449 * @param th The theme to delete from, or if NULL, the default theme
3450 * @param item The name of the theme extension
3452 * @see elm_theme_extension_add()
3454 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
3456 * Set the theme search order for the given theme
3458 * @param th The theme to set the search order, or if NULL, the default theme
3459 * @param theme Theme search string
3461 * This sets the search string for the theme in path-notation from first
3462 * theme to search, to last, delimited by the : character. Example:
3464 * "shiny:/path/to/file.edj:default"
3466 * See the ELM_THEME environment variable for more information.
3468 * @see elm_theme_get()
3469 * @see elm_theme_list_get()
3471 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
3473 * Return the theme search order
3475 * @param th The theme to get the search order, or if NULL, the default theme
3476 * @return The internal search order path
3478 * This function returns a colon separated string of theme elements as
3479 * returned by elm_theme_list_get().
3481 * @see elm_theme_set()
3482 * @see elm_theme_list_get()
3484 EAPI const char *elm_theme_get(Elm_Theme *th);
3486 * Return a list of theme elements to be used in a theme.
3488 * @param th Theme to get the list of theme elements from.
3489 * @return The internal list of theme elements
3491 * This returns the internal list of theme elements (will only be valid as
3492 * long as the theme is not modified by elm_theme_set() or theme is not
3493 * freed by elm_theme_free(). This is a list of strings which must not be
3494 * altered as they are also internal. If @p th is NULL, then the default
3495 * theme element list is returned.
3497 * A theme element can consist of a full or relative path to a .edj file,
3498 * or a name, without extension, for a theme to be searched in the known
3499 * theme paths for Elemementary.
3501 * @see elm_theme_set()
3502 * @see elm_theme_get()
3504 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3506 * Return the full patrh for a theme element
3508 * @param f The theme element name
3509 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3510 * @return The full path to the file found.
3512 * This returns a string you should free with free() on success, NULL on
3513 * failure. This will search for the given theme element, and if it is a
3514 * full or relative path element or a simple searchable name. The returned
3515 * path is the full path to the file, if searched, and the file exists, or it
3516 * is simply the full path given in the element or a resolved path if
3517 * relative to home. The @p in_search_path boolean pointed to is set to
3518 * EINA_TRUE if the file was a searchable file andis in the search path,
3519 * and EINA_FALSE otherwise.
3521 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3523 * Flush the current theme.
3525 * @param th Theme to flush
3527 * This flushes caches that let elementary know where to find theme elements
3528 * in the given theme. If @p th is NULL, then the default theme is flushed.
3529 * Call this function if source theme data has changed in such a way as to
3530 * make any caches Elementary kept invalid.
3532 EAPI void elm_theme_flush(Elm_Theme *th);
3534 * This flushes all themes (default and specific ones).
3536 * This will flush all themes in the current application context, by calling
3537 * elm_theme_flush() on each of them.
3539 EAPI void elm_theme_full_flush(void);
3541 * Set the theme for all elementary using applications on the current display
3543 * @param theme The name of the theme to use. Format same as the ELM_THEME
3544 * environment variable.
3546 EAPI void elm_theme_all_set(const char *theme);
3548 * Return a list of theme elements in the theme search path
3550 * @return A list of strings that are the theme element names.
3552 * This lists all available theme files in the standard Elementary search path
3553 * for theme elements, and returns them in alphabetical order as theme
3554 * element names in a list of strings. Free this with
3555 * elm_theme_name_available_list_free() when you are done with the list.
3557 EAPI Eina_List *elm_theme_name_available_list_new(void);
3559 * Free the list returned by elm_theme_name_available_list_new()
3561 * This frees the list of themes returned by
3562 * elm_theme_name_available_list_new(). Once freed the list should no longer
3563 * be used. a new list mys be created.
3565 EAPI void elm_theme_name_available_list_free(Eina_List *list);
3567 * Set a specific theme to be used for this object and its children
3569 * @param obj The object to set the theme on
3570 * @param th The theme to set
3572 * This sets a specific theme that will be used for the given object and any
3573 * child objects it has. If @p th is NULL then the theme to be used is
3574 * cleared and the object will inherit its theme from its parent (which
3575 * ultimately will use the default theme if no specific themes are set).
3577 * Use special themes with great care as this will annoy users and make
3578 * configuration difficult. Avoid any custom themes at all if it can be
3581 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3583 * Get the specific theme to be used
3585 * @param obj The object to get the specific theme from
3586 * @return The specifc theme set.
3588 * This will return a specific theme set, or NULL if no specific theme is
3589 * set on that object. It will not return inherited themes from parents, only
3590 * the specific theme set for that specific object. See elm_object_theme_set()
3591 * for more information.
3593 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3596 * Get a data item from a theme
3598 * @param th The theme, or NULL for default theme
3599 * @param key The data key to search with
3600 * @return The data value, or NULL on failure
3602 * This function is used to return data items from edc in @p th, an overlay, or an extension.
3603 * It works the same way as edje_file_data_get() except that the return is stringshared.
3605 EAPI const char *elm_theme_data_get(Elm_Theme *th, const char *key) EINA_ARG_NONNULL(2);
3611 /** @defgroup Win Win
3613 * @image html img/widget/win/preview-00.png
3614 * @image latex img/widget/win/preview-00.eps
3616 * The window class of Elementary. Contains functions to manipulate
3617 * windows. The Evas engine used to render the window contents is specified
3618 * in the system or user elementary config files (whichever is found last),
3619 * and can be overridden with the ELM_ENGINE environment variable for
3620 * testing. Engines that may be supported (depending on Evas and Ecore-Evas
3621 * compilation setup and modules actually installed at runtime) are (listed
3622 * in order of best supported and most likely to be complete and work to
3625 * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3626 * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3628 * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3630 * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3632 * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3634 * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3635 * rendering using SDL as the buffer)
3636 * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3637 * GDI with software)
3638 * @li "dfb", "directfb" (Rendering to a DirectFB window)
3639 * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3640 * grayscale using dedicated 8bit software engine in X11)
3641 * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3642 * X11 using 16bit software engine)
3643 * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3644 * (Windows CE rendering via GDI with 16bit software renderer)
3645 * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3646 * buffer with 16bit software renderer)
3647 * @li "ews" (rendering to EWS - Ecore + Evas Single Process Windowing System)
3648 * @li "gl-cocoa", "gl_cocoa", "opengl-cocoa", "opengl_cocoa" (OpenGL rendering in Cocoa)
3649 * @li "psl1ght" (PS3 rendering using PSL1GHT)
3651 * All engines use a simple string to select the engine to render, EXCEPT
3652 * the "shot" engine. This actually encodes the output of the virtual
3653 * screenshot and how long to delay in the engine string. The engine string
3654 * is encoded in the following way:
3656 * "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3658 * Where options are separated by a ":" char if more than one option is
3659 * given, with delay, if provided being the first option and file the last
3660 * (order is important). The delay specifies how long to wait after the
3661 * window is shown before doing the virtual "in memory" rendering and then
3662 * save the output to the file specified by the file option (and then exit).
3663 * If no delay is given, the default is 0.5 seconds. If no file is given the
3664 * default output file is "out.png". Repeat option is for continous
3665 * capturing screenshots. Repeat range is from 1 to 999 and filename is
3666 * fixed to "out001.png" Some examples of using the shot engine:
3668 * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3669 * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3670 * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3671 * ELM_ENGINE="shot:delay=2.0" elementary_test
3672 * ELM_ENGINE="shot:" elementary_test
3674 * Signals that you can add callbacks for are:
3676 * @li "delete,request": the user requested to close the window. See
3677 * elm_win_autodel_set().
3678 * @li "focus,in": window got focus
3679 * @li "focus,out": window lost focus
3680 * @li "moved": window that holds the canvas was moved
3683 * @li @ref win_example_01
3688 * Defines the types of window that can be created
3690 * These are hints set on the window so that a running Window Manager knows
3691 * how the window should be handled and/or what kind of decorations it
3694 * Currently, only the X11 backed engines use them.
3696 typedef enum _Elm_Win_Type
3698 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3699 window. Almost every window will be created with this
3701 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3702 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3703 window holding desktop icons. */
3704 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3705 be kept on top of any other window by the Window
3707 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3709 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3710 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3712 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3713 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3714 entry in a menubar is clicked. Typically used
3715 with elm_win_override_set(). This hint exists
3716 for completion only, as the EFL way of
3717 implementing a menu would not normally use a
3718 separate window for its contents. */
3719 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3720 triggered by right-clicking an object. */
3721 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3722 explanatory text that typically appear after the
3723 mouse cursor hovers over an object for a while.
3724 Typically used with elm_win_override_set() and also
3725 not very commonly used in the EFL. */
3726 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3727 battery life or a new E-Mail received. */
3728 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3729 usually used in the EFL. */
3730 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3731 object being dragged across different windows, or even
3732 applications. Typically used with
3733 elm_win_override_set(). */
3734 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3735 buffer. No actual window is created for this
3736 type, instead the window and all of its
3737 contents will be rendered to an image buffer.
3738 This allows to have children window inside a
3739 parent one just like any other object would
3740 be, and do other things like applying @c
3741 Evas_Map effects to it. This is the only type
3742 of window that requires the @c parent
3743 parameter of elm_win_add() to be a valid @c
3748 * The differents layouts that can be requested for the virtual keyboard.
3750 * When the application window is being managed by Illume, it may request
3751 * any of the following layouts for the virtual keyboard.
3753 typedef enum _Elm_Win_Keyboard_Mode
3755 ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3756 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3757 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3758 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3759 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3760 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3761 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3762 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3763 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3764 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3765 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3766 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3767 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3768 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3769 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3770 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3771 } Elm_Win_Keyboard_Mode;
3774 * Available commands that can be sent to the Illume manager.
3776 * When running under an Illume session, a window may send commands to the
3777 * Illume manager to perform different actions.
3779 typedef enum _Elm_Illume_Command
3781 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3783 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3785 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3787 ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3788 } Elm_Illume_Command;
3791 * Adds a window object. If this is the first window created, pass NULL as
3794 * @param parent Parent object to add the window to, or NULL
3795 * @param name The name of the window
3796 * @param type The window type, one of #Elm_Win_Type.
3798 * The @p parent paramter can be @c NULL for every window @p type except
3799 * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3800 * which the image object will be created.
3802 * @return The created object, or NULL on failure
3804 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3806 * Adds a window object with standard setup
3808 * @param name The name of the window
3809 * @param title The title for the window
3811 * This creates a window like elm_win_add() but also puts in a standard
3812 * background with elm_bg_add(), as well as setting the window title to
3813 * @p title. The window type created is of type ELM_WIN_BASIC, with NULL
3814 * as the parent widget.
3816 * @return The created object, or NULL on failure
3818 * @see elm_win_add()
3820 EAPI Evas_Object *elm_win_util_standard_add(const char *name, const char *title);
3822 * Add @p subobj as a resize object of window @p obj.
3825 * Setting an object as a resize object of the window means that the
3826 * @p subobj child's size and position will be controlled by the window
3827 * directly. That is, the object will be resized to match the window size
3828 * and should never be moved or resized manually by the developer.
3830 * In addition, resize objects of the window control what the minimum size
3831 * of it will be, as well as whether it can or not be resized by the user.
3833 * For the end user to be able to resize a window by dragging the handles
3834 * or borders provided by the Window Manager, or using any other similar
3835 * mechanism, all of the resize objects in the window should have their
3836 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
3838 * @param obj The window object
3839 * @param subobj The resize object to add
3841 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3843 * Delete @p subobj as a resize object of window @p obj.
3845 * This function removes the object @p subobj from the resize objects of
3846 * the window @p obj. It will not delete the object itself, which will be
3847 * left unmanaged and should be deleted by the developer, manually handled
3848 * or set as child of some other container.
3850 * @param obj The window object
3851 * @param subobj The resize object to add
3853 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3855 * Set the title of the window
3857 * @param obj The window object
3858 * @param title The title to set
3860 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3862 * Get the title of the window
3864 * The returned string is an internal one and should not be freed or
3865 * modified. It will also be rendered invalid if a new title is set or if
3866 * the window is destroyed.
3868 * @param obj The window object
3871 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3873 * Set the window's autodel state.
3875 * When closing the window in any way outside of the program control, like
3876 * pressing the X button in the titlebar or using a command from the
3877 * Window Manager, a "delete,request" signal is emitted to indicate that
3878 * this event occurred and the developer can take any action, which may
3879 * include, or not, destroying the window object.
3881 * When the @p autodel parameter is set, the window will be automatically
3882 * destroyed when this event occurs, after the signal is emitted.
3883 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
3884 * and is up to the program to do so when it's required.
3886 * @param obj The window object
3887 * @param autodel If true, the window will automatically delete itself when
3890 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
3892 * Get the window's autodel state.
3894 * @param obj The window object
3895 * @return If the window will automatically delete itself when closed
3897 * @see elm_win_autodel_set()
3899 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3901 * Activate a window object.
3903 * This function sends a request to the Window Manager to activate the
3904 * window pointed by @p obj. If honored by the WM, the window will receive
3905 * the keyboard focus.
3907 * @note This is just a request that a Window Manager may ignore, so calling
3908 * this function does not ensure in any way that the window will be the
3909 * active one after it.
3911 * @param obj The window object
3913 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
3915 * Lower a window object.
3917 * Places the window pointed by @p obj at the bottom of the stack, so that
3918 * no other window is covered by it.
3920 * If elm_win_override_set() is not set, the Window Manager may ignore this
3923 * @param obj The window object
3925 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
3927 * Raise a window object.
3929 * Places the window pointed by @p obj at the top of the stack, so that it's
3930 * not covered by any other window.
3932 * If elm_win_override_set() is not set, the Window Manager may ignore this
3935 * @param obj The window object
3937 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
3939 * Set the borderless state of a window.
3941 * This function requests the Window Manager to not draw any decoration
3942 * around the window.
3944 * @param obj The window object
3945 * @param borderless If true, the window is borderless
3947 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
3949 * Get the borderless state of a window.
3951 * @param obj The window object
3952 * @return If true, the window is borderless
3954 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3956 * Set the shaped state of a window.
3958 * Shaped windows, when supported, will render the parts of the window that
3959 * has no content, transparent.
3961 * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
3962 * background object or cover the entire window in any other way, or the
3963 * parts of the canvas that have no data will show framebuffer artifacts.
3965 * @param obj The window object
3966 * @param shaped If true, the window is shaped
3968 * @see elm_win_alpha_set()
3970 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
3972 * Get the shaped state of a window.
3974 * @param obj The window object
3975 * @return If true, the window is shaped
3977 * @see elm_win_shaped_set()
3979 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3981 * Set the alpha channel state of a window.
3983 * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
3984 * possibly making parts of the window completely or partially transparent.
3985 * This is also subject to the underlying system supporting it, like for
3986 * example, running under a compositing manager. If no compositing is
3987 * available, enabling this option will instead fallback to using shaped
3988 * windows, with elm_win_shaped_set().
3990 * @param obj The window object
3991 * @param alpha If true, the window has an alpha channel
3993 * @see elm_win_alpha_set()
3995 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
3997 * Get the transparency state of a window.
3999 * @param obj The window object
4000 * @return If true, the window is transparent
4002 * @see elm_win_transparent_set()
4004 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4006 * Set the transparency state of a window.
4008 * Use elm_win_alpha_set() instead.
4010 * @param obj The window object
4011 * @param transparent If true, the window is transparent
4013 * @see elm_win_alpha_set()
4015 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
4017 * Get the alpha channel state of a window.
4019 * @param obj The window object
4020 * @return If true, the window has an alpha channel
4022 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4024 * Set the override state of a window.
4026 * A window with @p override set to EINA_TRUE will not be managed by the
4027 * Window Manager. This means that no decorations of any kind will be shown
4028 * for it, moving and resizing must be handled by the application, as well
4029 * as the window visibility.
4031 * This should not be used for normal windows, and even for not so normal
4032 * ones, it should only be used when there's a good reason and with a lot
4033 * of care. Mishandling override windows may result situations that
4034 * disrupt the normal workflow of the end user.
4036 * @param obj The window object
4037 * @param override If true, the window is overridden
4039 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
4041 * Get the override state of a window.
4043 * @param obj The window object
4044 * @return If true, the window is overridden
4046 * @see elm_win_override_set()
4048 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4050 * Set the fullscreen state of a window.
4052 * @param obj The window object
4053 * @param fullscreen If true, the window is fullscreen
4055 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
4057 * Get the fullscreen state of a window.
4059 * @param obj The window object
4060 * @return If true, the window is fullscreen
4062 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4064 * Set the maximized state of a window.
4066 * @param obj The window object
4067 * @param maximized If true, the window is maximized
4069 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
4071 * Get the maximized state of a window.
4073 * @param obj The window object
4074 * @return If true, the window is maximized
4076 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4078 * Set the iconified state of a window.
4080 * @param obj The window object
4081 * @param iconified If true, the window is iconified
4083 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
4085 * Get the iconified state of a window.
4087 * @param obj The window object
4088 * @return If true, the window is iconified
4090 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4092 * Set the layer of the window.
4094 * What this means exactly will depend on the underlying engine used.
4096 * In the case of X11 backed engines, the value in @p layer has the
4097 * following meanings:
4098 * @li < 3: The window will be placed below all others.
4099 * @li > 5: The window will be placed above all others.
4100 * @li other: The window will be placed in the default layer.
4102 * @param obj The window object
4103 * @param layer The layer of the window
4105 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
4107 * Get the layer of the window.
4109 * @param obj The window object
4110 * @return The layer of the window
4112 * @see elm_win_layer_set()
4114 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4116 * Set the rotation of the window.
4118 * Most engines only work with multiples of 90.
4120 * This function is used to set the orientation of the window @p obj to
4121 * match that of the screen. The window itself will be resized to adjust
4122 * to the new geometry of its contents. If you want to keep the window size,
4123 * see elm_win_rotation_with_resize_set().
4125 * @param obj The window object
4126 * @param rotation The rotation of the window, in degrees (0-360),
4127 * counter-clockwise.
4129 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4131 * Rotates the window and resizes it.
4133 * Like elm_win_rotation_set(), but it also resizes the window's contents so
4134 * that they fit inside the current window geometry.
4136 * @param obj The window object
4137 * @param layer The rotation of the window in degrees (0-360),
4138 * counter-clockwise.
4140 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4142 * Get the rotation of the window.
4144 * @param obj The window object
4145 * @return The rotation of the window in degrees (0-360)
4147 * @see elm_win_rotation_set()
4148 * @see elm_win_rotation_with_resize_set()
4150 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4152 * Set the sticky state of the window.
4154 * Hints the Window Manager that the window in @p obj should be left fixed
4155 * at its position even when the virtual desktop it's on moves or changes.
4157 * @param obj The window object
4158 * @param sticky If true, the window's sticky state is enabled
4160 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
4162 * Get the sticky state of the window.
4164 * @param obj The window object
4165 * @return If true, the window's sticky state is enabled
4167 * @see elm_win_sticky_set()
4169 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4171 * Set if this window is an illume conformant window
4173 * @param obj The window object
4174 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
4176 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
4178 * Get if this window is an illume conformant window
4180 * @param obj The window object
4181 * @return A boolean if this window is illume conformant or not
4183 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4185 * Set a window to be an illume quickpanel window
4187 * By default window objects are not quickpanel windows.
4189 * @param obj The window object
4190 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4192 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4194 * Get if this window is a quickpanel or not
4196 * @param obj The window object
4197 * @return A boolean if this window is a quickpanel or not
4199 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4201 * Set the major priority of a quickpanel window
4203 * @param obj The window object
4204 * @param priority The major priority for this quickpanel
4206 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4208 * Get the major priority of a quickpanel window
4210 * @param obj The window object
4211 * @return The major priority of this quickpanel
4213 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4215 * Set the minor priority of a quickpanel window
4217 * @param obj The window object
4218 * @param priority The minor priority for this quickpanel
4220 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4222 * Get the minor priority of a quickpanel window
4224 * @param obj The window object
4225 * @return The minor priority of this quickpanel
4227 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4229 * Set which zone this quickpanel should appear in
4231 * @param obj The window object
4232 * @param zone The requested zone for this quickpanel
4234 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4236 * Get which zone this quickpanel should appear in
4238 * @param obj The window object
4239 * @return The requested zone for this quickpanel
4241 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4243 * Set the window to be skipped by keyboard focus
4245 * This sets the window to be skipped by normal keyboard input. This means
4246 * a window manager will be asked to not focus this window as well as omit
4247 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4249 * Call this and enable it on a window BEFORE you show it for the first time,
4250 * otherwise it may have no effect.
4252 * Use this for windows that have only output information or might only be
4253 * interacted with by the mouse or fingers, and never for typing input.
4254 * Be careful that this may have side-effects like making the window
4255 * non-accessible in some cases unless the window is specially handled. Use
4258 * @param obj The window object
4259 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4261 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4263 * Send a command to the windowing environment
4265 * This is intended to work in touchscreen or small screen device
4266 * environments where there is a more simplistic window management policy in
4267 * place. This uses the window object indicated to select which part of the
4268 * environment to control (the part that this window lives in), and provides
4269 * a command and an optional parameter structure (use NULL for this if not
4272 * @param obj The window object that lives in the environment to control
4273 * @param command The command to send
4274 * @param params Optional parameters for the command
4276 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4278 * Get the inlined image object handle
4280 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4281 * then the window is in fact an evas image object inlined in the parent
4282 * canvas. You can get this object (be careful to not manipulate it as it
4283 * is under control of elementary), and use it to do things like get pixel
4284 * data, save the image to a file, etc.
4286 * @param obj The window object to get the inlined image from
4287 * @return The inlined image object, or NULL if none exists
4289 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4291 * Set the enabled status for the focus highlight in a window
4293 * This function will enable or disable the focus highlight only for the
4294 * given window, regardless of the global setting for it
4296 * @param obj The window where to enable the highlight
4297 * @param enabled The enabled value for the highlight
4299 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4301 * Get the enabled value of the focus highlight for this window
4303 * @param obj The window in which to check if the focus highlight is enabled
4305 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4307 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4309 * Set the style for the focus highlight on this window
4311 * Sets the style to use for theming the highlight of focused objects on
4312 * the given window. If @p style is NULL, the default will be used.
4314 * @param obj The window where to set the style
4315 * @param style The style to set
4317 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4319 * Get the style set for the focus highlight object
4321 * Gets the style set for this windows highilght object, or NULL if none
4324 * @param obj The window to retrieve the highlights style from
4326 * @return The style set or NULL if none was. Default is used in that case.
4328 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4330 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4331 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4332 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4333 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4334 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4335 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4336 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4338 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4339 * (blank mouse, private mouse obj, defaultmouse)
4343 * Sets the keyboard mode of the window.
4345 * @param obj The window object
4346 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4348 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4350 * Gets the keyboard mode of the window.
4352 * @param obj The window object
4353 * @return The mode, one of #Elm_Win_Keyboard_Mode
4355 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4357 * Sets whether the window is a keyboard.
4359 * @param obj The window object
4360 * @param is_keyboard If true, the window is a virtual keyboard
4362 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4364 * Gets whether the window is a keyboard.
4366 * @param obj The window object
4367 * @return If the window is a virtual keyboard
4369 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4372 * Get the screen position of a window.
4374 * @param obj The window object
4375 * @param x The int to store the x coordinate to
4376 * @param y The int to store the y coordinate to
4378 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4384 * @defgroup Inwin Inwin
4386 * @image html img/widget/inwin/preview-00.png
4387 * @image latex img/widget/inwin/preview-00.eps
4388 * @image html img/widget/inwin/preview-01.png
4389 * @image latex img/widget/inwin/preview-01.eps
4390 * @image html img/widget/inwin/preview-02.png
4391 * @image latex img/widget/inwin/preview-02.eps
4393 * An inwin is a window inside a window that is useful for a quick popup.
4394 * It does not hover.
4396 * It works by creating an object that will occupy the entire window, so it
4397 * must be created using an @ref Win "elm_win" as parent only. The inwin
4398 * object can be hidden or restacked below every other object if it's
4399 * needed to show what's behind it without destroying it. If this is done,
4400 * the elm_win_inwin_activate() function can be used to bring it back to
4401 * full visibility again.
4403 * There are three styles available in the default theme. These are:
4404 * @li default: The inwin is sized to take over most of the window it's
4406 * @li minimal: The size of the inwin will be the minimum necessary to show
4408 * @li minimal_vertical: Horizontally, the inwin takes as much space as
4409 * possible, but it's sized vertically the most it needs to fit its\
4412 * Some examples of Inwin can be found in the following:
4413 * @li @ref inwin_example_01
4418 * Adds an inwin to the current window
4420 * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4421 * Never call this function with anything other than the top-most window
4422 * as its parameter, unless you are fond of undefined behavior.
4424 * After creating the object, the widget will set itself as resize object
4425 * for the window with elm_win_resize_object_add(), so when shown it will
4426 * appear to cover almost the entire window (how much of it depends on its
4427 * content and the style used). It must not be added into other container
4428 * objects and it needs not be moved or resized manually.
4430 * @param parent The parent object
4431 * @return The new object or NULL if it cannot be created
4433 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4435 * Activates an inwin object, ensuring its visibility
4437 * This function will make sure that the inwin @p obj is completely visible
4438 * by calling evas_object_show() and evas_object_raise() on it, to bring it
4439 * to the front. It also sets the keyboard focus to it, which will be passed
4442 * The object's theme will also receive the signal "elm,action,show" with
4445 * @param obj The inwin to activate
4447 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4449 * Set the content of an inwin object.
4451 * Once the content object is set, a previously set one will be deleted.
4452 * If you want to keep that old content object, use the
4453 * elm_win_inwin_content_unset() function.
4455 * @param obj The inwin object
4456 * @param content The object to set as content
4458 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4460 * Get the content of an inwin object.
4462 * Return the content object which is set for this widget.
4464 * The returned object is valid as long as the inwin is still alive and no
4465 * other content is set on it. Deleting the object will notify the inwin
4466 * about it and this one will be left empty.
4468 * If you need to remove an inwin's content to be reused somewhere else,
4469 * see elm_win_inwin_content_unset().
4471 * @param obj The inwin object
4472 * @return The content that is being used
4474 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4476 * Unset the content of an inwin object.
4478 * Unparent and return the content object which was set for this widget.
4480 * @param obj The inwin object
4481 * @return The content that was being used
4483 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4487 /* X specific calls - won't work on non-x engines (return 0) */
4490 * Get the Ecore_X_Window of an Evas_Object
4492 * @param obj The object
4494 * @return The Ecore_X_Window of @p obj
4498 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4500 /* smart callbacks called:
4501 * "delete,request" - the user requested to delete the window
4502 * "focus,in" - window got focus
4503 * "focus,out" - window lost focus
4504 * "moved" - window that holds the canvas was moved
4510 * @image html img/widget/bg/preview-00.png
4511 * @image latex img/widget/bg/preview-00.eps
4513 * @brief Background object, used for setting a solid color, image or Edje
4514 * group as background to a window or any container object.
4516 * The bg object is used for setting a solid background to a window or
4517 * packing into any container object. It works just like an image, but has
4518 * some properties useful to a background, like setting it to tiled,
4519 * centered, scaled or stretched.
4521 * Default contents parts of the bg widget that you can use for are:
4522 * @li "elm.swallow.content" - overlay of the bg
4524 * Here is some sample code using it:
4525 * @li @ref bg_01_example_page
4526 * @li @ref bg_02_example_page
4527 * @li @ref bg_03_example_page
4531 typedef enum _Elm_Bg_Option
4533 ELM_BG_OPTION_CENTER, /**< center the background */
4534 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
4535 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4536 ELM_BG_OPTION_TILE /**< tile background at its original size */
4540 * Add a new background to the parent
4542 * @param parent The parent object
4543 * @return The new object or NULL if it cannot be created
4547 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4550 * Set the file (image or edje) used for the background
4552 * @param obj The bg object
4553 * @param file The file path
4554 * @param group Optional key (group in Edje) within the file
4556 * This sets the image file used in the background object. The image (or edje)
4557 * will be stretched (retaining aspect if its an image file) to completely fill
4558 * the bg object. This may mean some parts are not visible.
4560 * @note Once the image of @p obj is set, a previously set one will be deleted,
4561 * even if @p file is NULL.
4565 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4568 * Get the file (image or edje) used for the background
4570 * @param obj The bg object
4571 * @param file The file path
4572 * @param group Optional key (group in Edje) within the file
4576 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4579 * Set the option used for the background image
4581 * @param obj The bg object
4582 * @param option The desired background option (TILE, SCALE)
4584 * This sets the option used for manipulating the display of the background
4585 * image. The image can be tiled or scaled.
4589 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4592 * Get the option used for the background image
4594 * @param obj The bg object
4595 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4599 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4601 * Set the option used for the background color
4603 * @param obj The bg object
4608 * This sets the color used for the background rectangle. Its range goes
4613 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4615 * Get the option used for the background color
4617 * @param obj The bg object
4624 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4627 * Set the overlay object used for the background object.
4629 * @param obj The bg object
4630 * @param overlay The overlay object
4632 * This provides a way for elm_bg to have an 'overlay' that will be on top
4633 * of the bg. Once the over object is set, a previously set one will be
4634 * deleted, even if you set the new one to NULL. If you want to keep that
4635 * old content object, use the elm_bg_overlay_unset() function.
4640 EINA_DEPRECATED EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4643 * Get the overlay object used for the background object.
4645 * @param obj The bg object
4646 * @return The content that is being used
4648 * Return the content object which is set for this widget
4652 EINA_DEPRECATED EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4655 * Get the overlay object used for the background object.
4657 * @param obj The bg object
4658 * @return The content that was being used
4660 * Unparent and return the overlay object which was set for this widget
4664 EINA_DEPRECATED EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4667 * Set the size of the pixmap representation of the image.
4669 * This option just makes sense if an image is going to be set in the bg.
4671 * @param obj The bg object
4672 * @param w The new width of the image pixmap representation.
4673 * @param h The new height of the image pixmap representation.
4675 * This function sets a new size for pixmap representation of the given bg
4676 * image. It allows the image to be loaded already in the specified size,
4677 * reducing the memory usage and load time when loading a big image with load
4678 * size set to a smaller size.
4680 * NOTE: this is just a hint, the real size of the pixmap may differ
4681 * depending on the type of image being loaded, being bigger than requested.
4685 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4686 /* smart callbacks called:
4690 * @defgroup Icon Icon
4692 * @image html img/widget/icon/preview-00.png
4693 * @image latex img/widget/icon/preview-00.eps
4695 * An object that provides standard icon images (delete, edit, arrows, etc.)
4696 * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4698 * The icon image requested can be in the elementary theme, or in the
4699 * freedesktop.org paths. It's possible to set the order of preference from
4700 * where the image will be used.
4702 * This API is very similar to @ref Image, but with ready to use images.
4704 * Default images provided by the theme are described below.
4706 * The first list contains icons that were first intended to be used in
4707 * toolbars, but can be used in many other places too:
4723 * Now some icons that were designed to be used in menus (but again, you can
4724 * use them anywhere else):
4729 * @li menu/arrow_down
4730 * @li menu/arrow_left
4731 * @li menu/arrow_right
4740 * And here we have some media player specific icons:
4741 * @li media_player/forward
4742 * @li media_player/info
4743 * @li media_player/next
4744 * @li media_player/pause
4745 * @li media_player/play
4746 * @li media_player/prev
4747 * @li media_player/rewind
4748 * @li media_player/stop
4750 * Signals that you can add callbacks for are:
4752 * "clicked" - This is called when a user has clicked the icon
4754 * An example of usage for this API follows:
4755 * @li @ref tutorial_icon
4763 typedef enum _Elm_Icon_Type
4770 * @enum _Elm_Icon_Lookup_Order
4771 * @typedef Elm_Icon_Lookup_Order
4773 * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4774 * theme, FDO paths, or both?
4778 typedef enum _Elm_Icon_Lookup_Order
4780 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4781 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4782 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
4783 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
4784 } Elm_Icon_Lookup_Order;
4787 * Add a new icon object to the parent.
4789 * @param parent The parent object
4790 * @return The new object or NULL if it cannot be created
4792 * @see elm_icon_file_set()
4796 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4798 * Set the file that will be used as icon.
4800 * @param obj The icon object
4801 * @param file The path to file that will be used as icon image
4802 * @param group The group that the icon belongs to an edje file
4804 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4806 * @note The icon image set by this function can be changed by
4807 * elm_icon_standard_set().
4809 * @see elm_icon_file_get()
4813 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4815 * Set a location in memory to be used as an icon
4817 * @param obj The icon object
4818 * @param img The binary data that will be used as an image
4819 * @param size The size of binary data @p img
4820 * @param format Optional format of @p img to pass to the image loader
4821 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
4823 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4825 * @note The icon image set by this function can be changed by
4826 * elm_icon_standard_set().
4830 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);
4832 * Get the file that will be used as icon.
4834 * @param obj The icon object
4835 * @param file The path to file that will be used as the icon image
4836 * @param group The group that the icon belongs to, in edje file
4838 * @see elm_icon_file_set()
4842 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4843 EAPI void elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4845 * Set the icon by icon standards names.
4847 * @param obj The icon object
4848 * @param name The icon name
4850 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4852 * For example, freedesktop.org defines standard icon names such as "home",
4853 * "network", etc. There can be different icon sets to match those icon
4854 * keys. The @p name given as parameter is one of these "keys", and will be
4855 * used to look in the freedesktop.org paths and elementary theme. One can
4856 * change the lookup order with elm_icon_order_lookup_set().
4858 * If name is not found in any of the expected locations and it is the
4859 * absolute path of an image file, this image will be used.
4861 * @note The icon image set by this function can be changed by
4862 * elm_icon_file_set().
4864 * @see elm_icon_standard_get()
4865 * @see elm_icon_file_set()
4869 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
4871 * Get the icon name set by icon standard names.
4873 * @param obj The icon object
4874 * @return The icon name
4876 * If the icon image was set using elm_icon_file_set() instead of
4877 * elm_icon_standard_set(), then this function will return @c NULL.
4879 * @see elm_icon_standard_set()
4883 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4885 * Set the smooth scaling for an icon object.
4887 * @param obj The icon object
4888 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4889 * otherwise. Default is @c EINA_TRUE.
4891 * Set the scaling algorithm to be used when scaling the icon image. Smooth
4892 * scaling provides a better resulting image, but is slower.
4894 * The smooth scaling should be disabled when making animations that change
4895 * the icon size, since they will be faster. Animations that don't require
4896 * resizing of the icon can keep the smooth scaling enabled (even if the icon
4897 * is already scaled, since the scaled icon image will be cached).
4899 * @see elm_icon_smooth_get()
4903 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4905 * Get whether smooth scaling is enabled for an icon object.
4907 * @param obj The icon object
4908 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4910 * @see elm_icon_smooth_set()
4914 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4916 * Disable scaling of this object.
4918 * @param obj The icon object.
4919 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4920 * otherwise. Default is @c EINA_FALSE.
4922 * This function disables scaling of the icon object through the function
4923 * elm_object_scale_set(). However, this does not affect the object
4924 * size/resize in any way. For that effect, take a look at
4925 * elm_icon_scale_set().
4927 * @see elm_icon_no_scale_get()
4928 * @see elm_icon_scale_set()
4929 * @see elm_object_scale_set()
4933 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
4935 * Get whether scaling is disabled on the object.
4937 * @param obj The icon object
4938 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
4940 * @see elm_icon_no_scale_set()
4944 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4946 * Set if the object is (up/down) resizable.
4948 * @param obj The icon object
4949 * @param scale_up A bool to set if the object is resizable up. Default is
4951 * @param scale_down A bool to set if the object is resizable down. Default
4954 * This function limits the icon object resize ability. If @p scale_up is set to
4955 * @c EINA_FALSE, the object can't have its height or width resized to a value
4956 * higher than the original icon size. Same is valid for @p scale_down.
4958 * @see elm_icon_scale_get()
4962 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
4964 * Get if the object is (up/down) resizable.
4966 * @param obj The icon object
4967 * @param scale_up A bool to set if the object is resizable up
4968 * @param scale_down A bool to set if the object is resizable down
4970 * @see elm_icon_scale_set()
4974 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
4976 * Get the object's image size
4978 * @param obj The icon object
4979 * @param w A pointer to store the width in
4980 * @param h A pointer to store the height in
4984 EAPI void elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4986 * Set if the icon fill the entire object area.
4988 * @param obj The icon object
4989 * @param fill_outside @c EINA_TRUE if the object is filled outside,
4990 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4992 * When the icon object is resized to a different aspect ratio from the
4993 * original icon image, the icon image will still keep its aspect. This flag
4994 * tells how the image should fill the object's area. They are: keep the
4995 * entire icon inside the limits of height and width of the object (@p
4996 * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
4997 * of the object, and the icon will fill the entire object (@p fill_outside
5000 * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
5001 * retain property to false. Thus, the icon image will always keep its
5002 * original aspect ratio.
5004 * @see elm_icon_fill_outside_get()
5005 * @see elm_image_fill_outside_set()
5009 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5011 * Get if the object is filled outside.
5013 * @param obj The icon object
5014 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5016 * @see elm_icon_fill_outside_set()
5020 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5022 * Set the prescale size for the icon.
5024 * @param obj The icon object
5025 * @param size The prescale size. This value is used for both width and
5028 * This function sets a new size for pixmap representation of the given
5029 * icon. It allows the icon to be loaded already in the specified size,
5030 * reducing the memory usage and load time when loading a big icon with load
5031 * size set to a smaller size.
5033 * It's equivalent to the elm_bg_load_size_set() function for bg.
5035 * @note this is just a hint, the real size of the pixmap may differ
5036 * depending on the type of icon being loaded, being bigger than requested.
5038 * @see elm_icon_prescale_get()
5039 * @see elm_bg_load_size_set()
5043 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5045 * Get the prescale size for the icon.
5047 * @param obj The icon object
5048 * @return The prescale size
5050 * @see elm_icon_prescale_set()
5054 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5056 * Gets the image object of the icon. DO NOT MODIFY THIS.
5058 * @param obj The icon object
5059 * @return The internal icon object
5063 EAPI Evas_Object *elm_icon_object_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5065 * Sets the icon lookup order used by elm_icon_standard_set().
5067 * @param obj The icon object
5068 * @param order The icon lookup order (can be one of
5069 * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
5070 * or ELM_ICON_LOOKUP_THEME)
5072 * @see elm_icon_order_lookup_get()
5073 * @see Elm_Icon_Lookup_Order
5077 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
5079 * Gets the icon lookup order.
5081 * @param obj The icon object
5082 * @return The icon lookup order
5084 * @see elm_icon_order_lookup_set()
5085 * @see Elm_Icon_Lookup_Order
5089 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5091 * Get if the icon supports animation or not.
5093 * @param obj The icon object
5094 * @return @c EINA_TRUE if the icon supports animation,
5095 * @c EINA_FALSE otherwise.
5097 * Return if this elm icon's image can be animated. Currently Evas only
5098 * supports gif animation. If the return value is EINA_FALSE, other
5099 * elm_icon_animated_XXX APIs won't work.
5102 EAPI Eina_Bool elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5104 * Set animation mode of the icon.
5106 * @param obj The icon object
5107 * @param anim @c EINA_TRUE if the object do animation job,
5108 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5110 * Since the default animation mode is set to EINA_FALSE,
5111 * the icon is shown without animation.
5112 * This might be desirable when the application developer wants to show
5113 * a snapshot of the animated icon.
5114 * Set it to EINA_TRUE when the icon needs to be animated.
5117 EAPI void elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
5119 * Get animation mode of the icon.
5121 * @param obj The icon object
5122 * @return The animation mode of the icon object
5123 * @see elm_icon_animated_set
5126 EAPI Eina_Bool elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5128 * Set animation play mode of the icon.
5130 * @param obj The icon object
5131 * @param play @c EINA_TRUE the object play animation images,
5132 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5134 * To play elm icon's animation, set play to EINA_TURE.
5135 * For example, you make gif player using this set/get API and click event.
5137 * 1. Click event occurs
5138 * 2. Check play flag using elm_icon_animaged_play_get
5139 * 3. If elm icon was playing, set play to EINA_FALSE.
5140 * Then animation will be stopped and vice versa
5143 EAPI void elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
5145 * Get animation play mode of the icon.
5147 * @param obj The icon object
5148 * @return The play mode of the icon object
5150 * @see elm_icon_animated_play_get
5153 EAPI Eina_Bool elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5160 * @defgroup Image Image
5162 * @image html img/widget/image/preview-00.png
5163 * @image latex img/widget/image/preview-00.eps
5166 * An object that allows one to load an image file to it. It can be used
5167 * anywhere like any other elementary widget.
5169 * This widget provides most of the functionality provided from @ref Bg or @ref
5170 * Icon, but with a slightly different API (use the one that fits better your
5173 * The features not provided by those two other image widgets are:
5174 * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
5175 * @li change the object orientation with elm_image_orient_set();
5176 * @li and turning the image editable with elm_image_editable_set().
5178 * Signals that you can add callbacks for are:
5180 * @li @c "clicked" - This is called when a user has clicked the image
5182 * An example of usage for this API follows:
5183 * @li @ref tutorial_image
5192 * @enum _Elm_Image_Orient
5193 * @typedef Elm_Image_Orient
5195 * Possible orientation options for elm_image_orient_set().
5197 * @image html elm_image_orient_set.png
5198 * @image latex elm_image_orient_set.eps width=\textwidth
5202 typedef enum _Elm_Image_Orient
5204 ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
5205 ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
5206 ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
5207 ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5208 ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
5209 ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
5210 ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
5211 ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
5215 * Add a new image to the parent.
5217 * @param parent The parent object
5218 * @return The new object or NULL if it cannot be created
5220 * @see elm_image_file_set()
5224 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5226 * Set the file that will be used as image.
5228 * @param obj The image object
5229 * @param file The path to file that will be used as image
5230 * @param group The group that the image belongs in edje file (if it's an
5233 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5235 * @see elm_image_file_get()
5239 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5241 * Get the file that will be used as image.
5243 * @param obj The image object
5244 * @param file The path to file
5245 * @param group The group that the image belongs in edje file
5247 * @see elm_image_file_set()
5251 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5253 * Set the smooth effect for an image.
5255 * @param obj The image object
5256 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5257 * otherwise. Default is @c EINA_TRUE.
5259 * Set the scaling algorithm to be used when scaling the image. Smooth
5260 * scaling provides a better resulting image, but is slower.
5262 * The smooth scaling should be disabled when making animations that change
5263 * the image size, since it will be faster. Animations that don't require
5264 * resizing of the image can keep the smooth scaling enabled (even if the
5265 * image is already scaled, since the scaled image will be cached).
5267 * @see elm_image_smooth_get()
5271 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5273 * Get the smooth effect for an image.
5275 * @param obj The image object
5276 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5278 * @see elm_image_smooth_get()
5282 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5285 * Gets the current size of the image.
5287 * @param obj The image object.
5288 * @param w Pointer to store width, or NULL.
5289 * @param h Pointer to store height, or NULL.
5291 * This is the real size of the image, not the size of the object.
5293 * On error, neither w or h will be written.
5297 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5299 * Disable scaling of this object.
5301 * @param obj The image object.
5302 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5303 * otherwise. Default is @c EINA_FALSE.
5305 * This function disables scaling of the elm_image widget through the
5306 * function elm_object_scale_set(). However, this does not affect the widget
5307 * size/resize in any way. For that effect, take a look at
5308 * elm_image_scale_set().
5310 * @see elm_image_no_scale_get()
5311 * @see elm_image_scale_set()
5312 * @see elm_object_scale_set()
5316 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5318 * Get whether scaling is disabled on the object.
5320 * @param obj The image object
5321 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5323 * @see elm_image_no_scale_set()
5327 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5329 * Set if the object is (up/down) resizable.
5331 * @param obj The image object
5332 * @param scale_up A bool to set if the object is resizable up. Default is
5334 * @param scale_down A bool to set if the object is resizable down. Default
5337 * This function limits the image resize ability. If @p scale_up is set to
5338 * @c EINA_FALSE, the object can't have its height or width resized to a value
5339 * higher than the original image size. Same is valid for @p scale_down.
5341 * @see elm_image_scale_get()
5345 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5347 * Get if the object is (up/down) resizable.
5349 * @param obj The image object
5350 * @param scale_up A bool to set if the object is resizable up
5351 * @param scale_down A bool to set if the object is resizable down
5353 * @see elm_image_scale_set()
5357 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5359 * Set if the image fills the entire object area, when keeping the aspect ratio.
5361 * @param obj The image object
5362 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5363 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5365 * When the image should keep its aspect ratio even if resized to another
5366 * aspect ratio, there are two possibilities to resize it: keep the entire
5367 * image inside the limits of height and width of the object (@p fill_outside
5368 * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5369 * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5371 * @note This option will have no effect if
5372 * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5374 * @see elm_image_fill_outside_get()
5375 * @see elm_image_aspect_ratio_retained_set()
5379 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5381 * Get if the object is filled outside
5383 * @param obj The image object
5384 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5386 * @see elm_image_fill_outside_set()
5390 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5392 * Set the prescale size for the image
5394 * @param obj The image object
5395 * @param size The prescale size. This value is used for both width and
5398 * This function sets a new size for pixmap representation of the given
5399 * image. It allows the image to be loaded already in the specified size,
5400 * reducing the memory usage and load time when loading a big image with load
5401 * size set to a smaller size.
5403 * It's equivalent to the elm_bg_load_size_set() function for bg.
5405 * @note this is just a hint, the real size of the pixmap may differ
5406 * depending on the type of image being loaded, being bigger than requested.
5408 * @see elm_image_prescale_get()
5409 * @see elm_bg_load_size_set()
5413 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5415 * Get the prescale size for the image
5417 * @param obj The image object
5418 * @return The prescale size
5420 * @see elm_image_prescale_set()
5424 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5426 * Set the image orientation.
5428 * @param obj The image object
5429 * @param orient The image orientation @ref Elm_Image_Orient
5430 * Default is #ELM_IMAGE_ORIENT_NONE.
5432 * This function allows to rotate or flip the given image.
5434 * @see elm_image_orient_get()
5435 * @see @ref Elm_Image_Orient
5439 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5441 * Get the image orientation.
5443 * @param obj The image object
5444 * @return The image orientation @ref Elm_Image_Orient
5446 * @see elm_image_orient_set()
5447 * @see @ref Elm_Image_Orient
5451 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5453 * Make the image 'editable'.
5455 * @param obj Image object.
5456 * @param set Turn on or off editability. Default is @c EINA_FALSE.
5458 * This means the image is a valid drag target for drag and drop, and can be
5459 * cut or pasted too.
5463 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5465 * Check if the image 'editable'.
5467 * @param obj Image object.
5468 * @return Editability.
5470 * A return value of EINA_TRUE means the image is a valid drag target
5471 * for drag and drop, and can be cut or pasted too.
5475 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5477 * Get the basic Evas_Image object from this object (widget).
5479 * @param obj The image object to get the inlined image from
5480 * @return The inlined image object, or NULL if none exists
5482 * This function allows one to get the underlying @c Evas_Object of type
5483 * Image from this elementary widget. It can be useful to do things like get
5484 * the pixel data, save the image to a file, etc.
5486 * @note Be careful to not manipulate it, as it is under control of
5491 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5493 * Set whether the original aspect ratio of the image should be kept on resize.
5495 * @param obj The image object.
5496 * @param retained @c EINA_TRUE if the image should retain the aspect,
5497 * @c EINA_FALSE otherwise.
5499 * The original aspect ratio (width / height) of the image is usually
5500 * distorted to match the object's size. Enabling this option will retain
5501 * this original aspect, and the way that the image is fit into the object's
5502 * area depends on the option set by elm_image_fill_outside_set().
5504 * @see elm_image_aspect_ratio_retained_get()
5505 * @see elm_image_fill_outside_set()
5509 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5511 * Get if the object retains the original aspect ratio.
5513 * @param obj The image object.
5514 * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5519 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5526 typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5528 typedef enum _Elm_GLView_Mode
5530 ELM_GLVIEW_ALPHA = 1,
5531 ELM_GLVIEW_DEPTH = 2,
5532 ELM_GLVIEW_STENCIL = 4
5536 * Defines a policy for the glview resizing.
5538 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5540 typedef enum _Elm_GLView_Resize_Policy
5542 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
5543 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
5544 } Elm_GLView_Resize_Policy;
5546 typedef enum _Elm_GLView_Render_Policy
5548 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
5549 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
5550 } Elm_GLView_Render_Policy;
5555 * A simple GLView widget that allows GL rendering.
5557 * Signals that you can add callbacks for are:
5563 * Add a new glview to the parent
5565 * @param parent The parent object
5566 * @return The new object or NULL if it cannot be created
5570 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5573 * Sets the size of the glview
5575 * @param obj The glview object
5576 * @param width width of the glview object
5577 * @param height height of the glview object
5581 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5584 * Gets the size of the glview.
5586 * @param obj The glview object
5587 * @param width width of the glview object
5588 * @param height height of the glview object
5590 * Note that this function returns the actual image size of the
5591 * glview. This means that when the scale policy is set to
5592 * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5597 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5600 * Gets the gl api struct for gl rendering
5602 * @param obj The glview object
5603 * @return The api object or NULL if it cannot be created
5607 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5610 * Set the mode of the GLView. Supports Three simple modes.
5612 * @param obj The glview object
5613 * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5614 * @return True if set properly.
5618 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5621 * Set the resize policy for the glview object.
5623 * @param obj The glview object.
5624 * @param policy The scaling policy.
5626 * By default, the resize policy is set to
5627 * ELM_GLVIEW_RESIZE_POLICY_RECREATE. When resize is called it
5628 * destroys the previous surface and recreates the newly specified
5629 * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5630 * however, glview only scales the image object and not the underlying
5635 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5638 * Set the render policy for the glview object.
5640 * @param obj The glview object.
5641 * @param policy The render policy.
5643 * By default, the render policy is set to
5644 * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND. This policy is set such
5645 * that during the render loop, glview is only redrawn if it needs
5646 * to be redrawn. (i.e. When it is visible) If the policy is set to
5647 * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5648 * whether it is visible/need redrawing or not.
5652 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5655 * Set the init function that runs once in the main loop.
5657 * @param obj The glview object.
5658 * @param func The init function to be registered.
5660 * The registered init function gets called once during the render loop.
5664 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5667 * Set the render function that runs in the main loop.
5669 * @param obj The glview object.
5670 * @param func The delete function to be registered.
5672 * The registered del function gets called when GLView object is deleted.
5676 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5679 * Set the resize function that gets called when resize happens.
5681 * @param obj The glview object.
5682 * @param func The resize function to be registered.
5686 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5689 * Set the render function that runs in the main loop.
5691 * @param obj The glview object.
5692 * @param func The render function to be registered.
5696 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5699 * Notifies that there has been changes in the GLView.
5701 * @param obj The glview object.
5705 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5715 * @image html img/widget/box/preview-00.png
5716 * @image latex img/widget/box/preview-00.eps width=\textwidth
5718 * @image html img/box.png
5719 * @image latex img/box.eps width=\textwidth
5721 * A box arranges objects in a linear fashion, governed by a layout function
5722 * that defines the details of this arrangement.
5724 * By default, the box will use an internal function to set the layout to
5725 * a single row, either vertical or horizontal. This layout is affected
5726 * by a number of parameters, such as the homogeneous flag set by
5727 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5728 * elm_box_align_set() and the hints set to each object in the box.
5730 * For this default layout, it's possible to change the orientation with
5731 * elm_box_horizontal_set(). The box will start in the vertical orientation,
5732 * placing its elements ordered from top to bottom. When horizontal is set,
5733 * the order will go from left to right. If the box is set to be
5734 * homogeneous, every object in it will be assigned the same space, that
5735 * of the largest object. Padding can be used to set some spacing between
5736 * the cell given to each object. The alignment of the box, set with
5737 * elm_box_align_set(), determines how the bounding box of all the elements
5738 * will be placed within the space given to the box widget itself.
5740 * The size hints of each object also affect how they are placed and sized
5741 * within the box. evas_object_size_hint_min_set() will give the minimum
5742 * size the object can have, and the box will use it as the basis for all
5743 * latter calculations. Elementary widgets set their own minimum size as
5744 * needed, so there's rarely any need to use it manually.
5746 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5747 * used to tell whether the object will be allocated the minimum size it
5748 * needs or if the space given to it should be expanded. It's important
5749 * to realize that expanding the size given to the object is not the same
5750 * thing as resizing the object. It could very well end being a small
5751 * widget floating in a much larger empty space. If not set, the weight
5752 * for objects will normally be 0.0 for both axis, meaning the widget will
5753 * not be expanded. To take as much space possible, set the weight to
5754 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5756 * Besides how much space each object is allocated, it's possible to control
5757 * how the widget will be placed within that space using
5758 * evas_object_size_hint_align_set(). By default, this value will be 0.5
5759 * for both axis, meaning the object will be centered, but any value from
5760 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5761 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5762 * is -1.0, means the object will be resized to fill the entire space it
5765 * In addition, customized functions to define the layout can be set, which
5766 * allow the application developer to organize the objects within the box
5767 * in any number of ways.
5769 * The special elm_box_layout_transition() function can be used
5770 * to switch from one layout to another, animating the motion of the
5771 * children of the box.
5773 * @note Objects should not be added to box objects using _add() calls.
5775 * Some examples on how to use boxes follow:
5776 * @li @ref box_example_01
5777 * @li @ref box_example_02
5782 * @typedef Elm_Box_Transition
5784 * Opaque handler containing the parameters to perform an animated
5785 * transition of the layout the box uses.
5787 * @see elm_box_transition_new()
5788 * @see elm_box_layout_set()
5789 * @see elm_box_layout_transition()
5791 typedef struct _Elm_Box_Transition Elm_Box_Transition;
5794 * Add a new box to the parent
5796 * By default, the box will be in vertical mode and non-homogeneous.
5798 * @param parent The parent object
5799 * @return The new object or NULL if it cannot be created
5801 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5803 * Set the horizontal orientation
5805 * By default, box object arranges their contents vertically from top to
5807 * By calling this function with @p horizontal as EINA_TRUE, the box will
5808 * become horizontal, arranging contents from left to right.
5810 * @note This flag is ignored if a custom layout function is set.
5812 * @param obj The box object
5813 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5814 * EINA_FALSE = vertical)
5816 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5818 * Get the horizontal orientation
5820 * @param obj The box object
5821 * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
5823 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5825 * Set the box to arrange its children homogeneously
5827 * If enabled, homogeneous layout makes all items the same size, according
5828 * to the size of the largest of its children.
5830 * @note This flag is ignored if a custom layout function is set.
5832 * @param obj The box object
5833 * @param homogeneous The homogeneous flag
5835 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5837 * Get whether the box is using homogeneous mode or not
5839 * @param obj The box object
5840 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5842 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5843 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5844 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5846 * Add an object to the beginning of the pack list
5848 * Pack @p subobj into the box @p obj, placing it first in the list of
5849 * children objects. The actual position the object will get on screen
5850 * depends on the layout used. If no custom layout is set, it will be at
5851 * the top or left, depending if the box is vertical or horizontal,
5854 * @param obj The box object
5855 * @param subobj The object to add to the box
5857 * @see elm_box_pack_end()
5858 * @see elm_box_pack_before()
5859 * @see elm_box_pack_after()
5860 * @see elm_box_unpack()
5861 * @see elm_box_unpack_all()
5862 * @see elm_box_clear()
5864 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5866 * Add an object at the end of the pack list
5868 * Pack @p subobj into the box @p obj, placing it last in the list of
5869 * children objects. The actual position the object will get on screen
5870 * depends on the layout used. If no custom layout is set, it will be at
5871 * the bottom or right, depending if the box is vertical or horizontal,
5874 * @param obj The box object
5875 * @param subobj The object to add to the box
5877 * @see elm_box_pack_start()
5878 * @see elm_box_pack_before()
5879 * @see elm_box_pack_after()
5880 * @see elm_box_unpack()
5881 * @see elm_box_unpack_all()
5882 * @see elm_box_clear()
5884 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5886 * Adds an object to the box before the indicated object
5888 * This will add the @p subobj to the box indicated before the object
5889 * indicated with @p before. If @p before is not already in the box, results
5890 * are undefined. Before means either to the left of the indicated object or
5891 * above it depending on orientation.
5893 * @param obj The box object
5894 * @param subobj The object to add to the box
5895 * @param before The object before which to add it
5897 * @see elm_box_pack_start()
5898 * @see elm_box_pack_end()
5899 * @see elm_box_pack_after()
5900 * @see elm_box_unpack()
5901 * @see elm_box_unpack_all()
5902 * @see elm_box_clear()
5904 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
5906 * Adds an object to the box after the indicated object
5908 * This will add the @p subobj to the box indicated after the object
5909 * indicated with @p after. If @p after is not already in the box, results
5910 * are undefined. After means either to the right of the indicated object or
5911 * below it depending on orientation.
5913 * @param obj The box object
5914 * @param subobj The object to add to the box
5915 * @param after The object after which to add it
5917 * @see elm_box_pack_start()
5918 * @see elm_box_pack_end()
5919 * @see elm_box_pack_before()
5920 * @see elm_box_unpack()
5921 * @see elm_box_unpack_all()
5922 * @see elm_box_clear()
5924 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
5926 * Clear the box of all children
5928 * Remove all the elements contained by the box, deleting the respective
5931 * @param obj The box object
5933 * @see elm_box_unpack()
5934 * @see elm_box_unpack_all()
5936 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5940 * Remove the object given by @p subobj from the box @p obj without
5943 * @param obj The box object
5945 * @see elm_box_unpack_all()
5946 * @see elm_box_clear()
5948 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5950 * Remove all items from the box, without deleting them
5952 * Clear the box from all children, but don't delete the respective objects.
5953 * If no other references of the box children exist, the objects will never
5954 * be deleted, and thus the application will leak the memory. Make sure
5955 * when using this function that you hold a reference to all the objects
5956 * in the box @p obj.
5958 * @param obj The box object
5960 * @see elm_box_clear()
5961 * @see elm_box_unpack()
5963 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5965 * Retrieve a list of the objects packed into the box
5967 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
5968 * The order of the list corresponds to the packing order the box uses.
5970 * You must free this list with eina_list_free() once you are done with it.
5972 * @param obj The box object
5974 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5976 * Set the space (padding) between the box's elements.
5978 * Extra space in pixels that will be added between a box child and its
5979 * neighbors after its containing cell has been calculated. This padding
5980 * is set for all elements in the box, besides any possible padding that
5981 * individual elements may have through their size hints.
5983 * @param obj The box object
5984 * @param horizontal The horizontal space between elements
5985 * @param vertical The vertical space between elements
5987 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5989 * Get the space (padding) between the box's elements.
5991 * @param obj The box object
5992 * @param horizontal The horizontal space between elements
5993 * @param vertical The vertical space between elements
5995 * @see elm_box_padding_set()
5997 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5999 * Set the alignment of the whole bouding box of contents.
6001 * Sets how the bounding box containing all the elements of the box, after
6002 * their sizes and position has been calculated, will be aligned within
6003 * the space given for the whole box widget.
6005 * @param obj The box object
6006 * @param horizontal The horizontal alignment of elements
6007 * @param vertical The vertical alignment of elements
6009 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
6011 * Get the alignment of the whole bouding box of contents.
6013 * @param obj The box object
6014 * @param horizontal The horizontal alignment of elements
6015 * @param vertical The vertical alignment of elements
6017 * @see elm_box_align_set()
6019 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
6022 * Force the box to recalculate its children packing.
6024 * If any children was added or removed, box will not calculate the
6025 * values immediately rather leaving it to the next main loop
6026 * iteration. While this is great as it would save lots of
6027 * recalculation, whenever you need to get the position of a just
6028 * added item you must force recalculate before doing so.
6030 * @param obj The box object.
6032 EAPI void elm_box_recalculate(Evas_Object *obj);
6035 * Set the layout defining function to be used by the box
6037 * Whenever anything changes that requires the box in @p obj to recalculate
6038 * the size and position of its elements, the function @p cb will be called
6039 * to determine what the layout of the children will be.
6041 * Once a custom function is set, everything about the children layout
6042 * is defined by it. The flags set by elm_box_horizontal_set() and
6043 * elm_box_homogeneous_set() no longer have any meaning, and the values
6044 * given by elm_box_padding_set() and elm_box_align_set() are up to this
6045 * layout function to decide if they are used and how. These last two
6046 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
6047 * passed to @p cb. The @c Evas_Object the function receives is not the
6048 * Elementary widget, but the internal Evas Box it uses, so none of the
6049 * functions described here can be used on it.
6051 * Any of the layout functions in @c Evas can be used here, as well as the
6052 * special elm_box_layout_transition().
6054 * The final @p data argument received by @p cb is the same @p data passed
6055 * here, and the @p free_data function will be called to free it
6056 * whenever the box is destroyed or another layout function is set.
6058 * Setting @p cb to NULL will revert back to the default layout function.
6060 * @param obj The box object
6061 * @param cb The callback function used for layout
6062 * @param data Data that will be passed to layout function
6063 * @param free_data Function called to free @p data
6065 * @see elm_box_layout_transition()
6067 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);
6069 * Special layout function that animates the transition from one layout to another
6071 * Normally, when switching the layout function for a box, this will be
6072 * reflected immediately on screen on the next render, but it's also
6073 * possible to do this through an animated transition.
6075 * This is done by creating an ::Elm_Box_Transition and setting the box
6076 * layout to this function.
6080 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
6081 * evas_object_box_layout_vertical, // start
6082 * NULL, // data for initial layout
6083 * NULL, // free function for initial data
6084 * evas_object_box_layout_horizontal, // end
6085 * NULL, // data for final layout
6086 * NULL, // free function for final data
6087 * anim_end, // will be called when animation ends
6088 * NULL); // data for anim_end function\
6089 * elm_box_layout_set(box, elm_box_layout_transition, t,
6090 * elm_box_transition_free);
6093 * @note This function can only be used with elm_box_layout_set(). Calling
6094 * it directly will not have the expected results.
6096 * @see elm_box_transition_new
6097 * @see elm_box_transition_free
6098 * @see elm_box_layout_set
6100 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
6102 * Create a new ::Elm_Box_Transition to animate the switch of layouts
6104 * If you want to animate the change from one layout to another, you need
6105 * to set the layout function of the box to elm_box_layout_transition(),
6106 * passing as user data to it an instance of ::Elm_Box_Transition with the
6107 * necessary information to perform this animation. The free function to
6108 * set for the layout is elm_box_transition_free().
6110 * The parameters to create an ::Elm_Box_Transition sum up to how long
6111 * will it be, in seconds, a layout function to describe the initial point,
6112 * another for the final position of the children and one function to be
6113 * called when the whole animation ends. This last function is useful to
6114 * set the definitive layout for the box, usually the same as the end
6115 * layout for the animation, but could be used to start another transition.
6117 * @param start_layout The layout function that will be used to start the animation
6118 * @param start_layout_data The data to be passed the @p start_layout function
6119 * @param start_layout_free_data Function to free @p start_layout_data
6120 * @param end_layout The layout function that will be used to end the animation
6121 * @param end_layout_free_data The data to be passed the @p end_layout function
6122 * @param end_layout_free_data Function to free @p end_layout_data
6123 * @param transition_end_cb Callback function called when animation ends
6124 * @param transition_end_data Data to be passed to @p transition_end_cb
6125 * @return An instance of ::Elm_Box_Transition
6127 * @see elm_box_transition_new
6128 * @see elm_box_layout_transition
6130 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);
6132 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
6134 * This function is mostly useful as the @c free_data parameter in
6135 * elm_box_layout_set() when elm_box_layout_transition().
6137 * @param data The Elm_Box_Transition instance to be freed.
6139 * @see elm_box_transition_new
6140 * @see elm_box_layout_transition
6142 EAPI void elm_box_transition_free(void *data);
6149 * @defgroup Button Button
6151 * @image html img/widget/button/preview-00.png
6152 * @image latex img/widget/button/preview-00.eps
6153 * @image html img/widget/button/preview-01.png
6154 * @image latex img/widget/button/preview-01.eps
6155 * @image html img/widget/button/preview-02.png
6156 * @image latex img/widget/button/preview-02.eps
6158 * This is a push-button. Press it and run some function. It can contain
6159 * a simple label and icon object and it also has an autorepeat feature.
6161 * This widgets emits the following signals:
6162 * @li "clicked": the user clicked the button (press/release).
6163 * @li "repeated": the user pressed the button without releasing it.
6164 * @li "pressed": button was pressed.
6165 * @li "unpressed": button was released after being pressed.
6166 * In all three cases, the @c event parameter of the callback will be
6169 * Also, defined in the default theme, the button has the following styles
6171 * @li default: a normal button.
6172 * @li anchor: Like default, but the button fades away when the mouse is not
6173 * over it, leaving only the text or icon.
6174 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
6175 * continuous look across its options.
6176 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
6178 * Default contents parts of the button widget that you can use for are:
6179 * @li "elm.swallow.content" - A icon of the button
6181 * Default text parts of the button widget that you can use for are:
6182 * @li "elm.text" - Label of the button
6184 * Follow through a complete example @ref button_example_01 "here".
6188 * Add a new button to the parent's canvas
6190 * @param parent The parent object
6191 * @return The new object or NULL if it cannot be created
6193 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6195 * Set the label used in the button
6197 * The passed @p label can be NULL to clean any existing text in it and
6198 * leave the button as an icon only object.
6200 * @param obj The button object
6201 * @param label The text will be written on the button
6202 * @deprecated use elm_object_text_set() instead.
6204 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6206 * Get the label set for the button
6208 * The string returned is an internal pointer and should not be freed or
6209 * altered. It will also become invalid when the button is destroyed.
6210 * The string returned, if not NULL, is a stringshare, so if you need to
6211 * keep it around even after the button is destroyed, you can use
6212 * eina_stringshare_ref().
6214 * @param obj The button object
6215 * @return The text set to the label, or NULL if nothing is set
6216 * @deprecated use elm_object_text_set() instead.
6218 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6220 * Set the icon used for the button
6222 * Setting a new icon will delete any other that was previously set, making
6223 * any reference to them invalid. If you need to maintain the previous
6224 * object alive, unset it first with elm_button_icon_unset().
6226 * @param obj The button object
6227 * @param icon The icon object for the button
6228 * @deprecated use elm_object_content_set() instead.
6230 EINA_DEPRECATED EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6232 * Get the icon used for the button
6234 * Return the icon object which is set for this widget. If the button is
6235 * destroyed or another icon is set, the returned object will be deleted
6236 * and any reference to it will be invalid.
6238 * @param obj The button object
6239 * @return The icon object that is being used
6241 * @see elm_button_icon_unset()
6243 EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6245 * Remove the icon set without deleting it and return the object
6247 * This function drops the reference the button holds of the icon object
6248 * and returns this last object. It is used in case you want to remove any
6249 * icon, or set another one, without deleting the actual object. The button
6250 * will be left without an icon set.
6252 * @param obj The button object
6253 * @return The icon object that was being used
6254 * @deprecated use elm_object_content_unset() instead.
6256 EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6258 * Turn on/off the autorepeat event generated when the button is kept pressed
6260 * When off, no autorepeat is performed and buttons emit a normal @c clicked
6261 * signal when they are clicked.
6263 * When on, keeping a button pressed will continuously emit a @c repeated
6264 * signal until the button is released. The time it takes until it starts
6265 * emitting the signal is given by
6266 * elm_button_autorepeat_initial_timeout_set(), and the time between each
6267 * new emission by elm_button_autorepeat_gap_timeout_set().
6269 * @param obj The button object
6270 * @param on A bool to turn on/off the event
6272 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6274 * Get whether the autorepeat feature is enabled
6276 * @param obj The button object
6277 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6279 * @see elm_button_autorepeat_set()
6281 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6283 * Set the initial timeout before the autorepeat event is generated
6285 * Sets the timeout, in seconds, since the button is pressed until the
6286 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6287 * won't be any delay and the even will be fired the moment the button is
6290 * @param obj The button object
6291 * @param t Timeout in seconds
6293 * @see elm_button_autorepeat_set()
6294 * @see elm_button_autorepeat_gap_timeout_set()
6296 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6298 * Get the initial timeout before the autorepeat event is generated
6300 * @param obj The button object
6301 * @return Timeout in seconds
6303 * @see elm_button_autorepeat_initial_timeout_set()
6305 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6307 * Set the interval between each generated autorepeat event
6309 * After the first @c repeated event is fired, all subsequent ones will
6310 * follow after a delay of @p t seconds for each.
6312 * @param obj The button object
6313 * @param t Interval in seconds
6315 * @see elm_button_autorepeat_initial_timeout_set()
6317 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6319 * Get the interval between each generated autorepeat event
6321 * @param obj The button object
6322 * @return Interval in seconds
6324 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6330 * @defgroup File_Selector_Button File Selector Button
6332 * @image html img/widget/fileselector_button/preview-00.png
6333 * @image latex img/widget/fileselector_button/preview-00.eps
6334 * @image html img/widget/fileselector_button/preview-01.png
6335 * @image latex img/widget/fileselector_button/preview-01.eps
6336 * @image html img/widget/fileselector_button/preview-02.png
6337 * @image latex img/widget/fileselector_button/preview-02.eps
6339 * This is a button that, when clicked, creates an Elementary
6340 * window (or inner window) <b> with a @ref Fileselector "file
6341 * selector widget" within</b>. When a file is chosen, the (inner)
6342 * window is closed and the button emits a signal having the
6343 * selected file as it's @c event_info.
6345 * This widget encapsulates operations on its internal file
6346 * selector on its own API. There is less control over its file
6347 * selector than that one would have instatiating one directly.
6349 * The following styles are available for this button:
6352 * @li @c "hoversel_vertical"
6353 * @li @c "hoversel_vertical_entry"
6355 * Smart callbacks one can register to:
6356 * - @c "file,chosen" - the user has selected a path, whose string
6357 * pointer comes as the @c event_info data (a stringshared
6360 * Here is an example on its usage:
6361 * @li @ref fileselector_button_example
6363 * @see @ref File_Selector_Entry for a similar widget.
6368 * Add a new file selector button widget to the given parent
6369 * Elementary (container) object
6371 * @param parent The parent object
6372 * @return a new file selector button widget handle or @c NULL, on
6375 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6378 * Set the label for a given file selector button widget
6380 * @param obj The file selector button widget
6381 * @param label The text label to be displayed on @p obj
6383 * @deprecated use elm_object_text_set() instead.
6385 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6388 * Get the label set for a given file selector button widget
6390 * @param obj The file selector button widget
6391 * @return The button label
6393 * @deprecated use elm_object_text_set() instead.
6395 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6398 * Set the icon on a given file selector button widget
6400 * @param obj The file selector button widget
6401 * @param icon The icon object for the button
6403 * Once the icon object is set, a previously set one will be
6404 * deleted. If you want to keep the latter, use the
6405 * elm_fileselector_button_icon_unset() function.
6407 * @see elm_fileselector_button_icon_get()
6409 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6412 * Get the icon set for a given file selector button widget
6414 * @param obj The file selector button widget
6415 * @return The icon object currently set on @p obj or @c NULL, if
6418 * @see elm_fileselector_button_icon_set()
6420 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6423 * Unset the icon used in a given file selector button widget
6425 * @param obj The file selector button widget
6426 * @return The icon object that was being used on @p obj or @c
6429 * Unparent and return the icon object which was set for this
6432 * @see elm_fileselector_button_icon_set()
6434 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6437 * Set the title for a given file selector button widget's window
6439 * @param obj The file selector button widget
6440 * @param title The title string
6442 * This will change the window's title, when the file selector pops
6443 * out after a click on the button. Those windows have the default
6444 * (unlocalized) value of @c "Select a file" as titles.
6446 * @note It will only take any effect if the file selector
6447 * button widget is @b not under "inwin mode".
6449 * @see elm_fileselector_button_window_title_get()
6451 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6454 * Get the title set for a given file selector button widget's
6457 * @param obj The file selector button widget
6458 * @return Title of the file selector button's window
6460 * @see elm_fileselector_button_window_title_get() for more details
6462 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6465 * Set the size of a given file selector button widget's window,
6466 * holding the file selector itself.
6468 * @param obj The file selector button widget
6469 * @param width The window's width
6470 * @param height The window's height
6472 * @note it will only take any effect if the file selector button
6473 * widget is @b not under "inwin mode". The default size for the
6474 * window (when applicable) is 400x400 pixels.
6476 * @see elm_fileselector_button_window_size_get()
6478 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6481 * Get the size of a given file selector button widget's window,
6482 * holding the file selector itself.
6484 * @param obj The file selector button widget
6485 * @param width Pointer into which to store the width value
6486 * @param height Pointer into which to store the height value
6488 * @note Use @c NULL pointers on the size values you're not
6489 * interested in: they'll be ignored by the function.
6491 * @see elm_fileselector_button_window_size_set(), for more details
6493 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6496 * Set the initial file system path for a given file selector
6499 * @param obj The file selector button widget
6500 * @param path The path string
6502 * It must be a <b>directory</b> path, which will have the contents
6503 * displayed initially in the file selector's view, when invoked
6504 * from @p obj. The default initial path is the @c "HOME"
6505 * environment variable's value.
6507 * @see elm_fileselector_button_path_get()
6509 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6512 * Get the initial file system path set for a given file selector
6515 * @param obj The file selector button widget
6516 * @return path The path string
6518 * @see elm_fileselector_button_path_set() for more details
6520 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6523 * Enable/disable a tree view in the given file selector button
6524 * widget's internal file selector
6526 * @param obj The file selector button widget
6527 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6530 * This has the same effect as elm_fileselector_expandable_set(),
6531 * but now applied to a file selector button's internal file
6534 * @note There's no way to put a file selector button's internal
6535 * file selector in "grid mode", as one may do with "pure" file
6538 * @see elm_fileselector_expandable_get()
6540 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6543 * Get whether tree view is enabled for the given file selector
6544 * button widget's internal file selector
6546 * @param obj The file selector button widget
6547 * @return @c EINA_TRUE if @p obj widget's internal file selector
6548 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6550 * @see elm_fileselector_expandable_set() for more details
6552 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6555 * Set whether a given file selector button widget's internal file
6556 * selector is to display folders only or the directory contents,
6559 * @param obj The file selector button widget
6560 * @param only @c EINA_TRUE to make @p obj widget's internal file
6561 * selector only display directories, @c EINA_FALSE to make files
6562 * to be displayed in it too
6564 * This has the same effect as elm_fileselector_folder_only_set(),
6565 * but now applied to a file selector button's internal file
6568 * @see elm_fileselector_folder_only_get()
6570 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6573 * Get whether a given file selector button widget's internal file
6574 * selector is displaying folders only or the directory contents,
6577 * @param obj The file selector button widget
6578 * @return @c EINA_TRUE if @p obj widget's internal file
6579 * selector is only displaying directories, @c EINA_FALSE if files
6580 * are being displayed in it too (and on errors)
6582 * @see elm_fileselector_button_folder_only_set() for more details
6584 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6587 * Enable/disable the file name entry box where the user can type
6588 * in a name for a file, in a given file selector button widget's
6589 * internal file selector.
6591 * @param obj The file selector button widget
6592 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6593 * file selector a "saving dialog", @c EINA_FALSE otherwise
6595 * This has the same effect as elm_fileselector_is_save_set(),
6596 * but now applied to a file selector button's internal file
6599 * @see elm_fileselector_is_save_get()
6601 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6604 * Get whether the given file selector button widget's internal
6605 * file selector is in "saving dialog" mode
6607 * @param obj The file selector button widget
6608 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6609 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6612 * @see elm_fileselector_button_is_save_set() for more details
6614 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6617 * Set whether a given file selector button widget's internal file
6618 * selector will raise an Elementary "inner window", instead of a
6619 * dedicated Elementary window. By default, it won't.
6621 * @param obj The file selector button widget
6622 * @param value @c EINA_TRUE to make it use an inner window, @c
6623 * EINA_TRUE to make it use a dedicated window
6625 * @see elm_win_inwin_add() for more information on inner windows
6626 * @see elm_fileselector_button_inwin_mode_get()
6628 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6631 * Get whether a given file selector button widget's internal file
6632 * selector will raise an Elementary "inner window", instead of a
6633 * dedicated Elementary window.
6635 * @param obj The file selector button widget
6636 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6637 * if it will use a dedicated window
6639 * @see elm_fileselector_button_inwin_mode_set() for more details
6641 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6648 * @defgroup File_Selector_Entry File Selector Entry
6650 * @image html img/widget/fileselector_entry/preview-00.png
6651 * @image latex img/widget/fileselector_entry/preview-00.eps
6653 * This is an entry made to be filled with or display a <b>file
6654 * system path string</b>. Besides the entry itself, the widget has
6655 * a @ref File_Selector_Button "file selector button" on its side,
6656 * which will raise an internal @ref Fileselector "file selector widget",
6657 * when clicked, for path selection aided by file system
6660 * This file selector may appear in an Elementary window or in an
6661 * inner window. When a file is chosen from it, the (inner) window
6662 * is closed and the selected file's path string is exposed both as
6663 * an smart event and as the new text on the entry.
6665 * This widget encapsulates operations on its internal file
6666 * selector on its own API. There is less control over its file
6667 * selector than that one would have instatiating one directly.
6669 * Smart callbacks one can register to:
6670 * - @c "changed" - The text within the entry was changed
6671 * - @c "activated" - The entry has had editing finished and
6672 * changes are to be "committed"
6673 * - @c "press" - The entry has been clicked
6674 * - @c "longpressed" - The entry has been clicked (and held) for a
6676 * - @c "clicked" - The entry has been clicked
6677 * - @c "clicked,double" - The entry has been double clicked
6678 * - @c "focused" - The entry has received focus
6679 * - @c "unfocused" - The entry has lost focus
6680 * - @c "selection,paste" - A paste action has occurred on the
6682 * - @c "selection,copy" - A copy action has occurred on the entry
6683 * - @c "selection,cut" - A cut action has occurred on the entry
6684 * - @c "unpressed" - The file selector entry's button was released
6685 * after being pressed.
6686 * - @c "file,chosen" - The user has selected a path via the file
6687 * selector entry's internal file selector, whose string pointer
6688 * comes as the @c event_info data (a stringshared string)
6690 * Here is an example on its usage:
6691 * @li @ref fileselector_entry_example
6693 * @see @ref File_Selector_Button for a similar widget.
6698 * Add a new file selector entry widget to the given parent
6699 * Elementary (container) object
6701 * @param parent The parent object
6702 * @return a new file selector entry widget handle or @c NULL, on
6705 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6708 * Set the label for a given file selector entry widget's button
6710 * @param obj The file selector entry widget
6711 * @param label The text label to be displayed on @p obj widget's
6714 * @deprecated use elm_object_text_set() instead.
6716 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6719 * Get the label set for a given file selector entry widget's button
6721 * @param obj The file selector entry widget
6722 * @return The widget button's label
6724 * @deprecated use elm_object_text_set() instead.
6726 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6729 * Set the icon on a given file selector entry widget's button
6731 * @param obj The file selector entry widget
6732 * @param icon The icon object for the entry's button
6734 * Once the icon object is set, a previously set one will be
6735 * deleted. If you want to keep the latter, use the
6736 * elm_fileselector_entry_button_icon_unset() function.
6738 * @see elm_fileselector_entry_button_icon_get()
6740 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6743 * Get the icon set for a given file selector entry widget's button
6745 * @param obj The file selector entry widget
6746 * @return The icon object currently set on @p obj widget's button
6747 * or @c NULL, if none is
6749 * @see elm_fileselector_entry_button_icon_set()
6751 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6754 * Unset the icon used in a given file selector entry widget's
6757 * @param obj The file selector entry widget
6758 * @return The icon object that was being used on @p obj widget's
6759 * button or @c NULL, on errors
6761 * Unparent and return the icon object which was set for this
6764 * @see elm_fileselector_entry_button_icon_set()
6766 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6769 * Set the title for a given file selector entry widget's window
6771 * @param obj The file selector entry widget
6772 * @param title The title string
6774 * This will change the window's title, when the file selector pops
6775 * out after a click on the entry's button. Those windows have the
6776 * default (unlocalized) value of @c "Select a file" as titles.
6778 * @note It will only take any effect if the file selector
6779 * entry widget is @b not under "inwin mode".
6781 * @see elm_fileselector_entry_window_title_get()
6783 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6786 * Get the title set for a given file selector entry widget's
6789 * @param obj The file selector entry widget
6790 * @return Title of the file selector entry's window
6792 * @see elm_fileselector_entry_window_title_get() for more details
6794 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6797 * Set the size of a given file selector entry widget's window,
6798 * holding the file selector itself.
6800 * @param obj The file selector entry widget
6801 * @param width The window's width
6802 * @param height The window's height
6804 * @note it will only take any effect if the file selector entry
6805 * widget is @b not under "inwin mode". The default size for the
6806 * window (when applicable) is 400x400 pixels.
6808 * @see elm_fileselector_entry_window_size_get()
6810 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6813 * Get the size of a given file selector entry widget's window,
6814 * holding the file selector itself.
6816 * @param obj The file selector entry widget
6817 * @param width Pointer into which to store the width value
6818 * @param height Pointer into which to store the height value
6820 * @note Use @c NULL pointers on the size values you're not
6821 * interested in: they'll be ignored by the function.
6823 * @see elm_fileselector_entry_window_size_set(), for more details
6825 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6828 * Set the initial file system path and the entry's path string for
6829 * a given file selector entry widget
6831 * @param obj The file selector entry widget
6832 * @param path The path string
6834 * It must be a <b>directory</b> path, which will have the contents
6835 * displayed initially in the file selector's view, when invoked
6836 * from @p obj. The default initial path is the @c "HOME"
6837 * environment variable's value.
6839 * @see elm_fileselector_entry_path_get()
6841 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6844 * Get the entry's path string for a given file selector entry
6847 * @param obj The file selector entry widget
6848 * @return path The path string
6850 * @see elm_fileselector_entry_path_set() for more details
6852 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6855 * Enable/disable a tree view in the given file selector entry
6856 * widget's internal file selector
6858 * @param obj The file selector entry widget
6859 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6862 * This has the same effect as elm_fileselector_expandable_set(),
6863 * but now applied to a file selector entry's internal file
6866 * @note There's no way to put a file selector entry's internal
6867 * file selector in "grid mode", as one may do with "pure" file
6870 * @see elm_fileselector_expandable_get()
6872 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6875 * Get whether tree view is enabled for the given file selector
6876 * entry widget's internal file selector
6878 * @param obj The file selector entry widget
6879 * @return @c EINA_TRUE if @p obj widget's internal file selector
6880 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6882 * @see elm_fileselector_expandable_set() for more details
6884 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6887 * Set whether a given file selector entry widget's internal file
6888 * selector is to display folders only or the directory contents,
6891 * @param obj The file selector entry widget
6892 * @param only @c EINA_TRUE to make @p obj widget's internal file
6893 * selector only display directories, @c EINA_FALSE to make files
6894 * to be displayed in it too
6896 * This has the same effect as elm_fileselector_folder_only_set(),
6897 * but now applied to a file selector entry's internal file
6900 * @see elm_fileselector_folder_only_get()
6902 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6905 * Get whether a given file selector entry widget's internal file
6906 * selector is displaying folders only or the directory contents,
6909 * @param obj The file selector entry widget
6910 * @return @c EINA_TRUE if @p obj widget's internal file
6911 * selector is only displaying directories, @c EINA_FALSE if files
6912 * are being displayed in it too (and on errors)
6914 * @see elm_fileselector_entry_folder_only_set() for more details
6916 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6919 * Enable/disable the file name entry box where the user can type
6920 * in a name for a file, in a given file selector entry widget's
6921 * internal file selector.
6923 * @param obj The file selector entry widget
6924 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6925 * file selector a "saving dialog", @c EINA_FALSE otherwise
6927 * This has the same effect as elm_fileselector_is_save_set(),
6928 * but now applied to a file selector entry's internal file
6931 * @see elm_fileselector_is_save_get()
6933 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6936 * Get whether the given file selector entry widget's internal
6937 * file selector is in "saving dialog" mode
6939 * @param obj The file selector entry widget
6940 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6941 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6944 * @see elm_fileselector_entry_is_save_set() for more details
6946 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6949 * Set whether a given file selector entry widget's internal file
6950 * selector will raise an Elementary "inner window", instead of a
6951 * dedicated Elementary window. By default, it won't.
6953 * @param obj The file selector entry widget
6954 * @param value @c EINA_TRUE to make it use an inner window, @c
6955 * EINA_TRUE to make it use a dedicated window
6957 * @see elm_win_inwin_add() for more information on inner windows
6958 * @see elm_fileselector_entry_inwin_mode_get()
6960 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6963 * Get whether a given file selector entry widget's internal file
6964 * selector will raise an Elementary "inner window", instead of a
6965 * dedicated Elementary window.
6967 * @param obj The file selector entry widget
6968 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6969 * if it will use a dedicated window
6971 * @see elm_fileselector_entry_inwin_mode_set() for more details
6973 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6976 * Set the initial file system path for a given file selector entry
6979 * @param obj The file selector entry widget
6980 * @param path The path string
6982 * It must be a <b>directory</b> path, which will have the contents
6983 * displayed initially in the file selector's view, when invoked
6984 * from @p obj. The default initial path is the @c "HOME"
6985 * environment variable's value.
6987 * @see elm_fileselector_entry_path_get()
6989 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6992 * Get the parent directory's path to the latest file selection on
6993 * a given filer selector entry widget
6995 * @param obj The file selector object
6996 * @return The (full) path of the directory of the last selection
6997 * on @p obj widget, a @b stringshared string
6999 * @see elm_fileselector_entry_path_set()
7001 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7008 * @defgroup Scroller Scroller
7010 * A scroller holds a single object and "scrolls it around". This means that
7011 * it allows the user to use a scrollbar (or a finger) to drag the viewable
7012 * region around, allowing to move through a much larger object that is
7013 * contained in the scroller. The scroller will always have a small minimum
7014 * size by default as it won't be limited by the contents of the scroller.
7016 * Signals that you can add callbacks for are:
7017 * @li "edge,left" - the left edge of the content has been reached
7018 * @li "edge,right" - the right edge of the content has been reached
7019 * @li "edge,top" - the top edge of the content has been reached
7020 * @li "edge,bottom" - the bottom edge of the content has been reached
7021 * @li "scroll" - the content has been scrolled (moved)
7022 * @li "scroll,anim,start" - scrolling animation has started
7023 * @li "scroll,anim,stop" - scrolling animation has stopped
7024 * @li "scroll,drag,start" - dragging the contents around has started
7025 * @li "scroll,drag,stop" - dragging the contents around has stopped
7026 * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
7029 * @note When Elemementary is in embedded mode the scrollbars will not be
7030 * dragable, they appear merely as indicators of how much has been scrolled.
7031 * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
7032 * fingerscroll) won't work.
7034 * To set/get/unset the content of the panel, you can use
7035 * elm_object_content_set/get/unset APIs.
7036 * Once the content object is set, a previously set one will be deleted.
7037 * If you want to keep that old content object, use the
7038 * elm_object_content_unset() function
7040 * In @ref tutorial_scroller you'll find an example of how to use most of
7045 * @brief Type that controls when scrollbars should appear.
7047 * @see elm_scroller_policy_set()
7049 typedef enum _Elm_Scroller_Policy
7051 ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
7052 ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
7053 ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
7054 ELM_SCROLLER_POLICY_LAST
7055 } Elm_Scroller_Policy;
7057 * @brief Add a new scroller to the parent
7059 * @param parent The parent object
7060 * @return The new object or NULL if it cannot be created
7062 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7064 * @brief Set the content of the scroller widget (the object to be scrolled around).
7066 * @param obj The scroller object
7067 * @param content The new content object
7069 * Once the content object is set, a previously set one will be deleted.
7070 * If you want to keep that old content object, use the
7071 * elm_scroller_content_unset() function.
7072 * @deprecated See elm_object_content_set()
7074 EINA_DEPRECATED EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
7076 * @brief Get the content of the scroller widget
7078 * @param obj The slider object
7079 * @return The content that is being used
7081 * Return the content object which is set for this widget
7083 * @see elm_scroller_content_set()
7084 * @deprecated use elm_object_content_get() instead.
7086 EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7088 * @brief Unset the content of the scroller widget
7090 * @param obj The slider object
7091 * @return The content that was being used
7093 * Unparent and return the content object which was set for this widget
7095 * @see elm_scroller_content_set()
7096 * @deprecated use elm_object_content_unset() instead.
7098 EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7100 * @brief Set custom theme elements for the scroller
7102 * @param obj The scroller object
7103 * @param widget The widget name to use (default is "scroller")
7104 * @param base The base name to use (default is "base")
7106 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
7108 * @brief Make the scroller minimum size limited to the minimum size of the content
7110 * @param obj The scroller object
7111 * @param w Enable limiting minimum size horizontally
7112 * @param h Enable limiting minimum size vertically
7114 * By default the scroller will be as small as its design allows,
7115 * irrespective of its content. This will make the scroller minimum size the
7116 * right size horizontally and/or vertically to perfectly fit its content in
7119 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
7121 * @brief Show a specific virtual region within the scroller content object
7123 * @param obj The scroller object
7124 * @param x X coordinate of the region
7125 * @param y Y coordinate of the region
7126 * @param w Width of the region
7127 * @param h Height of the region
7129 * This will ensure all (or part if it does not fit) of the designated
7130 * region in the virtual content object (0, 0 starting at the top-left of the
7131 * virtual content object) is shown within the scroller.
7133 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);
7135 * @brief Set the scrollbar visibility policy
7137 * @param obj The scroller object
7138 * @param policy_h Horizontal scrollbar policy
7139 * @param policy_v Vertical scrollbar policy
7141 * This sets the scrollbar visibility policy for the given scroller.
7142 * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
7143 * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
7144 * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
7145 * respectively for the horizontal and vertical scrollbars.
7147 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
7149 * @brief Gets scrollbar visibility policy
7151 * @param obj The scroller object
7152 * @param policy_h Horizontal scrollbar policy
7153 * @param policy_v Vertical scrollbar policy
7155 * @see elm_scroller_policy_set()
7157 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
7159 * @brief Get the currently visible content region
7161 * @param obj The scroller object
7162 * @param x X coordinate of the region
7163 * @param y Y coordinate of the region
7164 * @param w Width of the region
7165 * @param h Height of the region
7167 * This gets the current region in the content object that is visible through
7168 * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
7169 * w, @p h values pointed to.
7171 * @note All coordinates are relative to the content.
7173 * @see elm_scroller_region_show()
7175 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);
7177 * @brief Get the size of the content object
7179 * @param obj The scroller object
7180 * @param w Width of the content object.
7181 * @param h Height of the content object.
7183 * This gets the size of the content object of the scroller.
7185 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7187 * @brief Set bouncing behavior
7189 * @param obj The scroller object
7190 * @param h_bounce Allow bounce horizontally
7191 * @param v_bounce Allow bounce vertically
7193 * When scrolling, the scroller may "bounce" when reaching an edge of the
7194 * content object. This is a visual way to indicate the end has been reached.
7195 * This is enabled by default for both axis. This API will set if it is enabled
7196 * for the given axis with the boolean parameters for each axis.
7198 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7200 * @brief Get the bounce behaviour
7202 * @param obj The Scroller object
7203 * @param h_bounce Will the scroller bounce horizontally or not
7204 * @param v_bounce Will the scroller bounce vertically or not
7206 * @see elm_scroller_bounce_set()
7208 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7210 * @brief Set scroll page size relative to viewport size.
7212 * @param obj The scroller object
7213 * @param h_pagerel The horizontal page relative size
7214 * @param v_pagerel The vertical page relative size
7216 * The scroller is capable of limiting scrolling by the user to "pages". That
7217 * is to jump by and only show a "whole page" at a time as if the continuous
7218 * area of the scroller content is split into page sized pieces. This sets
7219 * the size of a page relative to the viewport of the scroller. 1.0 is "1
7220 * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7221 * axis. This is mutually exclusive with page size
7222 * (see elm_scroller_page_size_set() for more information). Likewise 0.5
7223 * is "half a viewport". Sane usable values are normally between 0.0 and 1.0
7224 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7227 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7229 * @brief Set scroll page size.
7231 * @param obj The scroller object
7232 * @param h_pagesize The horizontal page size
7233 * @param v_pagesize The vertical page size
7235 * This sets the page size to an absolute fixed value, with 0 turning it off
7238 * @see elm_scroller_page_relative_set()
7240 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7242 * @brief Get scroll current page number.
7244 * @param obj The scroller object
7245 * @param h_pagenumber The horizontal page number
7246 * @param v_pagenumber The vertical page number
7248 * The page number starts from 0. 0 is the first page.
7249 * Current page means the page which meets the top-left of the viewport.
7250 * If there are two or more pages in the viewport, it returns the number of the page
7251 * which meets the top-left of the viewport.
7253 * @see elm_scroller_last_page_get()
7254 * @see elm_scroller_page_show()
7255 * @see elm_scroller_page_brint_in()
7257 EAPI void elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7259 * @brief Get scroll last page number.
7261 * @param obj The scroller object
7262 * @param h_pagenumber The horizontal page number
7263 * @param v_pagenumber The vertical page number
7265 * The page number starts from 0. 0 is the first page.
7266 * This returns the last page number among the pages.
7268 * @see elm_scroller_current_page_get()
7269 * @see elm_scroller_page_show()
7270 * @see elm_scroller_page_brint_in()
7272 EAPI void elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7274 * Show a specific virtual region within the scroller content object by page number.
7276 * @param obj The scroller object
7277 * @param h_pagenumber The horizontal page number
7278 * @param v_pagenumber The vertical page number
7280 * 0, 0 of the indicated page is located at the top-left of the viewport.
7281 * This will jump to the page directly without animation.
7286 * sc = elm_scroller_add(win);
7287 * elm_scroller_content_set(sc, content);
7288 * elm_scroller_page_relative_set(sc, 1, 0);
7289 * elm_scroller_current_page_get(sc, &h_page, &v_page);
7290 * elm_scroller_page_show(sc, h_page + 1, v_page);
7293 * @see elm_scroller_page_bring_in()
7295 EAPI void elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7297 * Show a specific virtual region within the scroller content object by page number.
7299 * @param obj The scroller object
7300 * @param h_pagenumber The horizontal page number
7301 * @param v_pagenumber The vertical page number
7303 * 0, 0 of the indicated page is located at the top-left of the viewport.
7304 * This will slide to the page with animation.
7309 * sc = elm_scroller_add(win);
7310 * elm_scroller_content_set(sc, content);
7311 * elm_scroller_page_relative_set(sc, 1, 0);
7312 * elm_scroller_last_page_get(sc, &h_page, &v_page);
7313 * elm_scroller_page_bring_in(sc, h_page, v_page);
7316 * @see elm_scroller_page_show()
7318 EAPI void elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7320 * @brief Show a specific virtual region within the scroller content object.
7322 * @param obj The scroller object
7323 * @param x X coordinate of the region
7324 * @param y Y coordinate of the region
7325 * @param w Width of the region
7326 * @param h Height of the region
7328 * This will ensure all (or part if it does not fit) of the designated
7329 * region in the virtual content object (0, 0 starting at the top-left of the
7330 * virtual content object) is shown within the scroller. Unlike
7331 * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7332 * to this location (if configuration in general calls for transitions). It
7333 * may not jump immediately to the new location and make take a while and
7334 * show other content along the way.
7336 * @see elm_scroller_region_show()
7338 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);
7340 * @brief Set event propagation on a scroller
7342 * @param obj The scroller object
7343 * @param propagation If propagation is enabled or not
7345 * This enables or disabled event propagation from the scroller content to
7346 * the scroller and its parent. By default event propagation is disabled.
7348 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation) EINA_ARG_NONNULL(1);
7350 * @brief Get event propagation for a scroller
7352 * @param obj The scroller object
7353 * @return The propagation state
7355 * This gets the event propagation for a scroller.
7357 * @see elm_scroller_propagate_events_set()
7359 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7361 * @brief Set scrolling gravity on a scroller
7363 * @param obj The scroller object
7364 * @param x The scrolling horizontal gravity
7365 * @param y The scrolling vertical gravity
7367 * The gravity, defines how the scroller will adjust its view
7368 * when the size of the scroller contents increase.
7370 * The scroller will adjust the view to glue itself as follows.
7372 * x=0.0, for showing the left most region of the content.
7373 * x=1.0, for showing the right most region of the content.
7374 * y=0.0, for showing the bottom most region of the content.
7375 * y=1.0, for showing the top most region of the content.
7377 * Default values for x and y are 0.0
7379 EAPI void elm_scroller_gravity_set(Evas_Object *obj, double x, double y) EINA_ARG_NONNULL(1);
7381 * @brief Get scrolling gravity values for a scroller
7383 * @param obj The scroller object
7384 * @param x The scrolling horizontal gravity
7385 * @param y The scrolling vertical gravity
7387 * This gets gravity values for a scroller.
7389 * @see elm_scroller_gravity_set()
7392 EAPI void elm_scroller_gravity_get(const Evas_Object *obj, double *x, double *y) EINA_ARG_NONNULL(1);
7398 * @defgroup Label Label
7400 * @image html img/widget/label/preview-00.png
7401 * @image latex img/widget/label/preview-00.eps
7403 * @brief Widget to display text, with simple html-like markup.
7405 * The Label widget @b doesn't allow text to overflow its boundaries, if the
7406 * text doesn't fit the geometry of the label it will be ellipsized or be
7407 * cut. Elementary provides several themes for this widget:
7408 * @li default - No animation
7409 * @li marker - Centers the text in the label and make it bold by default
7410 * @li slide_long - The entire text appears from the right of the screen and
7411 * slides until it disappears in the left of the screen(reappering on the
7413 * @li slide_short - The text appears in the left of the label and slides to
7414 * the right to show the overflow. When all of the text has been shown the
7415 * position is reset.
7416 * @li slide_bounce - The text appears in the left of the label and slides to
7417 * the right to show the overflow. When all of the text has been shown the
7418 * animation reverses, moving the text to the left.
7420 * Custom themes can of course invent new markup tags and style them any way
7423 * The following signals may be emitted by the label widget:
7424 * @li "language,changed": The program's language changed.
7426 * See @ref tutorial_label for a demonstration of how to use a label widget.
7430 * @brief Add a new label to the parent
7432 * @param parent The parent object
7433 * @return The new object or NULL if it cannot be created
7435 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7437 * @brief Set the label on the label object
7439 * @param obj The label object
7440 * @param label The label will be used on the label object
7441 * @deprecated See elm_object_text_set()
7443 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 */
7445 * @brief Get the label used on the label object
7447 * @param obj The label object
7448 * @return The string inside the label
7449 * @deprecated See elm_object_text_get()
7451 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7453 * @brief Set the wrapping behavior of the label
7455 * @param obj The label object
7456 * @param wrap To wrap text or not
7458 * By default no wrapping is done. Possible values for @p wrap are:
7459 * @li ELM_WRAP_NONE - No wrapping
7460 * @li ELM_WRAP_CHAR - wrap between characters
7461 * @li ELM_WRAP_WORD - wrap between words
7462 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7464 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7466 * @brief Get the wrapping behavior of the label
7468 * @param obj The label object
7471 * @see elm_label_line_wrap_set()
7473 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7475 * @brief Set wrap width of the label
7477 * @param obj The label object
7478 * @param w The wrap width in pixels at a minimum where words need to wrap
7480 * This function sets the maximum width size hint of the label.
7482 * @warning This is only relevant if the label is inside a container.
7484 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7486 * @brief Get wrap width of the label
7488 * @param obj The label object
7489 * @return The wrap width in pixels at a minimum where words need to wrap
7491 * @see elm_label_wrap_width_set()
7493 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7495 * @brief Set wrap height of the label
7497 * @param obj The label object
7498 * @param h The wrap height in pixels at a minimum where words need to wrap
7500 * This function sets the maximum height size hint of the label.
7502 * @warning This is only relevant if the label is inside a container.
7504 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7506 * @brief get wrap width of the label
7508 * @param obj The label object
7509 * @return The wrap height in pixels at a minimum where words need to wrap
7511 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7513 * @brief Set the font size on the label object.
7515 * @param obj The label object
7516 * @param size font size
7518 * @warning NEVER use this. It is for hyper-special cases only. use styles
7519 * instead. e.g. "big", "medium", "small" - or better name them by use:
7520 * "title", "footnote", "quote" etc.
7522 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7524 * @brief Set the text color on the label object
7526 * @param obj The label object
7527 * @param r Red property background color of The label object
7528 * @param g Green property background color of The label object
7529 * @param b Blue property background color of The label object
7530 * @param a Alpha property background color of The label object
7532 * @warning NEVER use this. It is for hyper-special cases only. use styles
7533 * instead. e.g. "big", "medium", "small" - or better name them by use:
7534 * "title", "footnote", "quote" etc.
7536 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);
7538 * @brief Set the text align on the label object
7540 * @param obj The label object
7541 * @param align align mode ("left", "center", "right")
7543 * @warning NEVER use this. It is for hyper-special cases only. use styles
7544 * instead. e.g. "big", "medium", "small" - or better name them by use:
7545 * "title", "footnote", "quote" etc.
7547 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7549 * @brief Set background color of the label
7551 * @param obj The label object
7552 * @param r Red property background color of The label object
7553 * @param g Green property background color of The label object
7554 * @param b Blue property background color of The label object
7555 * @param a Alpha property background alpha of The label object
7557 * @warning NEVER use this. It is for hyper-special cases only. use styles
7558 * instead. e.g. "big", "medium", "small" - or better name them by use:
7559 * "title", "footnote", "quote" etc.
7561 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);
7563 * @brief Set the ellipsis behavior of the label
7565 * @param obj The label object
7566 * @param ellipsis To ellipsis text or not
7568 * If set to true and the text doesn't fit in the label an ellipsis("...")
7569 * will be shown at the end of the widget.
7571 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7572 * choosen wrap method was ELM_WRAP_WORD.
7574 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7576 * @brief Set the text slide of the label
7578 * @param obj The label object
7579 * @param slide To start slide or stop
7581 * If set to true, the text of the label will slide/scroll through the length of
7584 * @warning This only works with the themes "slide_short", "slide_long" and
7587 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7589 * @brief Get the text slide mode of the label
7591 * @param obj The label object
7592 * @return slide slide mode value
7594 * @see elm_label_slide_set()
7596 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7598 * @brief Set the slide duration(speed) of the label
7600 * @param obj The label object
7601 * @return The duration in seconds in moving text from slide begin position
7602 * to slide end position
7604 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7606 * @brief Get the slide duration(speed) of the label
7608 * @param obj The label object
7609 * @return The duration time in moving text from slide begin position to slide end position
7611 * @see elm_label_slide_duration_set()
7613 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7619 * @defgroup Toggle Toggle
7621 * @image html img/widget/toggle/preview-00.png
7622 * @image latex img/widget/toggle/preview-00.eps
7624 * @brief A toggle is a slider which can be used to toggle between
7625 * two values. It has two states: on and off.
7627 * This widget is deprecated. Please use elm_check_add() instead using the
7628 * toggle style like:
7631 * obj = elm_check_add(parent);
7632 * elm_object_style_set(obj, "toggle");
7633 * elm_object_text_part_set(obj, "on", "ON");
7634 * elm_object_text_part_set(obj, "off", "OFF");
7637 * Signals that you can add callbacks for are:
7638 * @li "changed" - Whenever the toggle value has been changed. Is not called
7639 * until the toggle is released by the cursor (assuming it
7640 * has been triggered by the cursor in the first place).
7642 * @ref tutorial_toggle show how to use a toggle.
7646 * @brief Add a toggle to @p parent.
7648 * @param parent The parent object
7650 * @return The toggle object
7652 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7654 * @brief Sets the label to be displayed with the toggle.
7656 * @param obj The toggle object
7657 * @param label The label to be displayed
7659 * @deprecated use elm_object_text_set() instead.
7661 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7663 * @brief Gets the label of the toggle
7665 * @param obj toggle object
7666 * @return The label of the toggle
7668 * @deprecated use elm_object_text_get() instead.
7670 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7672 * @brief Set the icon used for the toggle
7674 * @param obj The toggle object
7675 * @param icon The icon object for the button
7677 * Once the icon object is set, a previously set one will be deleted
7678 * If you want to keep that old content object, use the
7679 * elm_toggle_icon_unset() function.
7681 * @deprecated use elm_object_content_set() instead.
7683 EINA_DEPRECATED EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7685 * @brief Get the icon used for the toggle
7687 * @param obj The toggle object
7688 * @return The icon object that is being used
7690 * Return the icon object which is set for this widget.
7692 * @see elm_toggle_icon_set()
7694 * @deprecated use elm_object_content_get() instead.
7696 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7698 * @brief Unset the icon used for the toggle
7700 * @param obj The toggle object
7701 * @return The icon object that was being used
7703 * Unparent and return the icon object which was set for this widget.
7705 * @see elm_toggle_icon_set()
7707 * @deprecated use elm_object_content_unset() instead.
7709 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7711 * @brief Sets the labels to be associated with the on and off states of the toggle.
7713 * @param obj The toggle object
7714 * @param onlabel The label displayed when the toggle is in the "on" state
7715 * @param offlabel The label displayed when the toggle is in the "off" state
7717 * @deprecated use elm_object_text_part_set() for "on" and "off" parts
7720 EINA_DEPRECATED EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7722 * @brief Gets the labels associated with the on and off states of the
7725 * @param obj The toggle object
7726 * @param onlabel A char** to place the onlabel of @p obj into
7727 * @param offlabel A char** to place the offlabel of @p obj into
7729 * @deprecated use elm_object_text_part_get() for "on" and "off" parts
7732 EINA_DEPRECATED EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7734 * @brief Sets the state of the toggle to @p state.
7736 * @param obj The toggle object
7737 * @param state The state of @p obj
7739 * @deprecated use elm_check_state_set() instead.
7741 EINA_DEPRECATED EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7743 * @brief Gets the state of the toggle to @p state.
7745 * @param obj The toggle object
7746 * @return The state of @p obj
7748 * @deprecated use elm_check_state_get() instead.
7750 EINA_DEPRECATED EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7752 * @brief Sets the state pointer of the toggle to @p statep.
7754 * @param obj The toggle object
7755 * @param statep The state pointer of @p obj
7757 * @deprecated use elm_check_state_pointer_set() instead.
7759 EINA_DEPRECATED EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7765 * @defgroup Frame Frame
7767 * @image html img/widget/frame/preview-00.png
7768 * @image latex img/widget/frame/preview-00.eps
7770 * @brief Frame is a widget that holds some content and has a title.
7772 * The default look is a frame with a title, but Frame supports multple
7780 * @li outdent_bottom
7782 * Of all this styles only default shows the title. Frame emits no signals.
7784 * Default contents parts of the frame widget that you can use for are:
7785 * @li "elm.swallow.content" - A content of the frame
7787 * Default text parts of the frame widget that you can use for are:
7788 * @li "elm.text" - Label of the frame
7790 * For a detailed example see the @ref tutorial_frame.
7795 * @brief Add a new frame to the parent
7797 * @param parent The parent object
7798 * @return The new object or NULL if it cannot be created
7800 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7802 * @brief Set the frame label
7804 * @param obj The frame object
7805 * @param label The label of this frame object
7807 * @deprecated use elm_object_text_set() instead.
7809 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7811 * @brief Get the frame label
7813 * @param obj The frame object
7815 * @return The label of this frame objet or NULL if unable to get frame
7817 * @deprecated use elm_object_text_get() instead.
7819 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7821 * @brief Set the content of the frame widget
7823 * Once the content object is set, a previously set one will be deleted.
7824 * If you want to keep that old content object, use the
7825 * elm_frame_content_unset() function.
7827 * @param obj The frame object
7828 * @param content The content will be filled in this frame object
7830 * @deprecated use elm_object_content_set() instead.
7832 EINA_DEPRECATED EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7834 * @brief Get the content of the frame widget
7836 * Return the content object which is set for this widget
7838 * @param obj The frame object
7839 * @return The content that is being used
7841 * @deprecated use elm_object_content_get() instead.
7843 EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7845 * @brief Unset the content of the frame widget
7847 * Unparent and return the content object which was set for this widget
7849 * @param obj The frame object
7850 * @return The content that was being used
7852 * @deprecated use elm_object_content_unset() instead.
7854 EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7860 * @defgroup Table Table
7862 * A container widget to arrange other widgets in a table where items can
7863 * also span multiple columns or rows - even overlap (and then be raised or
7864 * lowered accordingly to adjust stacking if they do overlap).
7866 * For a Table widget the row/column count is not fixed.
7867 * The table widget adjusts itself when subobjects are added to it dynamically.
7869 * The followin are examples of how to use a table:
7870 * @li @ref tutorial_table_01
7871 * @li @ref tutorial_table_02
7876 * @brief Add a new table to the parent
7878 * @param parent The parent object
7879 * @return The new object or NULL if it cannot be created
7881 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7883 * @brief Set the homogeneous layout in the table
7885 * @param obj The layout object
7886 * @param homogeneous A boolean to set if the layout is homogeneous in the
7887 * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7889 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7891 * @brief Get the current table homogeneous mode.
7893 * @param obj The table object
7894 * @return A boolean to indicating if the layout is homogeneous in the table
7895 * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7897 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7899 * @warning <b>Use elm_table_homogeneous_set() instead</b>
7901 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7903 * @warning <b>Use elm_table_homogeneous_get() instead</b>
7905 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7907 * @brief Set padding between cells.
7909 * @param obj The layout object.
7910 * @param horizontal set the horizontal padding.
7911 * @param vertical set the vertical padding.
7913 * Default value is 0.
7915 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7917 * @brief Get padding between cells.
7919 * @param obj The layout object.
7920 * @param horizontal set the horizontal padding.
7921 * @param vertical set the vertical padding.
7923 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7925 * @brief Add a subobject on the table with the coordinates passed
7927 * @param obj The table object
7928 * @param subobj The subobject to be added to the table
7929 * @param x Row number
7930 * @param y Column number
7934 * @note All positioning inside the table is relative to rows and columns, so
7935 * a value of 0 for x and y, means the top left cell of the table, and a
7936 * value of 1 for w and h means @p subobj only takes that 1 cell.
7938 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7940 * @brief Remove child from table.
7942 * @param obj The table object
7943 * @param subobj The subobject
7945 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
7947 * @brief Faster way to remove all child objects from a table object.
7949 * @param obj The table object
7950 * @param clear If true, will delete children, else just remove from table.
7952 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
7954 * @brief Set the packing location of an existing child of the table
7956 * @param subobj The subobject to be modified in the table
7957 * @param x Row number
7958 * @param y Column number
7962 * Modifies the position of an object already in the table.
7964 * @note All positioning inside the table is relative to rows and columns, so
7965 * a value of 0 for x and y, means the top left cell of the table, and a
7966 * value of 1 for w and h means @p subobj only takes that 1 cell.
7968 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7970 * @brief Get the packing location of an existing child of the table
7972 * @param subobj The subobject to be modified in the table
7973 * @param x Row number
7974 * @param y Column number
7978 * @see elm_table_pack_set()
7980 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
7985 /* TEMPORARY: DOCS WILL BE FILLED IN WITH CNP/SED */
7986 typedef struct Elm_Gen_Item Elm_Gen_Item;
7987 typedef struct _Elm_Gen_Item_Class Elm_Gen_Item_Class;
7988 typedef struct _Elm_Gen_Item_Class_Func Elm_Gen_Item_Class_Func; /**< Class functions for gen item classes. */
7989 typedef char *(*Elm_Gen_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gen item classes. */
7990 typedef Evas_Object *(*Elm_Gen_Item_Content_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Content(swallowed object) fetching class function for gen item classes. */
7991 typedef Eina_Bool (*Elm_Gen_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for gen item classes. */
7992 typedef void (*Elm_Gen_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for gen item classes. */
7993 struct _Elm_Gen_Item_Class
7995 const char *item_style;
7996 struct _Elm_Gen_Item_Class_Func
7998 Elm_Gen_Item_Label_Get_Cb label_get;
7999 Elm_Gen_Item_Content_Get_Cb content_get;
8000 Elm_Gen_Item_State_Get_Cb state_get;
8001 Elm_Gen_Item_Del_Cb del;
8004 EAPI void elm_gen_clear(Evas_Object *obj);
8005 EAPI void elm_gen_item_selected_set(Elm_Gen_Item *it, Eina_Bool selected);
8006 EAPI Eina_Bool elm_gen_item_selected_get(const Elm_Gen_Item *it);
8007 EAPI void elm_gen_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select);
8008 EAPI Eina_Bool elm_gen_always_select_mode_get(const Evas_Object *obj);
8009 EAPI void elm_gen_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select);
8010 EAPI Eina_Bool elm_gen_no_select_mode_get(const Evas_Object *obj);
8011 EAPI void elm_gen_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
8012 EAPI void elm_gen_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
8013 EAPI void elm_gen_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel);
8014 EAPI void elm_gen_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel);
8015 EAPI void elm_gen_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize);
8016 EAPI void elm_gen_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
8017 EAPI void elm_gen_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
8018 EAPI void elm_gen_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
8019 EAPI void elm_gen_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
8020 EAPI Elm_Gen_Item *elm_gen_first_item_get(const Evas_Object *obj);
8021 EAPI Elm_Gen_Item *elm_gen_last_item_get(const Evas_Object *obj);
8022 EAPI Elm_Gen_Item *elm_gen_item_next_get(const Elm_Gen_Item *it);
8023 EAPI Elm_Gen_Item *elm_gen_item_prev_get(const Elm_Gen_Item *it);
8024 EAPI Evas_Object *elm_gen_item_widget_get(const Elm_Gen_Item *it);
8027 * @defgroup Gengrid Gengrid (Generic grid)
8029 * This widget aims to position objects in a grid layout while
8030 * actually creating and rendering only the visible ones, using the
8031 * same idea as the @ref Genlist "genlist": the user defines a @b
8032 * class for each item, specifying functions that will be called at
8033 * object creation, deletion, etc. When those items are selected by
8034 * the user, a callback function is issued. Users may interact with
8035 * a gengrid via the mouse (by clicking on items to select them and
8036 * clicking on the grid's viewport and swiping to pan the whole
8037 * view) or via the keyboard, navigating through item with the
8040 * @section Gengrid_Layouts Gengrid layouts
8042 * Gengrid may layout its items in one of two possible layouts:
8046 * When in "horizontal mode", items will be placed in @b columns,
8047 * from top to bottom and, when the space for a column is filled,
8048 * another one is started on the right, thus expanding the grid
8049 * horizontally, making for horizontal scrolling. When in "vertical
8050 * mode" , though, items will be placed in @b rows, from left to
8051 * right and, when the space for a row is filled, another one is
8052 * started below, thus expanding the grid vertically (and making
8053 * for vertical scrolling).
8055 * @section Gengrid_Items Gengrid items
8057 * An item in a gengrid can have 0 or more text labels (they can be
8058 * regular text or textblock Evas objects - that's up to the style
8059 * to determine), 0 or more icons (which are simply objects
8060 * swallowed into the gengrid item's theming Edje object) and 0 or
8061 * more <b>boolean states</b>, which have the behavior left to the
8062 * user to define. The Edje part names for each of these properties
8063 * will be looked up, in the theme file for the gengrid, under the
8064 * Edje (string) data items named @c "labels", @c "icons" and @c
8065 * "states", respectively. For each of those properties, if more
8066 * than one part is provided, they must have names listed separated
8067 * by spaces in the data fields. For the default gengrid item
8068 * theme, we have @b one label part (@c "elm.text"), @b two icon
8069 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
8072 * A gengrid item may be at one of several styles. Elementary
8073 * provides one by default - "default", but this can be extended by
8074 * system or application custom themes/overlays/extensions (see
8075 * @ref Theme "themes" for more details).
8077 * @section Gengrid_Item_Class Gengrid item classes
8079 * In order to have the ability to add and delete items on the fly,
8080 * gengrid implements a class (callback) system where the
8081 * application provides a structure with information about that
8082 * type of item (gengrid may contain multiple different items with
8083 * different classes, states and styles). Gengrid will call the
8084 * functions in this struct (methods) when an item is "realized"
8085 * (i.e., created dynamically, while the user is scrolling the
8086 * grid). All objects will simply be deleted when no longer needed
8087 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
8088 * contains the following members:
8089 * - @c item_style - This is a constant string and simply defines
8090 * the name of the item style. It @b must be specified and the
8091 * default should be @c "default".
8092 * - @c func.label_get - This function is called when an item
8093 * object is actually created. The @c data parameter will point to
8094 * the same data passed to elm_gengrid_item_append() and related
8095 * item creation functions. The @c obj parameter is the gengrid
8096 * object itself, while the @c part one is the name string of one
8097 * of the existing text parts in the Edje group implementing the
8098 * item's theme. This function @b must return a strdup'()ed string,
8099 * as the caller will free() it when done. See
8100 * #Elm_Gengrid_Item_Label_Get_Cb.
8101 * - @c func.content_get - This function is called when an item object
8102 * is actually created. The @c data parameter will point to the
8103 * same data passed to elm_gengrid_item_append() and related item
8104 * creation functions. The @c obj parameter is the gengrid object
8105 * itself, while the @c part one is the name string of one of the
8106 * existing (content) swallow parts in the Edje group implementing the
8107 * item's theme. It must return @c NULL, when no content is desired,
8108 * or a valid object handle, otherwise. The object will be deleted
8109 * by the gengrid on its deletion or when the item is "unrealized".
8110 * See #Elm_Gengrid_Item_Content_Get_Cb.
8111 * - @c func.state_get - This function is called when an item
8112 * object is actually created. The @c data parameter will point to
8113 * the same data passed to elm_gengrid_item_append() and related
8114 * item creation functions. The @c obj parameter is the gengrid
8115 * object itself, while the @c part one is the name string of one
8116 * of the state parts in the Edje group implementing the item's
8117 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
8118 * true/on. Gengrids will emit a signal to its theming Edje object
8119 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
8120 * "source" arguments, respectively, when the state is true (the
8121 * default is false), where @c XXX is the name of the (state) part.
8122 * See #Elm_Gengrid_Item_State_Get_Cb.
8123 * - @c func.del - This is called when elm_gengrid_item_del() is
8124 * called on an item or elm_gengrid_clear() is called on the
8125 * gengrid. This is intended for use when gengrid items are
8126 * deleted, so any data attached to the item (e.g. its data
8127 * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
8129 * @section Gengrid_Usage_Hints Usage hints
8131 * If the user wants to have multiple items selected at the same
8132 * time, elm_gengrid_multi_select_set() will permit it. If the
8133 * gengrid is single-selection only (the default), then
8134 * elm_gengrid_select_item_get() will return the selected item or
8135 * @c NULL, if none is selected. If the gengrid is under
8136 * multi-selection, then elm_gengrid_selected_items_get() will
8137 * return a list (that is only valid as long as no items are
8138 * modified (added, deleted, selected or unselected) of child items
8141 * If an item changes (internal (boolean) state, label or content
8142 * changes), then use elm_gengrid_item_update() to have gengrid
8143 * update the item with the new state. A gengrid will re-"realize"
8144 * the item, thus calling the functions in the
8145 * #Elm_Gengrid_Item_Class set for that item.
8147 * To programmatically (un)select an item, use
8148 * elm_gengrid_item_selected_set(). To get its selected state use
8149 * elm_gengrid_item_selected_get(). To make an item disabled
8150 * (unable to be selected and appear differently) use
8151 * elm_gengrid_item_disabled_set() to set this and
8152 * elm_gengrid_item_disabled_get() to get the disabled state.
8154 * Grid cells will only have their selection smart callbacks called
8155 * when firstly getting selected. Any further clicks will do
8156 * nothing, unless you enable the "always select mode", with
8157 * elm_gengrid_always_select_mode_set(), thus making every click to
8158 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
8159 * turn off the ability to select items entirely in the widget and
8160 * they will neither appear selected nor call the selection smart
8163 * Remember that you can create new styles and add your own theme
8164 * augmentation per application with elm_theme_extension_add(). If
8165 * you absolutely must have a specific style that overrides any
8166 * theme the user or system sets up you can use
8167 * elm_theme_overlay_add() to add such a file.
8169 * @section Gengrid_Smart_Events Gengrid smart events
8171 * Smart events that you can add callbacks for are:
8172 * - @c "activated" - The user has double-clicked or pressed
8173 * (enter|return|spacebar) on an item. The @c event_info parameter
8174 * is the gengrid item that was activated.
8175 * - @c "clicked,double" - The user has double-clicked an item.
8176 * The @c event_info parameter is the gengrid item that was double-clicked.
8177 * - @c "longpressed" - This is called when the item is pressed for a certain
8178 * amount of time. By default it's 1 second.
8179 * - @c "selected" - The user has made an item selected. The
8180 * @c event_info parameter is the gengrid item that was selected.
8181 * - @c "unselected" - The user has made an item unselected. The
8182 * @c event_info parameter is the gengrid item that was unselected.
8183 * - @c "realized" - This is called when the item in the gengrid
8184 * has its implementing Evas object instantiated, de facto. @c
8185 * event_info is the gengrid item that was created. The object
8186 * may be deleted at any time, so it is highly advised to the
8187 * caller @b not to use the object pointer returned from
8188 * elm_gengrid_item_object_get(), because it may point to freed
8190 * - @c "unrealized" - This is called when the implementing Evas
8191 * object for this item is deleted. @c event_info is the gengrid
8192 * item that was deleted.
8193 * - @c "changed" - Called when an item is added, removed, resized
8194 * or moved and when the gengrid is resized or gets "horizontal"
8196 * - @c "scroll,anim,start" - This is called when scrolling animation has
8198 * - @c "scroll,anim,stop" - This is called when scrolling animation has
8200 * - @c "drag,start,up" - Called when the item in the gengrid has
8201 * been dragged (not scrolled) up.
8202 * - @c "drag,start,down" - Called when the item in the gengrid has
8203 * been dragged (not scrolled) down.
8204 * - @c "drag,start,left" - Called when the item in the gengrid has
8205 * been dragged (not scrolled) left.
8206 * - @c "drag,start,right" - Called when the item in the gengrid has
8207 * been dragged (not scrolled) right.
8208 * - @c "drag,stop" - Called when the item in the gengrid has
8209 * stopped being dragged.
8210 * - @c "drag" - Called when the item in the gengrid is being
8212 * - @c "scroll" - called when the content has been scrolled
8214 * - @c "scroll,drag,start" - called when dragging the content has
8216 * - @c "scroll,drag,stop" - called when dragging the content has
8218 * - @c "edge,top" - This is called when the gengrid is scrolled until
8220 * - @c "edge,bottom" - This is called when the gengrid is scrolled
8221 * until the bottom edge.
8222 * - @c "edge,left" - This is called when the gengrid is scrolled
8223 * until the left edge.
8224 * - @c "edge,right" - This is called when the gengrid is scrolled
8225 * until the right edge.
8227 * List of gengrid examples:
8228 * @li @ref gengrid_example
8232 * @addtogroup Gengrid
8236 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
8237 #define Elm_Gengrid_Item_Class Elm_Gen_Item_Class
8238 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
8239 #define Elm_Gengrid_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
8240 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
8241 typedef char *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
8242 typedef Evas_Object *(*Elm_Gengrid_Item_Content_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Content (swallowed object) fetching class function for gengrid item classes. */
8243 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. */
8244 typedef void (*Elm_Gengrid_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
8247 * @struct _Elm_Gengrid_Item_Class
8249 * Gengrid item class definition. See @ref Gengrid_Item_Class for
8252 struct _Elm_Gengrid_Item_Class
8254 const char *item_style;
8255 struct _Elm_Gengrid_Item_Class_Func
8257 Elm_Gengrid_Item_Label_Get_Cb label_get;
8258 Elm_Gengrid_Item_Content_Get_Cb content_get;
8259 Elm_Gengrid_Item_State_Get_Cb state_get;
8260 Elm_Gengrid_Item_Del_Cb del;
8262 }; /**< #Elm_Gengrid_Item_Class member definitions */
8263 #define Elm_Gengrid_Item_Class_Func Elm_Gen_Item_Class_Func
8265 * Add a new gengrid widget to the given parent Elementary
8266 * (container) object
8268 * @param parent The parent object
8269 * @return a new gengrid widget handle or @c NULL, on errors
8271 * This function inserts a new gengrid widget on the canvas.
8273 * @see elm_gengrid_item_size_set()
8274 * @see elm_gengrid_group_item_size_set()
8275 * @see elm_gengrid_horizontal_set()
8276 * @see elm_gengrid_item_append()
8277 * @see elm_gengrid_item_del()
8278 * @see elm_gengrid_clear()
8282 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8285 * Set the size for the items of a given gengrid widget
8287 * @param obj The gengrid object.
8288 * @param w The items' width.
8289 * @param h The items' height;
8291 * A gengrid, after creation, has still no information on the size
8292 * to give to each of its cells. So, you most probably will end up
8293 * with squares one @ref Fingers "finger" wide, the default
8294 * size. Use this function to force a custom size for you items,
8295 * making them as big as you wish.
8297 * @see elm_gengrid_item_size_get()
8301 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8304 * Get the size set for the items of a given gengrid widget
8306 * @param obj The gengrid object.
8307 * @param w Pointer to a variable where to store the items' width.
8308 * @param h Pointer to a variable where to store the items' height.
8310 * @note Use @c NULL pointers on the size values you're not
8311 * interested in: they'll be ignored by the function.
8313 * @see elm_gengrid_item_size_get() for more details
8317 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8320 * Set the size for the group items of a given gengrid widget
8322 * @param obj The gengrid object.
8323 * @param w The group items' width.
8324 * @param h The group items' height;
8326 * A gengrid, after creation, has still no information on the size
8327 * to give to each of its cells. So, you most probably will end up
8328 * with squares one @ref Fingers "finger" wide, the default
8329 * size. Use this function to force a custom size for you group items,
8330 * making them as big as you wish.
8332 * @see elm_gengrid_group_item_size_get()
8336 EAPI void elm_gengrid_group_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8339 * Get the size set for the group items of a given gengrid widget
8341 * @param obj The gengrid object.
8342 * @param w Pointer to a variable where to store the group items' width.
8343 * @param h Pointer to a variable where to store the group items' height.
8345 * @note Use @c NULL pointers on the size values you're not
8346 * interested in: they'll be ignored by the function.
8348 * @see elm_gengrid_group_item_size_get() for more details
8352 EAPI void elm_gengrid_group_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8355 * Set the items grid's alignment within a given gengrid widget
8357 * @param obj The gengrid object.
8358 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8359 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8361 * This sets the alignment of the whole grid of items of a gengrid
8362 * within its given viewport. By default, those values are both
8363 * 0.5, meaning that the gengrid will have its items grid placed
8364 * exactly in the middle of its viewport.
8366 * @note If given alignment values are out of the cited ranges,
8367 * they'll be changed to the nearest boundary values on the valid
8370 * @see elm_gengrid_align_get()
8374 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8377 * Get the items grid's alignment values within a given gengrid
8380 * @param obj The gengrid object.
8381 * @param align_x Pointer to a variable where to store the
8382 * horizontal alignment.
8383 * @param align_y Pointer to a variable where to store the vertical
8386 * @note Use @c NULL pointers on the alignment values you're not
8387 * interested in: they'll be ignored by the function.
8389 * @see elm_gengrid_align_set() for more details
8393 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8396 * Set whether a given gengrid widget is or not able have items
8399 * @param obj The gengrid object
8400 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8401 * @c EINA_FALSE to turn it off
8403 * If a gengrid is set to allow reordering, a click held for more
8404 * than 0.5 over a given item will highlight it specially,
8405 * signalling the gengrid has entered the reordering state. From
8406 * that time on, the user will be able to, while still holding the
8407 * mouse button down, move the item freely in the gengrid's
8408 * viewport, replacing to said item to the locations it goes to.
8409 * The replacements will be animated and, whenever the user
8410 * releases the mouse button, the item being replaced gets a new
8411 * definitive place in the grid.
8413 * @see elm_gengrid_reorder_mode_get()
8417 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8420 * Get whether a given gengrid widget is or not able have items
8423 * @param obj The gengrid object
8424 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8427 * @see elm_gengrid_reorder_mode_set() for more details
8431 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8434 * Append a new item in a given gengrid widget.
8436 * @param obj The gengrid object.
8437 * @param gic The item class for the item.
8438 * @param data The item data.
8439 * @param func Convenience function called when the item is
8441 * @param func_data Data to be passed to @p func.
8442 * @return A handle to the item added or @c NULL, on errors.
8444 * This adds an item to the beginning of the gengrid.
8446 * @see elm_gengrid_item_prepend()
8447 * @see elm_gengrid_item_insert_before()
8448 * @see elm_gengrid_item_insert_after()
8449 * @see elm_gengrid_item_del()
8453 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);
8456 * Prepend a new item in a given gengrid widget.
8458 * @param obj The gengrid object.
8459 * @param gic The item class for the item.
8460 * @param data The item data.
8461 * @param func Convenience function called when the item is
8463 * @param func_data Data to be passed to @p func.
8464 * @return A handle to the item added or @c NULL, on errors.
8466 * This adds an item to the end of the gengrid.
8468 * @see elm_gengrid_item_append()
8469 * @see elm_gengrid_item_insert_before()
8470 * @see elm_gengrid_item_insert_after()
8471 * @see elm_gengrid_item_del()
8475 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);
8478 * Insert an item before another in a gengrid widget
8480 * @param obj The gengrid object.
8481 * @param gic The item class for the item.
8482 * @param data The item data.
8483 * @param relative The item to place this new one before.
8484 * @param func Convenience function called when the item is
8486 * @param func_data Data to be passed to @p func.
8487 * @return A handle to the item added or @c NULL, on errors.
8489 * This inserts an item before another in the gengrid.
8491 * @see elm_gengrid_item_append()
8492 * @see elm_gengrid_item_prepend()
8493 * @see elm_gengrid_item_insert_after()
8494 * @see elm_gengrid_item_del()
8498 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);
8501 * Insert an item after another in a gengrid widget
8503 * @param obj The gengrid object.
8504 * @param gic The item class for the item.
8505 * @param data The item data.
8506 * @param relative The item to place this new one after.
8507 * @param func Convenience function called when the item is
8509 * @param func_data Data to be passed to @p func.
8510 * @return A handle to the item added or @c NULL, on errors.
8512 * This inserts an item after another in the gengrid.
8514 * @see elm_gengrid_item_append()
8515 * @see elm_gengrid_item_prepend()
8516 * @see elm_gengrid_item_insert_after()
8517 * @see elm_gengrid_item_del()
8521 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);
8524 * Insert an item in a gengrid widget using a user-defined sort function.
8526 * @param obj The gengrid object.
8527 * @param gic The item class for the item.
8528 * @param data The item data.
8529 * @param comp User defined comparison function that defines the sort order based on
8530 * Elm_Gen_Item and its data param.
8531 * @param func Convenience function called when the item is selected.
8532 * @param func_data Data to be passed to @p func.
8533 * @return A handle to the item added or @c NULL, on errors.
8535 * This inserts an item in the gengrid based on user defined comparison function.
8537 * @see elm_gengrid_item_append()
8538 * @see elm_gengrid_item_prepend()
8539 * @see elm_gengrid_item_insert_after()
8540 * @see elm_gengrid_item_del()
8541 * @see elm_gengrid_item_direct_sorted_insert()
8545 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);
8548 * Insert an item in a gengrid widget using a user-defined sort function.
8550 * @param obj The gengrid object.
8551 * @param gic The item class for the item.
8552 * @param data The item data.
8553 * @param comp User defined comparison function that defines the sort order based on
8555 * @param func Convenience function called when the item is selected.
8556 * @param func_data Data to be passed to @p func.
8557 * @return A handle to the item added or @c NULL, on errors.
8559 * This inserts an item in the gengrid based on user defined comparison function.
8561 * @see elm_gengrid_item_append()
8562 * @see elm_gengrid_item_prepend()
8563 * @see elm_gengrid_item_insert_after()
8564 * @see elm_gengrid_item_del()
8565 * @see elm_gengrid_item_sorted_insert()
8569 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);
8572 * Set whether items on a given gengrid widget are to get their
8573 * selection callbacks issued for @b every subsequent selection
8574 * click on them or just for the first click.
8576 * @param obj The gengrid object
8577 * @param always_select @c EINA_TRUE to make items "always
8578 * selected", @c EINA_FALSE, otherwise
8580 * By default, grid items will only call their selection callback
8581 * function when firstly getting selected, any subsequent further
8582 * clicks will do nothing. With this call, you make those
8583 * subsequent clicks also to issue the selection callbacks.
8585 * @note <b>Double clicks</b> will @b always be reported on items.
8587 * @see elm_gengrid_always_select_mode_get()
8591 EINA_DEPRECATED EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8594 * Get whether items on a given gengrid widget have their selection
8595 * callbacks issued for @b every subsequent selection click on them
8596 * or just for the first click.
8598 * @param obj The gengrid object.
8599 * @return @c EINA_TRUE if the gengrid items are "always selected",
8600 * @c EINA_FALSE, otherwise
8602 * @see elm_gengrid_always_select_mode_set() for more details
8606 EINA_DEPRECATED EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8609 * Set whether items on a given gengrid widget can be selected or not.
8611 * @param obj The gengrid object
8612 * @param no_select @c EINA_TRUE to make items selectable,
8613 * @c EINA_FALSE otherwise
8615 * This will make items in @p obj selectable or not. In the latter
8616 * case, any user interaction on the gengrid items will neither make
8617 * them appear selected nor them call their selection callback
8620 * @see elm_gengrid_no_select_mode_get()
8624 EINA_DEPRECATED EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8627 * Get whether items on a given gengrid widget can be selected or
8630 * @param obj The gengrid object
8631 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8634 * @see elm_gengrid_no_select_mode_set() for more details
8638 EINA_DEPRECATED EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8641 * Enable or disable multi-selection in a given gengrid widget
8643 * @param obj The gengrid object.
8644 * @param multi @c EINA_TRUE, to enable multi-selection,
8645 * @c EINA_FALSE to disable it.
8647 * Multi-selection is the ability to have @b more than one
8648 * item selected, on a given gengrid, simultaneously. When it is
8649 * enabled, a sequence of clicks on different items will make them
8650 * all selected, progressively. A click on an already selected item
8651 * will unselect it. If interacting via the keyboard,
8652 * multi-selection is enabled while holding the "Shift" key.
8654 * @note By default, multi-selection is @b disabled on gengrids
8656 * @see elm_gengrid_multi_select_get()
8660 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8663 * Get whether multi-selection is enabled or disabled for a given
8666 * @param obj The gengrid object.
8667 * @return @c EINA_TRUE, if multi-selection is enabled, @c
8668 * EINA_FALSE otherwise
8670 * @see elm_gengrid_multi_select_set() for more details
8674 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8677 * Enable or disable bouncing effect for a given gengrid widget
8679 * @param obj The gengrid object
8680 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8681 * @c EINA_FALSE to disable it
8682 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8683 * @c EINA_FALSE to disable it
8685 * The bouncing effect occurs whenever one reaches the gengrid's
8686 * edge's while panning it -- it will scroll past its limits a
8687 * little bit and return to the edge again, in a animated for,
8690 * @note By default, gengrids have bouncing enabled on both axis
8692 * @see elm_gengrid_bounce_get()
8696 EINA_DEPRECATED EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8699 * Get whether bouncing effects are enabled or disabled, for a
8700 * given gengrid widget, on each axis
8702 * @param obj The gengrid object
8703 * @param h_bounce Pointer to a variable where to store the
8704 * horizontal bouncing flag.
8705 * @param v_bounce Pointer to a variable where to store the
8706 * vertical bouncing flag.
8708 * @see elm_gengrid_bounce_set() for more details
8712 EINA_DEPRECATED EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8715 * Set a given gengrid widget's scrolling page size, relative to
8716 * its viewport size.
8718 * @param obj The gengrid object
8719 * @param h_pagerel The horizontal page (relative) size
8720 * @param v_pagerel The vertical page (relative) size
8722 * The gengrid's scroller is capable of binding scrolling by the
8723 * user to "pages". It means that, while scrolling and, specially
8724 * after releasing the mouse button, the grid will @b snap to the
8725 * nearest displaying page's area. When page sizes are set, the
8726 * grid's continuous content area is split into (equal) page sized
8729 * This function sets the size of a page <b>relatively to the
8730 * viewport dimensions</b> of the gengrid, for each axis. A value
8731 * @c 1.0 means "the exact viewport's size", in that axis, while @c
8732 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8733 * a viewport". Sane usable values are, than, between @c 0.0 and @c
8734 * 1.0. Values beyond those will make it behave behave
8735 * inconsistently. If you only want one axis to snap to pages, use
8736 * the value @c 0.0 for the other one.
8738 * There is a function setting page size values in @b absolute
8739 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8740 * is mutually exclusive to this one.
8742 * @see elm_gengrid_page_relative_get()
8746 EINA_DEPRECATED EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8749 * Get a given gengrid widget's scrolling page size, relative to
8750 * its viewport size.
8752 * @param obj The gengrid object
8753 * @param h_pagerel Pointer to a variable where to store the
8754 * horizontal page (relative) size
8755 * @param v_pagerel Pointer to a variable where to store the
8756 * vertical page (relative) size
8758 * @see elm_gengrid_page_relative_set() for more details
8762 EINA_DEPRECATED EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8765 * Set a given gengrid widget's scrolling page size
8767 * @param obj The gengrid object
8768 * @param h_pagerel The horizontal page size, in pixels
8769 * @param v_pagerel The vertical page size, in pixels
8771 * The gengrid's scroller is capable of binding scrolling by the
8772 * user to "pages". It means that, while scrolling and, specially
8773 * after releasing the mouse button, the grid will @b snap to the
8774 * nearest displaying page's area. When page sizes are set, the
8775 * grid's continuous content area is split into (equal) page sized
8778 * This function sets the size of a page of the gengrid, in pixels,
8779 * for each axis. Sane usable values are, between @c 0 and the
8780 * dimensions of @p obj, for each axis. Values beyond those will
8781 * make it behave behave inconsistently. If you only want one axis
8782 * to snap to pages, use the value @c 0 for the other one.
8784 * There is a function setting page size values in @b relative
8785 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8786 * use is mutually exclusive to this one.
8790 EINA_DEPRECATED EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8793 * @brief Get gengrid current page number.
8795 * @param obj The gengrid object
8796 * @param h_pagenumber The horizontal page number
8797 * @param v_pagenumber The vertical page number
8799 * The page number starts from 0. 0 is the first page.
8800 * Current page means the page which meet the top-left of the viewport.
8801 * If there are two or more pages in the viewport, it returns the number of page
8802 * which meet the top-left of the viewport.
8804 * @see elm_gengrid_last_page_get()
8805 * @see elm_gengrid_page_show()
8806 * @see elm_gengrid_page_brint_in()
8808 EINA_DEPRECATED EAPI void elm_gengrid_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8811 * @brief Get scroll last page number.
8813 * @param obj The gengrid object
8814 * @param h_pagenumber The horizontal page number
8815 * @param v_pagenumber The vertical page number
8817 * The page number starts from 0. 0 is the first page.
8818 * This returns the last page number among the pages.
8820 * @see elm_gengrid_current_page_get()
8821 * @see elm_gengrid_page_show()
8822 * @see elm_gengrid_page_brint_in()
8824 EINA_DEPRECATED EAPI void elm_gengrid_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8827 * Show a specific virtual region within the gengrid content object by page number.
8829 * @param obj The gengrid object
8830 * @param h_pagenumber The horizontal page number
8831 * @param v_pagenumber The vertical page number
8833 * 0, 0 of the indicated page is located at the top-left of the viewport.
8834 * This will jump to the page directly without animation.
8839 * sc = elm_gengrid_add(win);
8840 * elm_gengrid_content_set(sc, content);
8841 * elm_gengrid_page_relative_set(sc, 1, 0);
8842 * elm_gengrid_current_page_get(sc, &h_page, &v_page);
8843 * elm_gengrid_page_show(sc, h_page + 1, v_page);
8846 * @see elm_gengrid_page_bring_in()
8848 EINA_DEPRECATED EAPI void elm_gengrid_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8851 * Show a specific virtual region within the gengrid content object by page number.
8853 * @param obj The gengrid object
8854 * @param h_pagenumber The horizontal page number
8855 * @param v_pagenumber The vertical page number
8857 * 0, 0 of the indicated page is located at the top-left of the viewport.
8858 * This will slide to the page with animation.
8863 * sc = elm_gengrid_add(win);
8864 * elm_gengrid_content_set(sc, content);
8865 * elm_gengrid_page_relative_set(sc, 1, 0);
8866 * elm_gengrid_last_page_get(sc, &h_page, &v_page);
8867 * elm_gengrid_page_bring_in(sc, h_page, v_page);
8870 * @see elm_gengrid_page_show()
8872 EINA_DEPRECATED EAPI void elm_gengrid_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8875 * Set the direction in which a given gengrid widget will expand while
8876 * placing its items.
8878 * @param obj The gengrid object.
8879 * @param setting @c EINA_TRUE to make the gengrid expand
8880 * horizontally, @c EINA_FALSE to expand vertically.
8882 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8883 * in @b columns, from top to bottom and, when the space for a
8884 * column is filled, another one is started on the right, thus
8885 * expanding the grid horizontally. When in "vertical mode"
8886 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8887 * to right and, when the space for a row is filled, another one is
8888 * started below, thus expanding the grid vertically.
8890 * @see elm_gengrid_horizontal_get()
8894 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8897 * Get for what direction a given gengrid widget will expand while
8898 * placing its items.
8900 * @param obj The gengrid object.
8901 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8902 * @c EINA_FALSE if it's set to expand vertically.
8904 * @see elm_gengrid_horizontal_set() for more detais
8908 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8911 * Get the first item in a given gengrid widget
8913 * @param obj The gengrid object
8914 * @return The first item's handle or @c NULL, if there are no
8915 * items in @p obj (and on errors)
8917 * This returns the first item in the @p obj's internal list of
8920 * @see elm_gengrid_last_item_get()
8924 EINA_DEPRECATED EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8927 * Get the last item in a given gengrid widget
8929 * @param obj The gengrid object
8930 * @return The last item's handle or @c NULL, if there are no
8931 * items in @p obj (and on errors)
8933 * This returns the last item in the @p obj's internal list of
8936 * @see elm_gengrid_first_item_get()
8940 EINA_DEPRECATED EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8943 * Get the @b next item in a gengrid widget's internal list of items,
8944 * given a handle to one of those items.
8946 * @param item The gengrid item to fetch next from
8947 * @return The item after @p item, or @c NULL if there's none (and
8950 * This returns the item placed after the @p item, on the container
8953 * @see elm_gengrid_item_prev_get()
8957 EINA_DEPRECATED EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8960 * Get the @b previous item in a gengrid widget's internal list of items,
8961 * given a handle to one of those items.
8963 * @param item The gengrid item to fetch previous from
8964 * @return The item before @p item, or @c NULL if there's none (and
8967 * This returns the item placed before the @p item, on the container
8970 * @see elm_gengrid_item_next_get()
8974 EINA_DEPRECATED EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8977 * Get the gengrid object's handle which contains a given gengrid
8980 * @param item The item to fetch the container from
8981 * @return The gengrid (parent) object
8983 * This returns the gengrid object itself that an item belongs to.
8987 EINA_DEPRECATED EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8990 * Remove a gengrid item from its parent, deleting it.
8992 * @param item The item to be removed.
8993 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8995 * @see elm_gengrid_clear(), to remove all items in a gengrid at
9000 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9003 * Update the contents of a given gengrid item
9005 * @param item The gengrid item
9007 * This updates an item by calling all the item class functions
9008 * again to get the contents, labels and states. Use this when the
9009 * original item data has changed and you want the changes to be
9014 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9017 * Get the Gengrid Item class for the given Gengrid Item.
9019 * @param item The gengrid item
9021 * This returns the Gengrid_Item_Class for the given item. It can be used to examine
9022 * the function pointers and item_style.
9026 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9029 * Get the Gengrid Item class for the given Gengrid Item.
9031 * This sets the Gengrid_Item_Class for the given item. It can be used to examine
9032 * the function pointers and item_style.
9034 * @param item The gengrid item
9035 * @param gic The gengrid item class describing the function pointers and the item style.
9039 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
9042 * Return the data associated to a given gengrid item
9044 * @param item The gengrid item.
9045 * @return the data associated with this item.
9047 * This returns the @c data value passed on the
9048 * elm_gengrid_item_append() and related item addition calls.
9050 * @see elm_gengrid_item_append()
9051 * @see elm_gengrid_item_data_set()
9055 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9058 * Set the data associated with a given gengrid item
9060 * @param item The gengrid item
9061 * @param data The data pointer to set on it
9063 * This @b overrides the @c data value passed on the
9064 * elm_gengrid_item_append() and related item addition calls. This
9065 * function @b won't call elm_gengrid_item_update() automatically,
9066 * so you'd issue it afterwards if you want to have the item
9067 * updated to reflect the new data.
9069 * @see elm_gengrid_item_data_get()
9070 * @see elm_gengrid_item_update()
9074 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
9077 * Get a given gengrid item's position, relative to the whole
9078 * gengrid's grid area.
9080 * @param item The Gengrid item.
9081 * @param x Pointer to variable to store the item's <b>row number</b>.
9082 * @param y Pointer to variable to store the item's <b>column number</b>.
9084 * This returns the "logical" position of the item within the
9085 * gengrid. For example, @c (0, 1) would stand for first row,
9090 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
9093 * Set whether a given gengrid item is selected or not
9095 * @param item The gengrid item
9096 * @param selected Use @c EINA_TRUE, to make it selected, @c
9097 * EINA_FALSE to make it unselected
9099 * This sets the selected state of an item. If multi-selection is
9100 * not enabled on the containing gengrid and @p selected is @c
9101 * EINA_TRUE, any other previously selected items will get
9102 * unselected in favor of this new one.
9104 * @see elm_gengrid_item_selected_get()
9108 EINA_DEPRECATED EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
9111 * Get whether a given gengrid item is selected or not
9113 * @param item The gengrid item
9114 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
9116 * This API returns EINA_TRUE for all the items selected in multi-select mode as well.
9118 * @see elm_gengrid_item_selected_set() for more details
9122 EINA_DEPRECATED EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9125 * Get the real Evas object created to implement the view of a
9126 * given gengrid item
9128 * @param item The gengrid item.
9129 * @return the Evas object implementing this item's view.
9131 * This returns the actual Evas object used to implement the
9132 * specified gengrid item's view. This may be @c NULL, as it may
9133 * not have been created or may have been deleted, at any time, by
9134 * the gengrid. <b>Do not modify this object</b> (move, resize,
9135 * show, hide, etc.), as the gengrid is controlling it. This
9136 * function is for querying, emitting custom signals or hooking
9137 * lower level callbacks for events on that object. Do not delete
9138 * this object under any circumstances.
9140 * @see elm_gengrid_item_data_get()
9144 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9147 * Show the portion of a gengrid's internal grid containing a given
9148 * item, @b immediately.
9150 * @param item The item to display
9152 * This causes gengrid to @b redraw its viewport's contents to the
9153 * region contining the given @p item item, if it is not fully
9156 * @see elm_gengrid_item_bring_in()
9160 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9163 * Animatedly bring in, to the visible area of a gengrid, a given
9166 * @param item The gengrid item to display
9168 * This causes gengrid to jump to the given @p item and show
9169 * it (by scrolling), if it is not fully visible. This will use
9170 * animation to do so and take a period of time to complete.
9172 * @see elm_gengrid_item_show()
9176 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9179 * Set whether a given gengrid item is disabled or not.
9181 * @param item The gengrid item
9182 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
9183 * to enable it back.
9185 * A disabled item cannot be selected or unselected. It will also
9186 * change its appearance, to signal the user it's disabled.
9188 * @see elm_gengrid_item_disabled_get()
9192 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
9195 * Get whether a given gengrid item is disabled or not.
9197 * @param item The gengrid item
9198 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
9201 * @see elm_gengrid_item_disabled_set() for more details
9205 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9208 * Set the text to be shown in a given gengrid item's tooltips.
9210 * @param item The gengrid item
9211 * @param text The text to set in the content
9213 * This call will setup the text to be used as tooltip to that item
9214 * (analogous to elm_object_tooltip_text_set(), but being item
9215 * tooltips with higher precedence than object tooltips). It can
9216 * have only one tooltip at a time, so any previous tooltip data
9221 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
9224 * Set the content to be shown in a given gengrid item's tooltip
9226 * @param item The gengrid item.
9227 * @param func The function returning the tooltip contents.
9228 * @param data What to provide to @a func as callback data/context.
9229 * @param del_cb Called when data is not needed anymore, either when
9230 * another callback replaces @p func, the tooltip is unset with
9231 * elm_gengrid_item_tooltip_unset() or the owner @p item
9232 * dies. This callback receives as its first parameter the
9233 * given @p data, being @c event_info the item handle.
9235 * This call will setup the tooltip's contents to @p item
9236 * (analogous to elm_object_tooltip_content_cb_set(), but being
9237 * item tooltips with higher precedence than object tooltips). It
9238 * can have only one tooltip at a time, so any previous tooltip
9239 * content will get removed. @p func (with @p data) will be called
9240 * every time Elementary needs to show the tooltip and it should
9241 * return a valid Evas object, which will be fully managed by the
9242 * tooltip system, getting deleted when the tooltip is gone.
9246 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);
9249 * Unset a tooltip from a given gengrid item
9251 * @param item gengrid item to remove a previously set tooltip from.
9253 * This call removes any tooltip set on @p item. The callback
9254 * provided as @c del_cb to
9255 * elm_gengrid_item_tooltip_content_cb_set() will be called to
9256 * notify it is not used anymore (and have resources cleaned, if
9259 * @see elm_gengrid_item_tooltip_content_cb_set()
9263 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9266 * Set a different @b style for a given gengrid item's tooltip.
9268 * @param item gengrid item with tooltip set
9269 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
9270 * "default", @c "transparent", etc)
9272 * Tooltips can have <b>alternate styles</b> to be displayed on,
9273 * which are defined by the theme set on Elementary. This function
9274 * works analogously as elm_object_tooltip_style_set(), but here
9275 * applied only to gengrid item objects. The default style for
9276 * tooltips is @c "default".
9278 * @note before you set a style you should define a tooltip with
9279 * elm_gengrid_item_tooltip_content_cb_set() or
9280 * elm_gengrid_item_tooltip_text_set()
9282 * @see elm_gengrid_item_tooltip_style_get()
9286 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9289 * Get the style set a given gengrid item's tooltip.
9291 * @param item gengrid item with tooltip already set on.
9292 * @return style the theme style in use, which defaults to
9293 * "default". If the object does not have a tooltip set,
9294 * then @c NULL is returned.
9296 * @see elm_gengrid_item_tooltip_style_set() for more details
9300 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9302 * @brief Disable size restrictions on an object's tooltip
9303 * @param item The tooltip's anchor object
9304 * @param disable If EINA_TRUE, size restrictions are disabled
9305 * @return EINA_FALSE on failure, EINA_TRUE on success
9307 * This function allows a tooltip to expand beyond its parant window's canvas.
9308 * It will instead be limited only by the size of the display.
9310 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
9312 * @brief Retrieve size restriction state of an object's tooltip
9313 * @param item The tooltip's anchor object
9314 * @return If EINA_TRUE, size restrictions are disabled
9316 * This function returns whether a tooltip is allowed to expand beyond
9317 * its parant window's canvas.
9318 * It will instead be limited only by the size of the display.
9320 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
9322 * Set the type of mouse pointer/cursor decoration to be shown,
9323 * when the mouse pointer is over the given gengrid widget item
9325 * @param item gengrid item to customize cursor on
9326 * @param cursor the cursor type's name
9328 * This function works analogously as elm_object_cursor_set(), but
9329 * here the cursor's changing area is restricted to the item's
9330 * area, and not the whole widget's. Note that that item cursors
9331 * have precedence over widget cursors, so that a mouse over @p
9332 * item will always show cursor @p type.
9334 * If this function is called twice for an object, a previously set
9335 * cursor will be unset on the second call.
9337 * @see elm_object_cursor_set()
9338 * @see elm_gengrid_item_cursor_get()
9339 * @see elm_gengrid_item_cursor_unset()
9343 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
9346 * Get the type of mouse pointer/cursor decoration set to be shown,
9347 * when the mouse pointer is over the given gengrid widget item
9349 * @param item gengrid item with custom cursor set
9350 * @return the cursor type's name or @c NULL, if no custom cursors
9351 * were set to @p item (and on errors)
9353 * @see elm_object_cursor_get()
9354 * @see elm_gengrid_item_cursor_set() for more details
9355 * @see elm_gengrid_item_cursor_unset()
9359 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9362 * Unset any custom mouse pointer/cursor decoration set to be
9363 * shown, when the mouse pointer is over the given gengrid widget
9364 * item, thus making it show the @b default cursor again.
9366 * @param item a gengrid item
9368 * Use this call to undo any custom settings on this item's cursor
9369 * decoration, bringing it back to defaults (no custom style set).
9371 * @see elm_object_cursor_unset()
9372 * @see elm_gengrid_item_cursor_set() for more details
9376 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9379 * Set a different @b style for a given custom cursor set for a
9382 * @param item gengrid item with custom cursor set
9383 * @param style the <b>theme style</b> to use (e.g. @c "default",
9384 * @c "transparent", etc)
9386 * This function only makes sense when one is using custom mouse
9387 * cursor decorations <b>defined in a theme file</b> , which can
9388 * have, given a cursor name/type, <b>alternate styles</b> on
9389 * it. It works analogously as elm_object_cursor_style_set(), but
9390 * here applied only to gengrid item objects.
9392 * @warning Before you set a cursor style you should have defined a
9393 * custom cursor previously on the item, with
9394 * elm_gengrid_item_cursor_set()
9396 * @see elm_gengrid_item_cursor_engine_only_set()
9397 * @see elm_gengrid_item_cursor_style_get()
9401 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9404 * Get the current @b style set for a given gengrid item's custom
9407 * @param item gengrid item with custom cursor set.
9408 * @return style the cursor style in use. If the object does not
9409 * have a cursor set, then @c NULL is returned.
9411 * @see elm_gengrid_item_cursor_style_set() for more details
9415 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9418 * Set if the (custom) cursor for a given gengrid item should be
9419 * searched in its theme, also, or should only rely on the
9422 * @param item item with custom (custom) cursor already set on
9423 * @param engine_only Use @c EINA_TRUE to have cursors looked for
9424 * only on those provided by the rendering engine, @c EINA_FALSE to
9425 * have them searched on the widget's theme, as well.
9427 * @note This call is of use only if you've set a custom cursor
9428 * for gengrid items, with elm_gengrid_item_cursor_set().
9430 * @note By default, cursors will only be looked for between those
9431 * provided by the rendering engine.
9435 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9438 * Get if the (custom) cursor for a given gengrid item is being
9439 * searched in its theme, also, or is only relying on the rendering
9442 * @param item a gengrid item
9443 * @return @c EINA_TRUE, if cursors are being looked for only on
9444 * those provided by the rendering engine, @c EINA_FALSE if they
9445 * are being searched on the widget's theme, as well.
9447 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
9451 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9454 * Remove all items from a given gengrid widget
9456 * @param obj The gengrid object.
9458 * This removes (and deletes) all items in @p obj, leaving it
9461 * @see elm_gengrid_item_del(), to remove just one item.
9465 EINA_DEPRECATED EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9468 * Get the selected item in a given gengrid widget
9470 * @param obj The gengrid object.
9471 * @return The selected item's handleor @c NULL, if none is
9472 * selected at the moment (and on errors)
9474 * This returns the selected item in @p obj. If multi selection is
9475 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
9476 * the first item in the list is selected, which might not be very
9477 * useful. For that case, see elm_gengrid_selected_items_get().
9481 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9484 * Get <b>a list</b> of selected items in a given gengrid
9486 * @param obj The gengrid object.
9487 * @return The list of selected items or @c NULL, if none is
9488 * selected at the moment (and on errors)
9490 * This returns a list of the selected items, in the order that
9491 * they appear in the grid. This list is only valid as long as no
9492 * more items are selected or unselected (or unselected implictly
9493 * by deletion). The list contains #Elm_Gengrid_Item pointers as
9496 * @see elm_gengrid_selected_item_get()
9500 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9507 * @defgroup Clock Clock
9509 * @image html img/widget/clock/preview-00.png
9510 * @image latex img/widget/clock/preview-00.eps
9512 * This is a @b digital clock widget. In its default theme, it has a
9513 * vintage "flipping numbers clock" appearance, which will animate
9514 * sheets of individual algarisms individually as time goes by.
9516 * A newly created clock will fetch system's time (already
9517 * considering local time adjustments) to start with, and will tick
9518 * accondingly. It may or may not show seconds.
9520 * Clocks have an @b edition mode. When in it, the sheets will
9521 * display extra arrow indications on the top and bottom and the
9522 * user may click on them to raise or lower the time values. After
9523 * it's told to exit edition mode, it will keep ticking with that
9524 * new time set (it keeps the difference from local time).
9526 * Also, when under edition mode, user clicks on the cited arrows
9527 * which are @b held for some time will make the clock to flip the
9528 * sheet, thus editing the time, continuosly and automatically for
9529 * the user. The interval between sheet flips will keep growing in
9530 * time, so that it helps the user to reach a time which is distant
9533 * The time display is, by default, in military mode (24h), but an
9534 * am/pm indicator may be optionally shown, too, when it will
9537 * Smart callbacks one can register to:
9538 * - "changed" - the clock's user changed the time
9540 * Here is an example on its usage:
9541 * @li @ref clock_example
9550 * Identifiers for which clock digits should be editable, when a
9551 * clock widget is in edition mode. Values may be ORed together to
9552 * make a mask, naturally.
9554 * @see elm_clock_edit_set()
9555 * @see elm_clock_digit_edit_set()
9557 typedef enum _Elm_Clock_Digedit
9559 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9560 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9561 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
9562 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9563 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
9564 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9565 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
9566 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
9567 } Elm_Clock_Digedit;
9570 * Add a new clock widget to the given parent Elementary
9571 * (container) object
9573 * @param parent The parent object
9574 * @return a new clock widget handle or @c NULL, on errors
9576 * This function inserts a new clock widget on the canvas.
9580 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9583 * Set a clock widget's time, programmatically
9585 * @param obj The clock widget object
9586 * @param hrs The hours to set
9587 * @param min The minutes to set
9588 * @param sec The secondes to set
9590 * This function updates the time that is showed by the clock
9593 * Values @b must be set within the following ranges:
9594 * - 0 - 23, for hours
9595 * - 0 - 59, for minutes
9596 * - 0 - 59, for seconds,
9598 * even if the clock is not in "military" mode.
9600 * @warning The behavior for values set out of those ranges is @b
9605 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9608 * Get a clock widget's time values
9610 * @param obj The clock object
9611 * @param[out] hrs Pointer to the variable to get the hours value
9612 * @param[out] min Pointer to the variable to get the minutes value
9613 * @param[out] sec Pointer to the variable to get the seconds value
9615 * This function gets the time set for @p obj, returning
9616 * it on the variables passed as the arguments to function
9618 * @note Use @c NULL pointers on the time values you're not
9619 * interested in: they'll be ignored by the function.
9623 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9626 * Set whether a given clock widget is under <b>edition mode</b> or
9627 * under (default) displaying-only mode.
9629 * @param obj The clock object
9630 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9631 * put it back to "displaying only" mode
9633 * This function makes a clock's time to be editable or not <b>by
9634 * user interaction</b>. When in edition mode, clocks @b stop
9635 * ticking, until one brings them back to canonical mode. The
9636 * elm_clock_digit_edit_set() function will influence which digits
9637 * of the clock will be editable. By default, all of them will be
9638 * (#ELM_CLOCK_NONE).
9640 * @note am/pm sheets, if being shown, will @b always be editable
9641 * under edition mode.
9643 * @see elm_clock_edit_get()
9647 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9650 * Retrieve whether a given clock widget is under <b>edition
9651 * mode</b> or under (default) displaying-only mode.
9653 * @param obj The clock object
9654 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9657 * This function retrieves whether the clock's time can be edited
9658 * or not by user interaction.
9660 * @see elm_clock_edit_set() for more details
9664 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9667 * Set what digits of the given clock widget should be editable
9668 * when in edition mode.
9670 * @param obj The clock object
9671 * @param digedit Bit mask indicating the digits to be editable
9672 * (values in #Elm_Clock_Digedit).
9674 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9675 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9678 * @see elm_clock_digit_edit_get()
9682 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9685 * Retrieve what digits of the given clock widget should be
9686 * editable when in edition mode.
9688 * @param obj The clock object
9689 * @return Bit mask indicating the digits to be editable
9690 * (values in #Elm_Clock_Digedit).
9692 * @see elm_clock_digit_edit_set() for more details
9696 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9699 * Set if the given clock widget must show hours in military or
9702 * @param obj The clock object
9703 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9706 * This function sets if the clock must show hours in military or
9707 * am/pm mode. In some countries like Brazil the military mode
9708 * (00-24h-format) is used, in opposition to the USA, where the
9709 * am/pm mode is more commonly used.
9711 * @see elm_clock_show_am_pm_get()
9715 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9718 * Get if the given clock widget shows hours in military or am/pm
9721 * @param obj The clock object
9722 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9725 * This function gets if the clock shows hours in military or am/pm
9728 * @see elm_clock_show_am_pm_set() for more details
9732 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9735 * Set if the given clock widget must show time with seconds or not
9737 * @param obj The clock object
9738 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9740 * This function sets if the given clock must show or not elapsed
9741 * seconds. By default, they are @b not shown.
9743 * @see elm_clock_show_seconds_get()
9747 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9750 * Get whether the given clock widget is showing time with seconds
9753 * @param obj The clock object
9754 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9756 * This function gets whether @p obj is showing or not the elapsed
9759 * @see elm_clock_show_seconds_set()
9763 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9766 * Set the interval on time updates for an user mouse button hold
9767 * on clock widgets' time edition.
9769 * @param obj The clock object
9770 * @param interval The (first) interval value in seconds
9772 * This interval value is @b decreased while the user holds the
9773 * mouse pointer either incrementing or decrementing a given the
9774 * clock digit's value.
9776 * This helps the user to get to a given time distant from the
9777 * current one easier/faster, as it will start to flip quicker and
9778 * quicker on mouse button holds.
9780 * The calculation for the next flip interval value, starting from
9781 * the one set with this call, is the previous interval divided by
9782 * 1.05, so it decreases a little bit.
9784 * The default starting interval value for automatic flips is
9787 * @see elm_clock_interval_get()
9791 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9794 * Get the interval on time updates for an user mouse button hold
9795 * on clock widgets' time edition.
9797 * @param obj The clock object
9798 * @return The (first) interval value, in seconds, set on it
9800 * @see elm_clock_interval_set() for more details
9804 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9811 * @defgroup Layout Layout
9813 * @image html img/widget/layout/preview-00.png
9814 * @image latex img/widget/layout/preview-00.eps width=\textwidth
9816 * @image html img/layout-predefined.png
9817 * @image latex img/layout-predefined.eps width=\textwidth
9819 * This is a container widget that takes a standard Edje design file and
9820 * wraps it very thinly in a widget.
9822 * An Edje design (theme) file has a very wide range of possibilities to
9823 * describe the behavior of elements added to the Layout. Check out the Edje
9824 * documentation and the EDC reference to get more information about what can
9825 * be done with Edje.
9827 * Just like @ref List, @ref Box, and other container widgets, any
9828 * object added to the Layout will become its child, meaning that it will be
9829 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9831 * The Layout widget can contain as many Contents, Boxes or Tables as
9832 * described in its theme file. For instance, objects can be added to
9833 * different Tables by specifying the respective Table part names. The same
9834 * is valid for Content and Box.
9836 * The objects added as child of the Layout will behave as described in the
9837 * part description where they were added. There are 3 possible types of
9838 * parts where a child can be added:
9840 * @section secContent Content (SWALLOW part)
9842 * Only one object can be added to the @c SWALLOW part (but you still can
9843 * have many @c SWALLOW parts and one object on each of them). Use the @c
9844 * elm_object_content_set/get/unset functions to set, retrieve and unset
9845 * objects as content of the @c SWALLOW. After being set to this part, the
9846 * object size, position, visibility, clipping and other description
9847 * properties will be totally controled by the description of the given part
9848 * (inside the Edje theme file).
9850 * One can use @c evas_object_size_hint_* functions on the child to have some
9851 * kind of control over its behavior, but the resulting behavior will still
9852 * depend heavily on the @c SWALLOW part description.
9854 * The Edje theme also can change the part description, based on signals or
9855 * scripts running inside the theme. This change can also be animated. All of
9856 * this will affect the child object set as content accordingly. The object
9857 * size will be changed if the part size is changed, it will animate move if
9858 * the part is moving, and so on.
9860 * The following picture demonstrates a Layout widget with a child object
9861 * added to its @c SWALLOW:
9863 * @image html layout_swallow.png
9864 * @image latex layout_swallow.eps width=\textwidth
9866 * @section secBox Box (BOX part)
9868 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9869 * allows one to add objects to the box and have them distributed along its
9870 * area, accordingly to the specified @a layout property (now by @a layout we
9871 * mean the chosen layouting design of the Box, not the Layout widget
9874 * A similar effect for having a box with its position, size and other things
9875 * controled by the Layout theme would be to create an Elementary @ref Box
9876 * widget and add it as a Content in the @c SWALLOW part.
9878 * The main difference of using the Layout Box is that its behavior, the box
9879 * properties like layouting format, padding, align, etc. will be all
9880 * controled by the theme. This means, for example, that a signal could be
9881 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9882 * handled the signal by changing the box padding, or align, or both. Using
9883 * the Elementary @ref Box widget is not necessarily harder or easier, it
9884 * just depends on the circunstances and requirements.
9886 * The Layout Box can be used through the @c elm_layout_box_* set of
9889 * The following picture demonstrates a Layout widget with many child objects
9890 * added to its @c BOX part:
9892 * @image html layout_box.png
9893 * @image latex layout_box.eps width=\textwidth
9895 * @section secTable Table (TABLE part)
9897 * Just like the @ref secBox, the Layout Table is very similar to the
9898 * Elementary @ref Table widget. It allows one to add objects to the Table
9899 * specifying the row and column where the object should be added, and any
9900 * column or row span if necessary.
9902 * Again, we could have this design by adding a @ref Table widget to the @c
9903 * SWALLOW part using elm_object_content_part_set(). The same difference happens
9904 * here when choosing to use the Layout Table (a @c TABLE part) instead of
9905 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9907 * The Layout Table can be used through the @c elm_layout_table_* set of
9910 * The following picture demonstrates a Layout widget with many child objects
9911 * added to its @c TABLE part:
9913 * @image html layout_table.png
9914 * @image latex layout_table.eps width=\textwidth
9916 * @section secPredef Predefined Layouts
9918 * Another interesting thing about the Layout widget is that it offers some
9919 * predefined themes that come with the default Elementary theme. These
9920 * themes can be set by the call elm_layout_theme_set(), and provide some
9921 * basic functionality depending on the theme used.
9923 * Most of them already send some signals, some already provide a toolbar or
9924 * back and next buttons.
9926 * These are available predefined theme layouts. All of them have class = @c
9927 * layout, group = @c application, and style = one of the following options:
9929 * @li @c toolbar-content - application with toolbar and main content area
9930 * @li @c toolbar-content-back - application with toolbar and main content
9931 * area with a back button and title area
9932 * @li @c toolbar-content-back-next - application with toolbar and main
9933 * content area with a back and next buttons and title area
9934 * @li @c content-back - application with a main content area with a back
9935 * button and title area
9936 * @li @c content-back-next - application with a main content area with a
9937 * back and next buttons and title area
9938 * @li @c toolbar-vbox - application with toolbar and main content area as a
9940 * @li @c toolbar-table - application with toolbar and main content area as a
9943 * @section secExamples Examples
9945 * Some examples of the Layout widget can be found here:
9946 * @li @ref layout_example_01
9947 * @li @ref layout_example_02
9948 * @li @ref layout_example_03
9949 * @li @ref layout_example_edc
9954 * Add a new layout to the parent
9956 * @param parent The parent object
9957 * @return The new object or NULL if it cannot be created
9959 * @see elm_layout_file_set()
9960 * @see elm_layout_theme_set()
9964 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9966 * Set the file that will be used as layout
9968 * @param obj The layout object
9969 * @param file The path to file (edj) that will be used as layout
9970 * @param group The group that the layout belongs in edje file
9972 * @return (1 = success, 0 = error)
9976 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9978 * Set the edje group from the elementary theme that will be used as layout
9980 * @param obj The layout object
9981 * @param clas the clas of the group
9982 * @param group the group
9983 * @param style the style to used
9985 * @return (1 = success, 0 = error)
9989 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9991 * Set the layout content.
9993 * @param obj The layout object
9994 * @param swallow The swallow part name in the edje file
9995 * @param content The child that will be added in this layout object
9997 * Once the content object is set, a previously set one will be deleted.
9998 * If you want to keep that old content object, use the
9999 * elm_object_content_part_unset() function.
10001 * @note In an Edje theme, the part used as a content container is called @c
10002 * SWALLOW. This is why the parameter name is called @p swallow, but it is
10003 * expected to be a part name just like the second parameter of
10004 * elm_layout_box_append().
10006 * @see elm_layout_box_append()
10007 * @see elm_object_content_part_get()
10008 * @see elm_object_content_part_unset()
10013 EINA_DEPRECATED EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10015 * Get the child object in the given content part.
10017 * @param obj The layout object
10018 * @param swallow The SWALLOW part to get its content
10020 * @return The swallowed object or NULL if none or an error occurred
10022 * @see elm_object_content_part_set()
10026 EINA_DEPRECATED EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10028 * Unset the layout content.
10030 * @param obj The layout object
10031 * @param swallow The swallow part name in the edje file
10032 * @return The content that was being used
10034 * Unparent and return the content object which was set for this part.
10036 * @see elm_object_content_part_set()
10040 EINA_DEPRECATED EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10042 * Set the text of the given part
10044 * @param obj The layout object
10045 * @param part The TEXT part where to set the text
10046 * @param text The text to set
10049 * @deprecated use elm_object_text_* instead.
10051 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
10053 * Get the text set in the given part
10055 * @param obj The layout object
10056 * @param part The TEXT part to retrieve the text off
10058 * @return The text set in @p part
10061 * @deprecated use elm_object_text_* instead.
10063 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
10065 * Append child to layout box part.
10067 * @param obj the layout object
10068 * @param part the box part to which the object will be appended.
10069 * @param child the child object to append to box.
10071 * Once the object is appended, it will become child of the layout. Its
10072 * lifetime will be bound to the layout, whenever the layout dies the child
10073 * will be deleted automatically. One should use elm_layout_box_remove() to
10074 * make this layout forget about the object.
10076 * @see elm_layout_box_prepend()
10077 * @see elm_layout_box_insert_before()
10078 * @see elm_layout_box_insert_at()
10079 * @see elm_layout_box_remove()
10083 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10085 * Prepend child to layout box part.
10087 * @param obj the layout object
10088 * @param part the box part to prepend.
10089 * @param child the child object to prepend to box.
10091 * Once the object is prepended, it will become child of the layout. Its
10092 * lifetime will be bound to the layout, whenever the layout dies the child
10093 * will be deleted automatically. One should use elm_layout_box_remove() to
10094 * make this layout forget about the object.
10096 * @see elm_layout_box_append()
10097 * @see elm_layout_box_insert_before()
10098 * @see elm_layout_box_insert_at()
10099 * @see elm_layout_box_remove()
10103 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10105 * Insert child to layout box part before a reference object.
10107 * @param obj the layout object
10108 * @param part the box part to insert.
10109 * @param child the child object to insert into box.
10110 * @param reference another reference object to insert before in box.
10112 * Once the object is inserted, it will become child of the layout. Its
10113 * lifetime will be bound to the layout, whenever the layout dies the child
10114 * will be deleted automatically. One should use elm_layout_box_remove() to
10115 * make this layout forget about the object.
10117 * @see elm_layout_box_append()
10118 * @see elm_layout_box_prepend()
10119 * @see elm_layout_box_insert_before()
10120 * @see elm_layout_box_remove()
10124 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
10126 * Insert child to layout box part at a given position.
10128 * @param obj the layout object
10129 * @param part the box part to insert.
10130 * @param child the child object to insert into box.
10131 * @param pos the numeric position >=0 to insert the child.
10133 * Once the object is inserted, it will become child of the layout. Its
10134 * lifetime will be bound to the layout, whenever the layout dies the child
10135 * will be deleted automatically. One should use elm_layout_box_remove() to
10136 * make this layout forget about the object.
10138 * @see elm_layout_box_append()
10139 * @see elm_layout_box_prepend()
10140 * @see elm_layout_box_insert_before()
10141 * @see elm_layout_box_remove()
10145 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
10147 * Remove a child of the given part box.
10149 * @param obj The layout object
10150 * @param part The box part name to remove child.
10151 * @param child The object to remove from box.
10152 * @return The object that was being used, or NULL if not found.
10154 * The object will be removed from the box part and its lifetime will
10155 * not be handled by the layout anymore. This is equivalent to
10156 * elm_object_content_part_unset() for box.
10158 * @see elm_layout_box_append()
10159 * @see elm_layout_box_remove_all()
10163 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
10165 * Remove all child of the given part box.
10167 * @param obj The layout object
10168 * @param part The box part name to remove child.
10169 * @param clear If EINA_TRUE, then all objects will be deleted as
10170 * well, otherwise they will just be removed and will be
10171 * dangling on the canvas.
10173 * The objects will be removed from the box part and their lifetime will
10174 * not be handled by the layout anymore. This is equivalent to
10175 * elm_layout_box_remove() for all box children.
10177 * @see elm_layout_box_append()
10178 * @see elm_layout_box_remove()
10182 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10184 * Insert child to layout table part.
10186 * @param obj the layout object
10187 * @param part the box part to pack child.
10188 * @param child_obj the child object to pack into table.
10189 * @param col the column to which the child should be added. (>= 0)
10190 * @param row the row to which the child should be added. (>= 0)
10191 * @param colspan how many columns should be used to store this object. (>=
10193 * @param rowspan how many rows should be used to store this object. (>= 1)
10195 * Once the object is inserted, it will become child of the table. Its
10196 * lifetime will be bound to the layout, and whenever the layout dies the
10197 * child will be deleted automatically. One should use
10198 * elm_layout_table_remove() to make this layout forget about the object.
10200 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
10201 * more space than a single cell. For instance, the following code:
10203 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
10206 * Would result in an object being added like the following picture:
10208 * @image html layout_colspan.png
10209 * @image latex layout_colspan.eps width=\textwidth
10211 * @see elm_layout_table_unpack()
10212 * @see elm_layout_table_clear()
10216 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);
10218 * Unpack (remove) a child of the given part table.
10220 * @param obj The layout object
10221 * @param part The table part name to remove child.
10222 * @param child_obj The object to remove from table.
10223 * @return The object that was being used, or NULL if not found.
10225 * The object will be unpacked from the table part and its lifetime
10226 * will not be handled by the layout anymore. This is equivalent to
10227 * elm_object_content_part_unset() for table.
10229 * @see elm_layout_table_pack()
10230 * @see elm_layout_table_clear()
10234 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
10236 * Remove all child of the given part table.
10238 * @param obj The layout object
10239 * @param part The table part name to remove child.
10240 * @param clear If EINA_TRUE, then all objects will be deleted as
10241 * well, otherwise they will just be removed and will be
10242 * dangling on the canvas.
10244 * The objects will be removed from the table part and their lifetime will
10245 * not be handled by the layout anymore. This is equivalent to
10246 * elm_layout_table_unpack() for all table children.
10248 * @see elm_layout_table_pack()
10249 * @see elm_layout_table_unpack()
10253 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10255 * Get the edje layout
10257 * @param obj The layout object
10259 * @return A Evas_Object with the edje layout settings loaded
10260 * with function elm_layout_file_set
10262 * This returns the edje object. It is not expected to be used to then
10263 * swallow objects via edje_object_part_swallow() for example. Use
10264 * elm_object_content_part_set() instead so child object handling and sizing is
10267 * @note This function should only be used if you really need to call some
10268 * low level Edje function on this edje object. All the common stuff (setting
10269 * text, emitting signals, hooking callbacks to signals, etc.) can be done
10270 * with proper elementary functions.
10272 * @see elm_object_signal_callback_add()
10273 * @see elm_object_signal_emit()
10274 * @see elm_object_text_part_set()
10275 * @see elm_object_content_part_set()
10276 * @see elm_layout_box_append()
10277 * @see elm_layout_table_pack()
10278 * @see elm_layout_data_get()
10282 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10284 * Get the edje data from the given layout
10286 * @param obj The layout object
10287 * @param key The data key
10289 * @return The edje data string
10291 * This function fetches data specified inside the edje theme of this layout.
10292 * This function return NULL if data is not found.
10294 * In EDC this comes from a data block within the group block that @p
10295 * obj was loaded from. E.g.
10302 * item: "key1" "value1";
10303 * item: "key2" "value2";
10311 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
10315 * @param obj The layout object
10317 * Manually forces a sizing re-evaluation. This is useful when the minimum
10318 * size required by the edje theme of this layout has changed. The change on
10319 * the minimum size required by the edje theme is not immediately reported to
10320 * the elementary layout, so one needs to call this function in order to tell
10321 * the widget (layout) that it needs to reevaluate its own size.
10323 * The minimum size of the theme is calculated based on minimum size of
10324 * parts, the size of elements inside containers like box and table, etc. All
10325 * of this can change due to state changes, and that's when this function
10326 * should be called.
10328 * Also note that a standard signal of "size,eval" "elm" emitted from the
10329 * edje object will cause this to happen too.
10333 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
10336 * Sets a specific cursor for an edje part.
10338 * @param obj The layout object.
10339 * @param part_name a part from loaded edje group.
10340 * @param cursor cursor name to use, see Elementary_Cursor.h
10342 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10343 * part not exists or it has "mouse_events: 0".
10347 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
10350 * Get the cursor to be shown when mouse is over an edje part
10352 * @param obj The layout object.
10353 * @param part_name a part from loaded edje group.
10354 * @return the cursor name.
10358 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10361 * Unsets a cursor previously set with elm_layout_part_cursor_set().
10363 * @param obj The layout object.
10364 * @param part_name a part from loaded edje group, that had a cursor set
10365 * with elm_layout_part_cursor_set().
10369 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10372 * Sets a specific cursor style for an edje part.
10374 * @param obj The layout object.
10375 * @param part_name a part from loaded edje group.
10376 * @param style the theme style to use (default, transparent, ...)
10378 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10379 * part not exists or it did not had a cursor set.
10383 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
10386 * Gets a specific cursor style for an edje part.
10388 * @param obj The layout object.
10389 * @param part_name a part from loaded edje group.
10391 * @return the theme style in use, defaults to "default". If the
10392 * object does not have a cursor set, then NULL is returned.
10396 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10399 * Sets if the cursor set should be searched on the theme or should use
10400 * the provided by the engine, only.
10402 * @note before you set if should look on theme you should define a
10403 * cursor with elm_layout_part_cursor_set(). By default it will only
10404 * look for cursors provided by the engine.
10406 * @param obj The layout object.
10407 * @param part_name a part from loaded edje group.
10408 * @param engine_only if cursors should be just provided by the engine
10409 * or should also search on widget's theme as well
10411 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10412 * part not exists or it did not had a cursor set.
10416 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);
10419 * Gets a specific cursor engine_only for an edje part.
10421 * @param obj The layout object.
10422 * @param part_name a part from loaded edje group.
10424 * @return whenever the cursor is just provided by engine or also from theme.
10428 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10431 * @def elm_layout_icon_set
10432 * Convienience macro to set the icon object in a layout that follows the
10433 * Elementary naming convention for its parts.
10437 #define elm_layout_icon_set(_ly, _obj) \
10440 elm_object_content_part_set((_ly), "elm.swallow.icon", (_obj)); \
10441 if ((_obj)) sig = "elm,state,icon,visible"; \
10442 else sig = "elm,state,icon,hidden"; \
10443 elm_object_signal_emit((_ly), sig, "elm"); \
10447 * @def elm_layout_icon_get
10448 * Convienience macro to get the icon object from a layout that follows the
10449 * Elementary naming convention for its parts.
10453 #define elm_layout_icon_get(_ly) \
10454 elm_object_content_part_get((_ly), "elm.swallow.icon")
10457 * @def elm_layout_end_set
10458 * Convienience macro to set the end object in a layout that follows the
10459 * Elementary naming convention for its parts.
10463 #define elm_layout_end_set(_ly, _obj) \
10466 elm_object_content_part_set((_ly), "elm.swallow.end", (_obj)); \
10467 if ((_obj)) sig = "elm,state,end,visible"; \
10468 else sig = "elm,state,end,hidden"; \
10469 elm_object_signal_emit((_ly), sig, "elm"); \
10473 * @def elm_layout_end_get
10474 * Convienience macro to get the end object in a layout that follows the
10475 * Elementary naming convention for its parts.
10479 #define elm_layout_end_get(_ly) \
10480 elm_object_content_part_get((_ly), "elm.swallow.end")
10483 * @def elm_layout_label_set
10484 * Convienience macro to set the label in a layout that follows the
10485 * Elementary naming convention for its parts.
10488 * @deprecated use elm_object_text_* instead.
10490 #define elm_layout_label_set(_ly, _txt) \
10491 elm_layout_text_set((_ly), "elm.text", (_txt))
10494 * @def elm_layout_label_get
10495 * Convenience macro to get the label in a layout that follows the
10496 * Elementary naming convention for its parts.
10499 * @deprecated use elm_object_text_* instead.
10501 #define elm_layout_label_get(_ly) \
10502 elm_layout_text_get((_ly), "elm.text")
10504 /* smart callbacks called:
10505 * "theme,changed" - when elm theme is changed.
10509 * @defgroup Notify Notify
10511 * @image html img/widget/notify/preview-00.png
10512 * @image latex img/widget/notify/preview-00.eps
10514 * Display a container in a particular region of the parent(top, bottom,
10515 * etc). A timeout can be set to automatically hide the notify. This is so
10516 * that, after an evas_object_show() on a notify object, if a timeout was set
10517 * on it, it will @b automatically get hidden after that time.
10519 * Signals that you can add callbacks for are:
10520 * @li "timeout" - when timeout happens on notify and it's hidden
10521 * @li "block,clicked" - when a click outside of the notify happens
10523 * Default contents parts of the notify widget that you can use for are:
10524 * @li "elm.swallow.content" - A content of the notify
10526 * @ref tutorial_notify show usage of the API.
10531 * @brief Possible orient values for notify.
10533 * This values should be used in conjunction to elm_notify_orient_set() to
10534 * set the position in which the notify should appear(relative to its parent)
10535 * and in conjunction with elm_notify_orient_get() to know where the notify
10538 typedef enum _Elm_Notify_Orient
10540 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
10541 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
10542 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
10543 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
10544 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
10545 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
10546 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
10547 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
10548 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10549 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10550 } Elm_Notify_Orient;
10552 * @brief Add a new notify to the parent
10554 * @param parent The parent object
10555 * @return The new object or NULL if it cannot be created
10557 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10559 * @brief Set the content of the notify widget
10561 * @param obj The notify object
10562 * @param content The content will be filled in this notify object
10564 * Once the content object is set, a previously set one will be deleted. If
10565 * you want to keep that old content object, use the
10566 * elm_notify_content_unset() function.
10568 EINA_DEPRECATED EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10570 * @brief Unset the content of the notify widget
10572 * @param obj The notify object
10573 * @return The content that was being used
10575 * Unparent and return the content object which was set for this widget
10577 * @see elm_notify_content_set()
10579 EINA_DEPRECATED EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10581 * @brief Return the content of the notify widget
10583 * @param obj The notify object
10584 * @return The content that is being used
10586 * @see elm_notify_content_set()
10588 EINA_DEPRECATED EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10590 * @brief Set the notify parent
10592 * @param obj The notify object
10593 * @param content The new parent
10595 * Once the parent object is set, a previously set one will be disconnected
10598 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10600 * @brief Get the notify parent
10602 * @param obj The notify object
10603 * @return The parent
10605 * @see elm_notify_parent_set()
10607 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10609 * @brief Set the orientation
10611 * @param obj The notify object
10612 * @param orient The new orientation
10614 * Sets the position in which the notify will appear in its parent.
10616 * @see @ref Elm_Notify_Orient for possible values.
10618 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10620 * @brief Return the orientation
10621 * @param obj The notify object
10622 * @return The orientation of the notification
10624 * @see elm_notify_orient_set()
10625 * @see Elm_Notify_Orient
10627 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10629 * @brief Set the time interval after which the notify window is going to be
10632 * @param obj The notify object
10633 * @param time The timeout in seconds
10635 * This function sets a timeout and starts the timer controlling when the
10636 * notify is hidden. Since calling evas_object_show() on a notify restarts
10637 * the timer controlling when the notify is hidden, setting this before the
10638 * notify is shown will in effect mean starting the timer when the notify is
10641 * @note Set a value <= 0.0 to disable a running timer.
10643 * @note If the value > 0.0 and the notify is previously visible, the
10644 * timer will be started with this value, canceling any running timer.
10646 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10648 * @brief Return the timeout value (in seconds)
10649 * @param obj the notify object
10651 * @see elm_notify_timeout_set()
10653 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10655 * @brief Sets whether events should be passed to by a click outside
10658 * @param obj The notify object
10659 * @param repeats EINA_TRUE Events are repeats, else no
10661 * When true if the user clicks outside the window the events will be caught
10662 * by the others widgets, else the events are blocked.
10664 * @note The default value is EINA_TRUE.
10666 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10668 * @brief Return true if events are repeat below the notify object
10669 * @param obj the notify object
10671 * @see elm_notify_repeat_events_set()
10673 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10679 * @defgroup Hover Hover
10681 * @image html img/widget/hover/preview-00.png
10682 * @image latex img/widget/hover/preview-00.eps
10684 * A Hover object will hover over its @p parent object at the @p target
10685 * location. Anything in the background will be given a darker coloring to
10686 * indicate that the hover object is on top (at the default theme). When the
10687 * hover is clicked it is dismissed(hidden), if the contents of the hover are
10688 * clicked that @b doesn't cause the hover to be dismissed.
10690 * A Hover object has two parents. One parent that owns it during creation
10691 * and the other parent being the one over which the hover object spans.
10694 * @note The hover object will take up the entire space of @p target
10697 * Elementary has the following styles for the hover widget:
10701 * @li hoversel_vertical
10703 * The following are the available position for content:
10715 * Signals that you can add callbacks for are:
10716 * @li "clicked" - the user clicked the empty space in the hover to dismiss
10717 * @li "smart,changed" - a content object placed under the "smart"
10718 * policy was replaced to a new slot direction.
10720 * See @ref tutorial_hover for more information.
10724 typedef enum _Elm_Hover_Axis
10726 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10727 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10728 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10729 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10732 * @brief Adds a hover object to @p parent
10734 * @param parent The parent object
10735 * @return The hover object or NULL if one could not be created
10737 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10739 * @brief Sets the target object for the hover.
10741 * @param obj The hover object
10742 * @param target The object to center the hover onto. The hover
10744 * This function will cause the hover to be centered on the target object.
10746 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10748 * @brief Gets the target object for the hover.
10750 * @param obj The hover object
10751 * @param parent The object to locate the hover over.
10753 * @see elm_hover_target_set()
10755 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10757 * @brief Sets the parent object for the hover.
10759 * @param obj The hover object
10760 * @param parent The object to locate the hover over.
10762 * This function will cause the hover to take up the entire space that the
10763 * parent object fills.
10765 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10767 * @brief Gets the parent object for the hover.
10769 * @param obj The hover object
10770 * @return The parent object to locate the hover over.
10772 * @see elm_hover_parent_set()
10774 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10776 * @brief Sets the content of the hover object and the direction in which it
10779 * @param obj The hover object
10780 * @param swallow The direction that the object will be displayed
10781 * at. Accepted values are "left", "top-left", "top", "top-right",
10782 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10784 * @param content The content to place at @p swallow
10786 * Once the content object is set for a given direction, a previously
10787 * set one (on the same direction) will be deleted. If you want to
10788 * keep that old content object, use the elm_hover_content_unset()
10791 * All directions may have contents at the same time, except for
10792 * "smart". This is a special placement hint and its use case
10793 * independs of the calculations coming from
10794 * elm_hover_best_content_location_get(). Its use is for cases when
10795 * one desires only one hover content, but with a dinamic special
10796 * placement within the hover area. The content's geometry, whenever
10797 * it changes, will be used to decide on a best location not
10798 * extrapolating the hover's parent object view to show it in (still
10799 * being the hover's target determinant of its medium part -- move and
10800 * resize it to simulate finger sizes, for example). If one of the
10801 * directions other than "smart" are used, a previously content set
10802 * using it will be deleted, and vice-versa.
10804 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10806 * @brief Get the content of the hover object, in a given direction.
10808 * Return the content object which was set for this widget in the
10809 * @p swallow direction.
10811 * @param obj The hover object
10812 * @param swallow The direction that the object was display at.
10813 * @return The content that was being used
10815 * @see elm_hover_content_set()
10817 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10819 * @brief Unset the content of the hover object, in a given direction.
10821 * Unparent and return the content object set at @p swallow direction.
10823 * @param obj The hover object
10824 * @param swallow The direction that the object was display at.
10825 * @return The content that was being used.
10827 * @see elm_hover_content_set()
10829 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10831 * @brief Returns the best swallow location for content in the hover.
10833 * @param obj The hover object
10834 * @param pref_axis The preferred orientation axis for the hover object to use
10835 * @return The edje location to place content into the hover or @c
10838 * Best is defined here as the location at which there is the most available
10841 * @p pref_axis may be one of
10842 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10843 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10844 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10845 * - @c ELM_HOVER_AXIS_BOTH -- both
10847 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10848 * nescessarily be along the horizontal axis("left" or "right"). If
10849 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10850 * be along the vertical axis("top" or "bottom"). Chossing
10851 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10852 * returned position may be in either axis.
10854 * @see elm_hover_content_set()
10856 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10863 * @defgroup Entry Entry
10865 * @image html img/widget/entry/preview-00.png
10866 * @image latex img/widget/entry/preview-00.eps width=\textwidth
10867 * @image html img/widget/entry/preview-01.png
10868 * @image latex img/widget/entry/preview-01.eps width=\textwidth
10869 * @image html img/widget/entry/preview-02.png
10870 * @image latex img/widget/entry/preview-02.eps width=\textwidth
10871 * @image html img/widget/entry/preview-03.png
10872 * @image latex img/widget/entry/preview-03.eps width=\textwidth
10874 * An entry is a convenience widget which shows a box that the user can
10875 * enter text into. Entries by default don't scroll, so they grow to
10876 * accomodate the entire text, resizing the parent window as needed. This
10877 * can be changed with the elm_entry_scrollable_set() function.
10879 * They can also be single line or multi line (the default) and when set
10880 * to multi line mode they support text wrapping in any of the modes
10881 * indicated by #Elm_Wrap_Type.
10883 * Other features include password mode, filtering of inserted text with
10884 * elm_entry_text_filter_append() and related functions, inline "items" and
10885 * formatted markup text.
10887 * @section entry-markup Formatted text
10889 * The markup tags supported by the Entry are defined by the theme, but
10890 * even when writing new themes or extensions it's a good idea to stick to
10891 * a sane default, to maintain coherency and avoid application breakages.
10892 * Currently defined by the default theme are the following tags:
10893 * @li \<br\>: Inserts a line break.
10894 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10896 * @li \<tab\>: Inserts a tab.
10897 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10899 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10900 * @li \<link\>...\</link\>: Underlines the enclosed text.
10901 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10903 * @section entry-special Special markups
10905 * Besides those used to format text, entries support two special markup
10906 * tags used to insert clickable portions of text or items inlined within
10909 * @subsection entry-anchors Anchors
10911 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10912 * \</a\> tags and an event will be generated when this text is clicked,
10916 * This text is outside <a href=anc-01>but this one is an anchor</a>
10919 * The @c href attribute in the opening tag gives the name that will be
10920 * used to identify the anchor and it can be any valid utf8 string.
10922 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10923 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10924 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10925 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10928 * @subsection entry-items Items
10930 * Inlined in the text, any other @c Evas_Object can be inserted by using
10931 * \<item\> tags this way:
10934 * <item size=16x16 vsize=full href=emoticon/haha></item>
10937 * Just like with anchors, the @c href identifies each item, but these need,
10938 * in addition, to indicate their size, which is done using any one of
10939 * @c size, @c absize or @c relsize attributes. These attributes take their
10940 * value in the WxH format, where W is the width and H the height of the
10943 * @li absize: Absolute pixel size for the item. Whatever value is set will
10944 * be the item's size regardless of any scale value the object may have
10945 * been set to. The final line height will be adjusted to fit larger items.
10946 * @li size: Similar to @c absize, but it's adjusted to the scale value set
10948 * @li relsize: Size is adjusted for the item to fit within the current
10951 * Besides their size, items are specificed a @c vsize value that affects
10952 * how their final size and position are calculated. The possible values
10954 * @li ascent: Item will be placed within the line's baseline and its
10955 * ascent. That is, the height between the line where all characters are
10956 * positioned and the highest point in the line. For @c size and @c absize
10957 * items, the descent value will be added to the total line height to make
10958 * them fit. @c relsize items will be adjusted to fit within this space.
10959 * @li full: Items will be placed between the descent and ascent, or the
10960 * lowest point in the line and its highest.
10962 * The next image shows different configurations of items and how they
10963 * are the previously mentioned options affect their sizes. In all cases,
10964 * the green line indicates the ascent, blue for the baseline and red for
10967 * @image html entry_item.png
10968 * @image latex entry_item.eps width=\textwidth
10970 * And another one to show how size differs from absize. In the first one,
10971 * the scale value is set to 1.0, while the second one is using one of 2.0.
10973 * @image html entry_item_scale.png
10974 * @image latex entry_item_scale.eps width=\textwidth
10976 * After the size for an item is calculated, the entry will request an
10977 * object to place in its space. For this, the functions set with
10978 * elm_entry_item_provider_append() and related functions will be called
10979 * in order until one of them returns a @c non-NULL value. If no providers
10980 * are available, or all of them return @c NULL, then the entry falls back
10981 * to one of the internal defaults, provided the name matches with one of
10984 * All of the following are currently supported:
10987 * - emoticon/angry-shout
10988 * - emoticon/crazy-laugh
10989 * - emoticon/evil-laugh
10991 * - emoticon/goggle-smile
10992 * - emoticon/grumpy
10993 * - emoticon/grumpy-smile
10994 * - emoticon/guilty
10995 * - emoticon/guilty-smile
10997 * - emoticon/half-smile
10998 * - emoticon/happy-panting
11000 * - emoticon/indifferent
11002 * - emoticon/knowing-grin
11004 * - emoticon/little-bit-sorry
11005 * - emoticon/love-lots
11007 * - emoticon/minimal-smile
11008 * - emoticon/not-happy
11009 * - emoticon/not-impressed
11011 * - emoticon/opensmile
11014 * - emoticon/squint-laugh
11015 * - emoticon/surprised
11016 * - emoticon/suspicious
11017 * - emoticon/tongue-dangling
11018 * - emoticon/tongue-poke
11020 * - emoticon/unhappy
11021 * - emoticon/very-sorry
11024 * - emoticon/worried
11027 * Alternatively, an item may reference an image by its path, using
11028 * the URI form @c file:///path/to/an/image.png and the entry will then
11029 * use that image for the item.
11031 * @section entry-files Loading and saving files
11033 * Entries have convinience functions to load text from a file and save
11034 * changes back to it after a short delay. The automatic saving is enabled
11035 * by default, but can be disabled with elm_entry_autosave_set() and files
11036 * can be loaded directly as plain text or have any markup in them
11037 * recognized. See elm_entry_file_set() for more details.
11039 * @section entry-signals Emitted signals
11041 * This widget emits the following signals:
11043 * @li "changed": The text within the entry was changed.
11044 * @li "changed,user": The text within the entry was changed because of user interaction.
11045 * @li "activated": The enter key was pressed on a single line entry.
11046 * @li "press": A mouse button has been pressed on the entry.
11047 * @li "longpressed": A mouse button has been pressed and held for a couple
11049 * @li "clicked": The entry has been clicked (mouse press and release).
11050 * @li "clicked,double": The entry has been double clicked.
11051 * @li "clicked,triple": The entry has been triple clicked.
11052 * @li "focused": The entry has received focus.
11053 * @li "unfocused": The entry has lost focus.
11054 * @li "selection,paste": A paste of the clipboard contents was requested.
11055 * @li "selection,copy": A copy of the selected text into the clipboard was
11057 * @li "selection,cut": A cut of the selected text into the clipboard was
11059 * @li "selection,start": A selection has begun and no previous selection
11061 * @li "selection,changed": The current selection has changed.
11062 * @li "selection,cleared": The current selection has been cleared.
11063 * @li "cursor,changed": The cursor has changed position.
11064 * @li "anchor,clicked": An anchor has been clicked. The event_info
11065 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11066 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
11067 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11068 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
11069 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11070 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
11071 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11072 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
11073 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11074 * @li "preedit,changed": The preedit string has changed.
11075 * @li "language,changed": Program language changed.
11077 * @section entry-examples
11079 * An overview of the Entry API can be seen in @ref entry_example_01
11084 * @typedef Elm_Entry_Anchor_Info
11086 * The info sent in the callback for the "anchor,clicked" signals emitted
11089 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
11091 * @struct _Elm_Entry_Anchor_Info
11093 * The info sent in the callback for the "anchor,clicked" signals emitted
11096 struct _Elm_Entry_Anchor_Info
11098 const char *name; /**< The name of the anchor, as stated in its href */
11099 int button; /**< The mouse button used to click on it */
11100 Evas_Coord x, /**< Anchor geometry, relative to canvas */
11101 y, /**< Anchor geometry, relative to canvas */
11102 w, /**< Anchor geometry, relative to canvas */
11103 h; /**< Anchor geometry, relative to canvas */
11106 * @typedef Elm_Entry_Filter_Cb
11107 * This callback type is used by entry filters to modify text.
11108 * @param data The data specified as the last param when adding the filter
11109 * @param entry The entry object
11110 * @param text A pointer to the location of the text being filtered. This data can be modified,
11111 * but any additional allocations must be managed by the user.
11112 * @see elm_entry_text_filter_append
11113 * @see elm_entry_text_filter_prepend
11115 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
11118 * This adds an entry to @p parent object.
11120 * By default, entries are:
11124 * @li autosave is enabled
11126 * @param parent The parent object
11127 * @return The new object or NULL if it cannot be created
11129 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11131 * Sets the entry to single line mode.
11133 * In single line mode, entries don't ever wrap when the text reaches the
11134 * edge, and instead they keep growing horizontally. Pressing the @c Enter
11135 * key will generate an @c "activate" event instead of adding a new line.
11137 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
11138 * and pressing enter will break the text into a different line
11139 * without generating any events.
11141 * @param obj The entry object
11142 * @param single_line If true, the text in the entry
11143 * will be on a single line.
11145 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
11147 * Gets whether the entry is set to be single line.
11149 * @param obj The entry object
11150 * @return single_line If true, the text in the entry is set to display
11151 * on a single line.
11153 * @see elm_entry_single_line_set()
11155 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11157 * Sets the entry to password mode.
11159 * In password mode, entries are implicitly single line and the display of
11160 * any text in them is replaced with asterisks (*).
11162 * @param obj The entry object
11163 * @param password If true, password mode is enabled.
11165 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
11167 * Gets whether the entry is set to password mode.
11169 * @param obj The entry object
11170 * @return If true, the entry is set to display all characters
11171 * as asterisks (*).
11173 * @see elm_entry_password_set()
11175 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11177 * This sets the text displayed within the entry to @p entry.
11179 * @param obj The entry object
11180 * @param entry The text to be displayed
11182 * @deprecated Use elm_object_text_set() instead.
11183 * @note Using this function bypasses text filters
11185 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11187 * This returns the text currently shown in object @p entry.
11188 * See also elm_entry_entry_set().
11190 * @param obj The entry object
11191 * @return The currently displayed text or NULL on failure
11193 * @deprecated Use elm_object_text_get() instead.
11195 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11197 * Appends @p entry to the text of the entry.
11199 * Adds the text in @p entry to the end of any text already present in the
11202 * The appended text is subject to any filters set for the widget.
11204 * @param obj The entry object
11205 * @param entry The text to be displayed
11207 * @see elm_entry_text_filter_append()
11209 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11211 * Gets whether the entry is empty.
11213 * Empty means no text at all. If there are any markup tags, like an item
11214 * tag for which no provider finds anything, and no text is displayed, this
11215 * function still returns EINA_FALSE.
11217 * @param obj The entry object
11218 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
11220 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11222 * Gets any selected text within the entry.
11224 * If there's any selected text in the entry, this function returns it as
11225 * a string in markup format. NULL is returned if no selection exists or
11226 * if an error occurred.
11228 * The returned value points to an internal string and should not be freed
11229 * or modified in any way. If the @p entry object is deleted or its
11230 * contents are changed, the returned pointer should be considered invalid.
11232 * @param obj The entry object
11233 * @return The selected text within the entry or NULL on failure
11235 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11237 * Inserts the given text into the entry at the current cursor position.
11239 * This inserts text at the cursor position as if it was typed
11240 * by the user (note that this also allows markup which a user
11241 * can't just "type" as it would be converted to escaped text, so this
11242 * call can be used to insert things like emoticon items or bold push/pop
11243 * tags, other font and color change tags etc.)
11245 * If any selection exists, it will be replaced by the inserted text.
11247 * The inserted text is subject to any filters set for the widget.
11249 * @param obj The entry object
11250 * @param entry The text to insert
11252 * @see elm_entry_text_filter_append()
11254 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11256 * Set the line wrap type to use on multi-line entries.
11258 * Sets the wrap type used by the entry to any of the specified in
11259 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
11260 * line (without inserting a line break or paragraph separator) when it
11261 * reaches the far edge of the widget.
11263 * Note that this only makes sense for multi-line entries. A widget set
11264 * to be single line will never wrap.
11266 * @param obj The entry object
11267 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
11269 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
11271 * Gets the wrap mode the entry was set to use.
11273 * @param obj The entry object
11274 * @return Wrap type
11276 * @see also elm_entry_line_wrap_set()
11278 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11280 * Sets if the entry is to be editable or not.
11282 * By default, entries are editable and when focused, any text input by the
11283 * user will be inserted at the current cursor position. But calling this
11284 * function with @p editable as EINA_FALSE will prevent the user from
11285 * inputting text into the entry.
11287 * The only way to change the text of a non-editable entry is to use
11288 * elm_object_text_set(), elm_entry_entry_insert() and other related
11291 * @param obj The entry object
11292 * @param editable If EINA_TRUE, user input will be inserted in the entry,
11293 * if not, the entry is read-only and no user input is allowed.
11295 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
11297 * Gets whether the entry is editable or not.
11299 * @param obj The entry object
11300 * @return If true, the entry is editable by the user.
11301 * If false, it is not editable by the user
11303 * @see elm_entry_editable_set()
11305 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11307 * This drops any existing text selection within the entry.
11309 * @param obj The entry object
11311 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
11313 * This selects all text within the entry.
11315 * @param obj The entry object
11317 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
11319 * This moves the cursor one place to the right within the entry.
11321 * @param obj The entry object
11322 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11324 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
11326 * This moves the cursor one place to the left within the entry.
11328 * @param obj The entry object
11329 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11331 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
11333 * This moves the cursor one line up within the entry.
11335 * @param obj The entry object
11336 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11338 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
11340 * This moves the cursor one line down within the entry.
11342 * @param obj The entry object
11343 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11345 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
11347 * This moves the cursor to the beginning of the entry.
11349 * @param obj The entry object
11351 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11353 * This moves the cursor to the end of the entry.
11355 * @param obj The entry object
11357 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11359 * This moves the cursor to the beginning of the current line.
11361 * @param obj The entry object
11363 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11365 * This moves the cursor to the end of the current line.
11367 * @param obj The entry object
11369 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11371 * This begins a selection within the entry as though
11372 * the user were holding down the mouse button to make a selection.
11374 * @param obj The entry object
11376 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
11378 * This ends a selection within the entry as though
11379 * the user had just released the mouse button while making a selection.
11381 * @param obj The entry object
11383 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11385 * Gets whether a format node exists at the current cursor position.
11387 * A format node is anything that defines how the text is rendered. It can
11388 * be a visible format node, such as a line break or a paragraph separator,
11389 * or an invisible one, such as bold begin or end tag.
11390 * This function returns whether any format node exists at the current
11393 * @param obj The entry object
11394 * @return EINA_TRUE if the current cursor position contains a format node,
11395 * EINA_FALSE otherwise.
11397 * @see elm_entry_cursor_is_visible_format_get()
11399 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11401 * Gets if the current cursor position holds a visible format node.
11403 * @param obj The entry object
11404 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
11405 * if it's an invisible one or no format exists.
11407 * @see elm_entry_cursor_is_format_get()
11409 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11411 * Gets the character pointed by the cursor at its current position.
11413 * This function returns a string with the utf8 character stored at the
11414 * current cursor position.
11415 * Only the text is returned, any format that may exist will not be part
11416 * of the return value.
11418 * @param obj The entry object
11419 * @return The text pointed by the cursors.
11421 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11423 * This function returns the geometry of the cursor.
11425 * It's useful if you want to draw something on the cursor (or where it is),
11426 * or for example in the case of scrolled entry where you want to show the
11429 * @param obj The entry object
11430 * @param x returned geometry
11431 * @param y returned geometry
11432 * @param w returned geometry
11433 * @param h returned geometry
11434 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11436 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);
11438 * Sets the cursor position in the entry to the given value
11440 * The value in @p pos is the index of the character position within the
11441 * contents of the string as returned by elm_entry_cursor_pos_get().
11443 * @param obj The entry object
11444 * @param pos The position of the cursor
11446 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
11448 * Retrieves the current position of the cursor in the entry
11450 * @param obj The entry object
11451 * @return The cursor position
11453 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11455 * This executes a "cut" action on the selected text in the entry.
11457 * @param obj The entry object
11459 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
11461 * This executes a "copy" action on the selected text in the entry.
11463 * @param obj The entry object
11465 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
11467 * This executes a "paste" action in the entry.
11469 * @param obj The entry object
11471 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
11473 * This clears and frees the items in a entry's contextual (longpress)
11476 * @param obj The entry object
11478 * @see elm_entry_context_menu_item_add()
11480 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11482 * This adds an item to the entry's contextual menu.
11484 * A longpress on an entry will make the contextual menu show up, if this
11485 * hasn't been disabled with elm_entry_context_menu_disabled_set().
11486 * By default, this menu provides a few options like enabling selection mode,
11487 * which is useful on embedded devices that need to be explicit about it,
11488 * and when a selection exists it also shows the copy and cut actions.
11490 * With this function, developers can add other options to this menu to
11491 * perform any action they deem necessary.
11493 * @param obj The entry object
11494 * @param label The item's text label
11495 * @param icon_file The item's icon file
11496 * @param icon_type The item's icon type
11497 * @param func The callback to execute when the item is clicked
11498 * @param data The data to associate with the item for related functions
11500 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);
11502 * This disables the entry's contextual (longpress) menu.
11504 * @param obj The entry object
11505 * @param disabled If true, the menu is disabled
11507 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11509 * This returns whether the entry's contextual (longpress) menu is
11512 * @param obj The entry object
11513 * @return If true, the menu is disabled
11515 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11517 * This appends a custom item provider to the list for that entry
11519 * This appends the given callback. The list is walked from beginning to end
11520 * with each function called given the item href string in the text. If the
11521 * function returns an object handle other than NULL (it should create an
11522 * object to do this), then this object is used to replace that item. If
11523 * not the next provider is called until one provides an item object, or the
11524 * default provider in entry does.
11526 * @param obj The entry object
11527 * @param func The function called to provide the item object
11528 * @param data The data passed to @p func
11530 * @see @ref entry-items
11532 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);
11534 * This prepends a custom item provider to the list for that entry
11536 * This prepends the given callback. See elm_entry_item_provider_append() for
11539 * @param obj The entry object
11540 * @param func The function called to provide the item object
11541 * @param data The data passed to @p func
11543 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);
11545 * This removes a custom item provider to the list for that entry
11547 * This removes the given callback. See elm_entry_item_provider_append() for
11550 * @param obj The entry object
11551 * @param func The function called to provide the item object
11552 * @param data The data passed to @p func
11554 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);
11556 * Append a filter function for text inserted in the entry
11558 * Append the given callback to the list. This functions will be called
11559 * whenever any text is inserted into the entry, with the text to be inserted
11560 * as a parameter. The callback function is free to alter the text in any way
11561 * it wants, but it must remember to free the given pointer and update it.
11562 * If the new text is to be discarded, the function can free it and set its
11563 * text parameter to NULL. This will also prevent any following filters from
11566 * @param obj The entry object
11567 * @param func The function to use as text filter
11568 * @param data User data to pass to @p func
11570 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11572 * Prepend a filter function for text insdrted in the entry
11574 * Prepend the given callback to the list. See elm_entry_text_filter_append()
11575 * for more information
11577 * @param obj The entry object
11578 * @param func The function to use as text filter
11579 * @param data User data to pass to @p func
11581 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11583 * Remove a filter from the list
11585 * Removes the given callback from the filter list. See
11586 * elm_entry_text_filter_append() for more information.
11588 * @param obj The entry object
11589 * @param func The filter function to remove
11590 * @param data The user data passed when adding the function
11592 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11594 * This converts a markup (HTML-like) string into UTF-8.
11596 * The returned string is a malloc'ed buffer and it should be freed when
11597 * not needed anymore.
11599 * @param s The string (in markup) to be converted
11600 * @return The converted string (in UTF-8). It should be freed.
11602 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11604 * This converts a UTF-8 string into markup (HTML-like).
11606 * The returned string is a malloc'ed buffer and it should be freed when
11607 * not needed anymore.
11609 * @param s The string (in UTF-8) to be converted
11610 * @return The converted string (in markup). It should be freed.
11612 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11614 * This sets the file (and implicitly loads it) for the text to display and
11615 * then edit. All changes are written back to the file after a short delay if
11616 * the entry object is set to autosave (which is the default).
11618 * If the entry had any other file set previously, any changes made to it
11619 * will be saved if the autosave feature is enabled, otherwise, the file
11620 * will be silently discarded and any non-saved changes will be lost.
11622 * @param obj The entry object
11623 * @param file The path to the file to load and save
11624 * @param format The file format
11626 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11628 * Gets the file being edited by the entry.
11630 * This function can be used to retrieve any file set on the entry for
11631 * edition, along with the format used to load and save it.
11633 * @param obj The entry object
11634 * @param file The path to the file to load and save
11635 * @param format The file format
11637 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11639 * This function writes any changes made to the file set with
11640 * elm_entry_file_set()
11642 * @param obj The entry object
11644 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11646 * This sets the entry object to 'autosave' the loaded text file or not.
11648 * @param obj The entry object
11649 * @param autosave Autosave the loaded file or not
11651 * @see elm_entry_file_set()
11653 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11655 * This gets the entry object's 'autosave' status.
11657 * @param obj The entry object
11658 * @return Autosave the loaded file or not
11660 * @see elm_entry_file_set()
11662 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11664 * Control pasting of text and images for the widget.
11666 * Normally the entry allows both text and images to be pasted. By setting
11667 * textonly to be true, this prevents images from being pasted.
11669 * Note this only changes the behaviour of text.
11671 * @param obj The entry object
11672 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11673 * text+image+other.
11675 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11677 * Getting elm_entry text paste/drop mode.
11679 * In textonly mode, only text may be pasted or dropped into the widget.
11681 * @param obj The entry object
11682 * @return If the widget only accepts text from pastes.
11684 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11686 * Enable or disable scrolling in entry
11688 * Normally the entry is not scrollable unless you enable it with this call.
11690 * @param obj The entry object
11691 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11693 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11695 * Get the scrollable state of the entry
11697 * Normally the entry is not scrollable. This gets the scrollable state
11698 * of the entry. See elm_entry_scrollable_set() for more information.
11700 * @param obj The entry object
11701 * @return The scrollable state
11703 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
11705 * This sets a widget to be displayed to the left of a scrolled entry.
11707 * @param obj The scrolled entry object
11708 * @param icon The widget to display on the left side of the scrolled
11711 * @note A previously set widget will be destroyed.
11712 * @note If the object being set does not have minimum size hints set,
11713 * it won't get properly displayed.
11715 * @see elm_entry_end_set()
11717 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11719 * Gets the leftmost widget of the scrolled entry. This object is
11720 * owned by the scrolled entry and should not be modified.
11722 * @param obj The scrolled entry object
11723 * @return the left widget inside the scroller
11725 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11727 * Unset the leftmost widget of the scrolled entry, unparenting and
11730 * @param obj The scrolled entry object
11731 * @return the previously set icon sub-object of this entry, on
11734 * @see elm_entry_icon_set()
11736 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11738 * Sets the visibility of the left-side widget of the scrolled entry,
11739 * set by elm_entry_icon_set().
11741 * @param obj The scrolled entry object
11742 * @param setting EINA_TRUE if the object should be displayed,
11743 * EINA_FALSE if not.
11745 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11747 * This sets a widget to be displayed to the end of a scrolled entry.
11749 * @param obj The scrolled entry object
11750 * @param end The widget to display on the right side of the scrolled
11753 * @note A previously set widget will be destroyed.
11754 * @note If the object being set does not have minimum size hints set,
11755 * it won't get properly displayed.
11757 * @see elm_entry_icon_set
11759 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11761 * Gets the endmost widget of the scrolled entry. This object is owned
11762 * by the scrolled entry and should not be modified.
11764 * @param obj The scrolled entry object
11765 * @return the right widget inside the scroller
11767 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11769 * Unset the endmost widget of the scrolled entry, unparenting and
11772 * @param obj The scrolled entry object
11773 * @return the previously set icon sub-object of this entry, on
11776 * @see elm_entry_icon_set()
11778 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11780 * Sets the visibility of the end widget of the scrolled entry, set by
11781 * elm_entry_end_set().
11783 * @param obj The scrolled entry object
11784 * @param setting EINA_TRUE if the object should be displayed,
11785 * EINA_FALSE if not.
11787 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11789 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11792 * Setting an entry to single-line mode with elm_entry_single_line_set()
11793 * will automatically disable the display of scrollbars when the entry
11794 * moves inside its scroller.
11796 * @param obj The scrolled entry object
11797 * @param h The horizontal scrollbar policy to apply
11798 * @param v The vertical scrollbar policy to apply
11800 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11802 * This enables/disables bouncing within the entry.
11804 * This function sets whether the entry will bounce when scrolling reaches
11805 * the end of the contained entry.
11807 * @param obj The scrolled entry object
11808 * @param h The horizontal bounce state
11809 * @param v The vertical bounce state
11811 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11813 * Get the bounce mode
11815 * @param obj The Entry object
11816 * @param h_bounce Allow bounce horizontally
11817 * @param v_bounce Allow bounce vertically
11819 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11821 /* pre-made filters for entries */
11823 * @typedef Elm_Entry_Filter_Limit_Size
11825 * Data for the elm_entry_filter_limit_size() entry filter.
11827 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11829 * @struct _Elm_Entry_Filter_Limit_Size
11831 * Data for the elm_entry_filter_limit_size() entry filter.
11833 struct _Elm_Entry_Filter_Limit_Size
11835 int max_char_count; /**< The maximum number of characters allowed. */
11836 int max_byte_count; /**< The maximum number of bytes allowed*/
11839 * Filter inserted text based on user defined character and byte limits
11841 * Add this filter to an entry to limit the characters that it will accept
11842 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11843 * The funtion works on the UTF-8 representation of the string, converting
11844 * it from the set markup, thus not accounting for any format in it.
11846 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11847 * it as data when setting the filter. In it, it's possible to set limits
11848 * by character count or bytes (any of them is disabled if 0), and both can
11849 * be set at the same time. In that case, it first checks for characters,
11852 * The function will cut the inserted text in order to allow only the first
11853 * number of characters that are still allowed. The cut is made in
11854 * characters, even when limiting by bytes, in order to always contain
11855 * valid ones and avoid half unicode characters making it in.
11857 * This filter, like any others, does not apply when setting the entry text
11858 * directly with elm_object_text_set() (or the deprecated
11859 * elm_entry_entry_set()).
11861 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11863 * @typedef Elm_Entry_Filter_Accept_Set
11865 * Data for the elm_entry_filter_accept_set() entry filter.
11867 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11869 * @struct _Elm_Entry_Filter_Accept_Set
11871 * Data for the elm_entry_filter_accept_set() entry filter.
11873 struct _Elm_Entry_Filter_Accept_Set
11875 const char *accepted; /**< Set of characters accepted in the entry. */
11876 const char *rejected; /**< Set of characters rejected from the entry. */
11879 * Filter inserted text based on accepted or rejected sets of characters
11881 * Add this filter to an entry to restrict the set of accepted characters
11882 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11883 * This structure contains both accepted and rejected sets, but they are
11884 * mutually exclusive.
11886 * The @c accepted set takes preference, so if it is set, the filter will
11887 * only work based on the accepted characters, ignoring anything in the
11888 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11890 * In both cases, the function filters by matching utf8 characters to the
11891 * raw markup text, so it can be used to remove formatting tags.
11893 * This filter, like any others, does not apply when setting the entry text
11894 * directly with elm_object_text_set() (or the deprecated
11895 * elm_entry_entry_set()).
11897 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11899 * Set the input panel layout of the entry
11901 * @param obj The entry object
11902 * @param layout layout type
11904 EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
11906 * Get the input panel layout of the entry
11908 * @param obj The entry object
11909 * @return layout type
11911 * @see elm_entry_input_panel_layout_set
11913 EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11915 * Set the autocapitalization type on the immodule.
11917 * @param obj The entry object
11918 * @param autocapital_type The type of autocapitalization
11920 EAPI void elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type) EINA_ARG_NONNULL(1);
11922 * Retrieve the autocapitalization type on the immodule.
11924 * @param obj The entry object
11925 * @return autocapitalization type
11927 EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11929 * Sets the attribute to show the input panel automatically.
11931 * @param obj The entry object
11932 * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
11934 EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
11936 * Retrieve the attribute to show the input panel automatically.
11938 * @param obj The entry object
11939 * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
11941 EAPI Eina_Bool elm_entry_input_panel_enabled_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11947 /* composite widgets - these basically put together basic widgets above
11948 * in convenient packages that do more than basic stuff */
11952 * @defgroup Anchorview Anchorview
11954 * @image html img/widget/anchorview/preview-00.png
11955 * @image latex img/widget/anchorview/preview-00.eps
11957 * Anchorview is for displaying text that contains markup with anchors
11958 * like <c>\<a href=1234\>something\</\></c> in it.
11960 * Besides being styled differently, the anchorview widget provides the
11961 * necessary functionality so that clicking on these anchors brings up a
11962 * popup with user defined content such as "call", "add to contacts" or
11963 * "open web page". This popup is provided using the @ref Hover widget.
11965 * This widget is very similar to @ref Anchorblock, so refer to that
11966 * widget for an example. The only difference Anchorview has is that the
11967 * widget is already provided with scrolling functionality, so if the
11968 * text set to it is too large to fit in the given space, it will scroll,
11969 * whereas the @ref Anchorblock widget will keep growing to ensure all the
11970 * text can be displayed.
11972 * This widget emits the following signals:
11973 * @li "anchor,clicked": will be called when an anchor is clicked. The
11974 * @p event_info parameter on the callback will be a pointer of type
11975 * ::Elm_Entry_Anchorview_Info.
11977 * See @ref Anchorblock for an example on how to use both of them.
11986 * @typedef Elm_Entry_Anchorview_Info
11988 * The info sent in the callback for "anchor,clicked" signals emitted by
11989 * the Anchorview widget.
11991 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
11993 * @struct _Elm_Entry_Anchorview_Info
11995 * The info sent in the callback for "anchor,clicked" signals emitted by
11996 * the Anchorview widget.
11998 struct _Elm_Entry_Anchorview_Info
12000 const char *name; /**< Name of the anchor, as indicated in its href
12002 int button; /**< The mouse button used to click on it */
12003 Evas_Object *hover; /**< The hover object to use for the popup */
12005 Evas_Coord x, y, w, h;
12006 } anchor, /**< Geometry selection of text used as anchor */
12007 hover_parent; /**< Geometry of the object used as parent by the
12009 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
12010 for content on the left side of
12011 the hover. Before calling the
12012 callback, the widget will make the
12013 necessary calculations to check
12014 which sides are fit to be set with
12015 content, based on the position the
12016 hover is activated and its distance
12017 to the edges of its parent object
12019 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
12020 the right side of the hover.
12021 See @ref hover_left */
12022 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
12023 of the hover. See @ref hover_left */
12024 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
12025 below the hover. See @ref
12029 * Add a new Anchorview object
12031 * @param parent The parent object
12032 * @return The new object or NULL if it cannot be created
12034 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12036 * Set the text to show in the anchorview
12038 * Sets the text of the anchorview to @p text. This text can include markup
12039 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
12040 * text that will be specially styled and react to click events, ended with
12041 * either of \</a\> or \</\>. When clicked, the anchor will emit an
12042 * "anchor,clicked" signal that you can attach a callback to with
12043 * evas_object_smart_callback_add(). The name of the anchor given in the
12044 * event info struct will be the one set in the href attribute, in this
12045 * case, anchorname.
12047 * Other markup can be used to style the text in different ways, but it's
12048 * up to the style defined in the theme which tags do what.
12049 * @deprecated use elm_object_text_set() instead.
12051 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12053 * Get the markup text set for the anchorview
12055 * Retrieves the text set on the anchorview, with markup tags included.
12057 * @param obj The anchorview object
12058 * @return The markup text set or @c NULL if nothing was set or an error
12060 * @deprecated use elm_object_text_set() instead.
12062 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12064 * Set the parent of the hover popup
12066 * Sets the parent object to use by the hover created by the anchorview
12067 * when an anchor is clicked. See @ref Hover for more details on this.
12068 * If no parent is set, the same anchorview object will be used.
12070 * @param obj The anchorview object
12071 * @param parent The object to use as parent for the hover
12073 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12075 * Get the parent of the hover popup
12077 * Get the object used as parent for the hover created by the anchorview
12078 * widget. See @ref Hover for more details on this.
12080 * @param obj The anchorview object
12081 * @return The object used as parent for the hover, NULL if none is set.
12083 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12085 * Set the style that the hover should use
12087 * When creating the popup hover, anchorview will request that it's
12088 * themed according to @p style.
12090 * @param obj The anchorview object
12091 * @param style The style to use for the underlying hover
12093 * @see elm_object_style_set()
12095 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12097 * Get the style that the hover should use
12099 * Get the style the hover created by anchorview will use.
12101 * @param obj The anchorview object
12102 * @return The style to use by the hover. NULL means the default is used.
12104 * @see elm_object_style_set()
12106 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12108 * Ends the hover popup in the anchorview
12110 * When an anchor is clicked, the anchorview widget will create a hover
12111 * object to use as a popup with user provided content. This function
12112 * terminates this popup, returning the anchorview to its normal state.
12114 * @param obj The anchorview object
12116 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12118 * Set bouncing behaviour when the scrolled content reaches an edge
12120 * Tell the internal scroller object whether it should bounce or not
12121 * when it reaches the respective edges for each axis.
12123 * @param obj The anchorview object
12124 * @param h_bounce Whether to bounce or not in the horizontal axis
12125 * @param v_bounce Whether to bounce or not in the vertical axis
12127 * @see elm_scroller_bounce_set()
12129 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
12131 * Get the set bouncing behaviour of the internal scroller
12133 * Get whether the internal scroller should bounce when the edge of each
12134 * axis is reached scrolling.
12136 * @param obj The anchorview object
12137 * @param h_bounce Pointer where to store the bounce state of the horizontal
12139 * @param v_bounce Pointer where to store the bounce state of the vertical
12142 * @see elm_scroller_bounce_get()
12144 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
12146 * Appends a custom item provider to the given anchorview
12148 * Appends the given function to the list of items providers. This list is
12149 * called, one function at a time, with the given @p data pointer, the
12150 * anchorview object and, in the @p item parameter, the item name as
12151 * referenced in its href string. Following functions in the list will be
12152 * called in order until one of them returns something different to NULL,
12153 * which should be an Evas_Object which will be used in place of the item
12156 * Items in the markup text take the form \<item relsize=16x16 vsize=full
12157 * href=item/name\>\</item\>
12159 * @param obj The anchorview object
12160 * @param func The function to add to the list of providers
12161 * @param data User data that will be passed to the callback function
12163 * @see elm_entry_item_provider_append()
12165 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);
12167 * Prepend a custom item provider to the given anchorview
12169 * Like elm_anchorview_item_provider_append(), but it adds the function
12170 * @p func to the beginning of the list, instead of the end.
12172 * @param obj The anchorview object
12173 * @param func The function to add to the list of providers
12174 * @param data User data that will be passed to the callback function
12176 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);
12178 * Remove a custom item provider from the list of the given anchorview
12180 * Removes the function and data pairing that matches @p func and @p data.
12181 * That is, unless the same function and same user data are given, the
12182 * function will not be removed from the list. This allows us to add the
12183 * same callback several times, with different @p data pointers and be
12184 * able to remove them later without conflicts.
12186 * @param obj The anchorview object
12187 * @param func The function to remove from the list
12188 * @param data The data matching the function to remove from the list
12190 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);
12197 * @defgroup Anchorblock Anchorblock
12199 * @image html img/widget/anchorblock/preview-00.png
12200 * @image latex img/widget/anchorblock/preview-00.eps
12202 * Anchorblock is for displaying text that contains markup with anchors
12203 * like <c>\<a href=1234\>something\</\></c> in it.
12205 * Besides being styled differently, the anchorblock widget provides the
12206 * necessary functionality so that clicking on these anchors brings up a
12207 * popup with user defined content such as "call", "add to contacts" or
12208 * "open web page". This popup is provided using the @ref Hover widget.
12210 * This widget emits the following signals:
12211 * @li "anchor,clicked": will be called when an anchor is clicked. The
12212 * @p event_info parameter on the callback will be a pointer of type
12213 * ::Elm_Entry_Anchorblock_Info.
12219 * Since examples are usually better than plain words, we might as well
12220 * try @ref tutorial_anchorblock_example "one".
12223 * @addtogroup Anchorblock
12227 * @typedef Elm_Entry_Anchorblock_Info
12229 * The info sent in the callback for "anchor,clicked" signals emitted by
12230 * the Anchorblock widget.
12232 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
12234 * @struct _Elm_Entry_Anchorblock_Info
12236 * The info sent in the callback for "anchor,clicked" signals emitted by
12237 * the Anchorblock widget.
12239 struct _Elm_Entry_Anchorblock_Info
12241 const char *name; /**< Name of the anchor, as indicated in its href
12243 int button; /**< The mouse button used to click on it */
12244 Evas_Object *hover; /**< The hover object to use for the popup */
12246 Evas_Coord x, y, w, h;
12247 } anchor, /**< Geometry selection of text used as anchor */
12248 hover_parent; /**< Geometry of the object used as parent by the
12250 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
12251 for content on the left side of
12252 the hover. Before calling the
12253 callback, the widget will make the
12254 necessary calculations to check
12255 which sides are fit to be set with
12256 content, based on the position the
12257 hover is activated and its distance
12258 to the edges of its parent object
12260 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
12261 the right side of the hover.
12262 See @ref hover_left */
12263 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
12264 of the hover. See @ref hover_left */
12265 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
12266 below the hover. See @ref
12270 * Add a new Anchorblock object
12272 * @param parent The parent object
12273 * @return The new object or NULL if it cannot be created
12275 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12277 * Set the text to show in the anchorblock
12279 * Sets the text of the anchorblock to @p text. This text can include markup
12280 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
12281 * of text that will be specially styled and react to click events, ended
12282 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
12283 * "anchor,clicked" signal that you can attach a callback to with
12284 * evas_object_smart_callback_add(). The name of the anchor given in the
12285 * event info struct will be the one set in the href attribute, in this
12286 * case, anchorname.
12288 * Other markup can be used to style the text in different ways, but it's
12289 * up to the style defined in the theme which tags do what.
12290 * @deprecated use elm_object_text_set() instead.
12292 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12294 * Get the markup text set for the anchorblock
12296 * Retrieves the text set on the anchorblock, with markup tags included.
12298 * @param obj The anchorblock object
12299 * @return The markup text set or @c NULL if nothing was set or an error
12301 * @deprecated use elm_object_text_set() instead.
12303 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12305 * Set the parent of the hover popup
12307 * Sets the parent object to use by the hover created by the anchorblock
12308 * when an anchor is clicked. See @ref Hover for more details on this.
12310 * @param obj The anchorblock object
12311 * @param parent The object to use as parent for the hover
12313 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12315 * Get the parent of the hover popup
12317 * Get the object used as parent for the hover created by the anchorblock
12318 * widget. See @ref Hover for more details on this.
12319 * If no parent is set, the same anchorblock object will be used.
12321 * @param obj The anchorblock object
12322 * @return The object used as parent for the hover, NULL if none is set.
12324 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12326 * Set the style that the hover should use
12328 * When creating the popup hover, anchorblock will request that it's
12329 * themed according to @p style.
12331 * @param obj The anchorblock object
12332 * @param style The style to use for the underlying hover
12334 * @see elm_object_style_set()
12336 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12338 * Get the style that the hover should use
12340 * Get the style, the hover created by anchorblock will use.
12342 * @param obj The anchorblock object
12343 * @return The style to use by the hover. NULL means the default is used.
12345 * @see elm_object_style_set()
12347 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12349 * Ends the hover popup in the anchorblock
12351 * When an anchor is clicked, the anchorblock widget will create a hover
12352 * object to use as a popup with user provided content. This function
12353 * terminates this popup, returning the anchorblock to its normal state.
12355 * @param obj The anchorblock object
12357 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12359 * Appends a custom item provider to the given anchorblock
12361 * Appends the given function to the list of items providers. This list is
12362 * called, one function at a time, with the given @p data pointer, the
12363 * anchorblock object and, in the @p item parameter, the item name as
12364 * referenced in its href string. Following functions in the list will be
12365 * called in order until one of them returns something different to NULL,
12366 * which should be an Evas_Object which will be used in place of the item
12369 * Items in the markup text take the form \<item relsize=16x16 vsize=full
12370 * href=item/name\>\</item\>
12372 * @param obj The anchorblock object
12373 * @param func The function to add to the list of providers
12374 * @param data User data that will be passed to the callback function
12376 * @see elm_entry_item_provider_append()
12378 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);
12380 * Prepend a custom item provider to the given anchorblock
12382 * Like elm_anchorblock_item_provider_append(), but it adds the function
12383 * @p func to the beginning of the list, instead of the end.
12385 * @param obj The anchorblock object
12386 * @param func The function to add to the list of providers
12387 * @param data User data that will be passed to the callback function
12389 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);
12391 * Remove a custom item provider from the list of the given anchorblock
12393 * Removes the function and data pairing that matches @p func and @p data.
12394 * That is, unless the same function and same user data are given, the
12395 * function will not be removed from the list. This allows us to add the
12396 * same callback several times, with different @p data pointers and be
12397 * able to remove them later without conflicts.
12399 * @param obj The anchorblock object
12400 * @param func The function to remove from the list
12401 * @param data The data matching the function to remove from the list
12403 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);
12409 * @defgroup Bubble Bubble
12411 * @image html img/widget/bubble/preview-00.png
12412 * @image latex img/widget/bubble/preview-00.eps
12413 * @image html img/widget/bubble/preview-01.png
12414 * @image latex img/widget/bubble/preview-01.eps
12415 * @image html img/widget/bubble/preview-02.png
12416 * @image latex img/widget/bubble/preview-02.eps
12418 * @brief The Bubble is a widget to show text similar to how speech is
12419 * represented in comics.
12421 * The bubble widget contains 5 important visual elements:
12422 * @li The frame is a rectangle with rounded edjes and an "arrow".
12423 * @li The @p icon is an image to which the frame's arrow points to.
12424 * @li The @p label is a text which appears to the right of the icon if the
12425 * corner is "top_left" or "bottom_left" and is right aligned to the frame
12427 * @li The @p info is a text which appears to the right of the label. Info's
12428 * font is of a ligther color than label.
12429 * @li The @p content is an evas object that is shown inside the frame.
12431 * The position of the arrow, icon, label and info depends on which corner is
12432 * selected. The four available corners are:
12433 * @li "top_left" - Default
12435 * @li "bottom_left"
12436 * @li "bottom_right"
12438 * Signals that you can add callbacks for are:
12439 * @li "clicked" - This is called when a user has clicked the bubble.
12441 * For an example of using a buble see @ref bubble_01_example_page "this".
12446 * Add a new bubble to the parent
12448 * @param parent The parent object
12449 * @return The new object or NULL if it cannot be created
12451 * This function adds a text bubble to the given parent evas object.
12453 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12455 * Set the label of the bubble
12457 * @param obj The bubble object
12458 * @param label The string to set in the label
12460 * This function sets the title of the bubble. Where this appears depends on
12461 * the selected corner.
12462 * @deprecated use elm_object_text_set() instead.
12464 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12466 * Get the label of the bubble
12468 * @param obj The bubble object
12469 * @return The string of set in the label
12471 * This function gets the title of the bubble.
12472 * @deprecated use elm_object_text_get() instead.
12474 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12476 * Set the info of the bubble
12478 * @param obj The bubble object
12479 * @param info The given info about the bubble
12481 * This function sets the info of the bubble. Where this appears depends on
12482 * the selected corner.
12483 * @deprecated use elm_object_text_part_set() instead. (with "info" as the parameter).
12485 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
12487 * Get the info of the bubble
12489 * @param obj The bubble object
12491 * @return The "info" string of the bubble
12493 * This function gets the info text.
12494 * @deprecated use elm_object_text_part_get() instead. (with "info" as the parameter).
12496 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12498 * Set the content to be shown in the bubble
12500 * Once the content object is set, a previously set one will be deleted.
12501 * If you want to keep the old content object, use the
12502 * elm_bubble_content_unset() function.
12504 * @param obj The bubble object
12505 * @param content The given content of the bubble
12507 * This function sets the content shown on the middle of the bubble.
12509 EINA_DEPRECATED EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12511 * Get the content shown in the bubble
12513 * Return the content object which is set for this widget.
12515 * @param obj The bubble object
12516 * @return The content that is being used
12518 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12520 * Unset the content shown in the bubble
12522 * Unparent and return the content object which was set for this widget.
12524 * @param obj The bubble object
12525 * @return The content that was being used
12527 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12529 * Set the icon of the bubble
12531 * Once the icon object is set, a previously set one will be deleted.
12532 * If you want to keep the old content object, use the
12533 * elm_icon_content_unset() function.
12535 * @param obj The bubble object
12536 * @param icon The given icon for the bubble
12538 EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12540 * Get the icon of the bubble
12542 * @param obj The bubble object
12543 * @return The icon for the bubble
12545 * This function gets the icon shown on the top left of bubble.
12547 EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12549 * Unset the icon of the bubble
12551 * Unparent and return the icon object which was set for this widget.
12553 * @param obj The bubble object
12554 * @return The icon that was being used
12556 EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12558 * Set the corner of the bubble
12560 * @param obj The bubble object.
12561 * @param corner The given corner for the bubble.
12563 * This function sets the corner of the bubble. The corner will be used to
12564 * determine where the arrow in the frame points to and where label, icon and
12567 * Possible values for corner are:
12568 * @li "top_left" - Default
12570 * @li "bottom_left"
12571 * @li "bottom_right"
12573 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
12575 * Get the corner of the bubble
12577 * @param obj The bubble object.
12578 * @return The given corner for the bubble.
12580 * This function gets the selected corner of the bubble.
12582 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12588 * @defgroup Photo Photo
12590 * For displaying the photo of a person (contact). Simple, yet
12591 * with a very specific purpose.
12593 * Signals that you can add callbacks for are:
12595 * "clicked" - This is called when a user has clicked the photo
12596 * "drag,start" - Someone started dragging the image out of the object
12597 * "drag,end" - Dragged item was dropped (somewhere)
12603 * Add a new photo to the parent
12605 * @param parent The parent object
12606 * @return The new object or NULL if it cannot be created
12610 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12613 * Set the file that will be used as photo
12615 * @param obj The photo object
12616 * @param file The path to file that will be used as photo
12618 * @return (1 = success, 0 = error)
12622 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12625 * Set the file that will be used as thumbnail in the photo.
12627 * @param obj The photo object.
12628 * @param file The path to file that will be used as thumb.
12629 * @param group The key used in case of an EET file.
12633 EAPI void elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
12636 * Set the size that will be used on the photo
12638 * @param obj The photo object
12639 * @param size The size that the photo will be
12643 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12646 * Set if the photo should be completely visible or not.
12648 * @param obj The photo object
12649 * @param fill if true the photo will be completely visible
12653 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12656 * Set editability of the photo.
12658 * An editable photo can be dragged to or from, and can be cut or
12659 * pasted too. Note that pasting an image or dropping an item on
12660 * the image will delete the existing content.
12662 * @param obj The photo object.
12663 * @param set To set of clear editablity.
12665 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12671 /* gesture layer */
12673 * @defgroup Elm_Gesture_Layer Gesture Layer
12674 * Gesture Layer Usage:
12676 * Use Gesture Layer to detect gestures.
12677 * The advantage is that you don't have to implement
12678 * gesture detection, just set callbacks of gesture state.
12679 * By using gesture layer we make standard interface.
12681 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12682 * with a parent object parameter.
12683 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12684 * call. Usually with same object as target (2nd parameter).
12686 * Now you need to tell gesture layer what gestures you follow.
12687 * This is done with @ref elm_gesture_layer_cb_set call.
12688 * By setting the callback you actually saying to gesture layer:
12689 * I would like to know when the gesture @ref Elm_Gesture_Types
12690 * switches to state @ref Elm_Gesture_State.
12692 * Next, you need to implement the actual action that follows the input
12693 * in your callback.
12695 * Note that if you like to stop being reported about a gesture, just set
12696 * all callbacks referring this gesture to NULL.
12697 * (again with @ref elm_gesture_layer_cb_set)
12699 * The information reported by gesture layer to your callback is depending
12700 * on @ref Elm_Gesture_Types:
12701 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12702 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12703 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12705 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12706 * @ref ELM_GESTURE_MOMENTUM.
12708 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12709 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12710 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12711 * Note that we consider a flick as a line-gesture that should be completed
12712 * in flick-time-limit as defined in @ref Config.
12714 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12716 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12719 * Gesture Layer Tweaks:
12721 * Note that line, flick, gestures can start without the need to remove fingers from surface.
12722 * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
12724 * Setting glayer_continues_enable to false in @ref Config will change this behavior
12725 * so gesture starts when user touches (a *DOWN event) touch-surface
12726 * and ends when no fingers touches surface (a *UP event).
12730 * @enum _Elm_Gesture_Types
12731 * Enum of supported gesture types.
12732 * @ingroup Elm_Gesture_Layer
12734 enum _Elm_Gesture_Types
12736 ELM_GESTURE_FIRST = 0,
12738 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12739 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12740 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12741 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12743 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12745 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12746 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12748 ELM_GESTURE_ZOOM, /**< Zoom */
12749 ELM_GESTURE_ROTATE, /**< Rotate */
12755 * @typedef Elm_Gesture_Types
12756 * gesture types enum
12757 * @ingroup Elm_Gesture_Layer
12759 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12762 * @enum _Elm_Gesture_State
12763 * Enum of gesture states.
12764 * @ingroup Elm_Gesture_Layer
12766 enum _Elm_Gesture_State
12768 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12769 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
12770 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
12771 ELM_GESTURE_STATE_END, /**< Gesture completed */
12772 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
12776 * @typedef Elm_Gesture_State
12777 * gesture states enum
12778 * @ingroup Elm_Gesture_Layer
12780 typedef enum _Elm_Gesture_State Elm_Gesture_State;
12783 * @struct _Elm_Gesture_Taps_Info
12784 * Struct holds taps info for user
12785 * @ingroup Elm_Gesture_Layer
12787 struct _Elm_Gesture_Taps_Info
12789 Evas_Coord x, y; /**< Holds center point between fingers */
12790 unsigned int n; /**< Number of fingers tapped */
12791 unsigned int timestamp; /**< event timestamp */
12795 * @typedef Elm_Gesture_Taps_Info
12796 * holds taps info for user
12797 * @ingroup Elm_Gesture_Layer
12799 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12802 * @struct _Elm_Gesture_Momentum_Info
12803 * Struct holds momentum info for user
12804 * x1 and y1 are not necessarily in sync
12805 * x1 holds x value of x direction starting point
12806 * and same holds for y1.
12807 * This is noticeable when doing V-shape movement
12808 * @ingroup Elm_Gesture_Layer
12810 struct _Elm_Gesture_Momentum_Info
12811 { /* Report line ends, timestamps, and momentum computed */
12812 Evas_Coord x1; /**< Final-swipe direction starting point on X */
12813 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12814 Evas_Coord x2; /**< Final-swipe direction ending point on X */
12815 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
12817 unsigned int tx; /**< Timestamp of start of final x-swipe */
12818 unsigned int ty; /**< Timestamp of start of final y-swipe */
12820 Evas_Coord mx; /**< Momentum on X */
12821 Evas_Coord my; /**< Momentum on Y */
12823 unsigned int n; /**< Number of fingers */
12827 * @typedef Elm_Gesture_Momentum_Info
12828 * holds momentum info for user
12829 * @ingroup Elm_Gesture_Layer
12831 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12834 * @struct _Elm_Gesture_Line_Info
12835 * Struct holds line info for user
12836 * @ingroup Elm_Gesture_Layer
12838 struct _Elm_Gesture_Line_Info
12839 { /* Report line ends, timestamps, and momentum computed */
12840 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12841 /* FIXME should be radians, bot degrees */
12842 double angle; /**< Angle (direction) of lines */
12846 * @typedef Elm_Gesture_Line_Info
12847 * Holds line info for user
12848 * @ingroup Elm_Gesture_Layer
12850 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12853 * @struct _Elm_Gesture_Zoom_Info
12854 * Struct holds zoom info for user
12855 * @ingroup Elm_Gesture_Layer
12857 struct _Elm_Gesture_Zoom_Info
12859 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12860 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12861 double zoom; /**< Zoom value: 1.0 means no zoom */
12862 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12866 * @typedef Elm_Gesture_Zoom_Info
12867 * Holds zoom info for user
12868 * @ingroup Elm_Gesture_Layer
12870 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12873 * @struct _Elm_Gesture_Rotate_Info
12874 * Struct holds rotation info for user
12875 * @ingroup Elm_Gesture_Layer
12877 struct _Elm_Gesture_Rotate_Info
12879 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12880 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12881 double base_angle; /**< Holds start-angle */
12882 double angle; /**< Rotation value: 0.0 means no rotation */
12883 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12887 * @typedef Elm_Gesture_Rotate_Info
12888 * Holds rotation info for user
12889 * @ingroup Elm_Gesture_Layer
12891 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12894 * @typedef Elm_Gesture_Event_Cb
12895 * User callback used to stream gesture info from gesture layer
12896 * @param data user data
12897 * @param event_info gesture report info
12898 * Returns a flag field to be applied on the causing event.
12899 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12900 * upon the event, in an irreversible way.
12902 * @ingroup Elm_Gesture_Layer
12904 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12907 * Use function to set callbacks to be notified about
12908 * change of state of gesture.
12909 * When a user registers a callback with this function
12910 * this means this gesture has to be tested.
12912 * When ALL callbacks for a gesture are set to NULL
12913 * it means user isn't interested in gesture-state
12914 * and it will not be tested.
12916 * @param obj Pointer to gesture-layer.
12917 * @param idx The gesture you would like to track its state.
12918 * @param cb callback function pointer.
12919 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
12920 * @param data user info to be sent to callback (usually, Smart Data)
12922 * @ingroup Elm_Gesture_Layer
12924 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);
12927 * Call this function to get repeat-events settings.
12929 * @param obj Pointer to gesture-layer.
12931 * @return repeat events settings.
12932 * @see elm_gesture_layer_hold_events_set()
12933 * @ingroup Elm_Gesture_Layer
12935 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12938 * This function called in order to make gesture-layer repeat events.
12939 * Set this of you like to get the raw events only if gestures were not detected.
12940 * Clear this if you like gesture layer to fwd events as testing gestures.
12942 * @param obj Pointer to gesture-layer.
12943 * @param r Repeat: TRUE/FALSE
12945 * @ingroup Elm_Gesture_Layer
12947 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
12950 * This function sets step-value for zoom action.
12951 * Set step to any positive value.
12952 * Cancel step setting by setting to 0.0
12954 * @param obj Pointer to gesture-layer.
12955 * @param s new zoom step value.
12957 * @ingroup Elm_Gesture_Layer
12959 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12962 * This function sets step-value for rotate action.
12963 * Set step to any positive value.
12964 * Cancel step setting by setting to 0.0
12966 * @param obj Pointer to gesture-layer.
12967 * @param s new roatate step value.
12969 * @ingroup Elm_Gesture_Layer
12971 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12974 * This function called to attach gesture-layer to an Evas_Object.
12975 * @param obj Pointer to gesture-layer.
12976 * @param t Pointer to underlying object (AKA Target)
12978 * @return TRUE, FALSE on success, failure.
12980 * @ingroup Elm_Gesture_Layer
12982 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
12985 * Call this function to construct a new gesture-layer object.
12986 * This does not activate the gesture layer. You have to
12987 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
12989 * @param parent the parent object.
12991 * @return Pointer to new gesture-layer object.
12993 * @ingroup Elm_Gesture_Layer
12995 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12998 * @defgroup Thumb Thumb
13000 * @image html img/widget/thumb/preview-00.png
13001 * @image latex img/widget/thumb/preview-00.eps
13003 * A thumb object is used for displaying the thumbnail of an image or video.
13004 * You must have compiled Elementary with Ethumb_Client support and the DBus
13005 * service must be present and auto-activated in order to have thumbnails to
13008 * Once the thumbnail object becomes visible, it will check if there is a
13009 * previously generated thumbnail image for the file set on it. If not, it
13010 * will start generating this thumbnail.
13012 * Different config settings will cause different thumbnails to be generated
13013 * even on the same file.
13015 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
13016 * Ethumb documentation to change this path, and to see other configuration
13019 * Signals that you can add callbacks for are:
13021 * - "clicked" - This is called when a user has clicked the thumb without dragging
13023 * - "clicked,double" - This is called when a user has double-clicked the thumb.
13024 * - "press" - This is called when a user has pressed down the thumb.
13025 * - "generate,start" - The thumbnail generation started.
13026 * - "generate,stop" - The generation process stopped.
13027 * - "generate,error" - The generation failed.
13028 * - "load,error" - The thumbnail image loading failed.
13030 * available styles:
13034 * An example of use of thumbnail:
13036 * - @ref thumb_example_01
13040 * @addtogroup Thumb
13045 * @enum _Elm_Thumb_Animation_Setting
13046 * @typedef Elm_Thumb_Animation_Setting
13048 * Used to set if a video thumbnail is animating or not.
13052 typedef enum _Elm_Thumb_Animation_Setting
13054 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
13055 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
13056 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
13057 ELM_THUMB_ANIMATION_LAST
13058 } Elm_Thumb_Animation_Setting;
13061 * Add a new thumb object to the parent.
13063 * @param parent The parent object.
13064 * @return The new object or NULL if it cannot be created.
13066 * @see elm_thumb_file_set()
13067 * @see elm_thumb_ethumb_client_get()
13071 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13073 * Reload thumbnail if it was generated before.
13075 * @param obj The thumb object to reload
13077 * This is useful if the ethumb client configuration changed, like its
13078 * size, aspect or any other property one set in the handle returned
13079 * by elm_thumb_ethumb_client_get().
13081 * If the options didn't change, the thumbnail won't be generated again, but
13082 * the old one will still be used.
13084 * @see elm_thumb_file_set()
13088 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
13090 * Set the file that will be used as thumbnail.
13092 * @param obj The thumb object.
13093 * @param file The path to file that will be used as thumb.
13094 * @param key The key used in case of an EET file.
13096 * The file can be an image or a video (in that case, acceptable extensions are:
13097 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
13098 * function elm_thumb_animate().
13100 * @see elm_thumb_file_get()
13101 * @see elm_thumb_reload()
13102 * @see elm_thumb_animate()
13106 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
13108 * Get the image or video path and key used to generate the thumbnail.
13110 * @param obj The thumb object.
13111 * @param file Pointer to filename.
13112 * @param key Pointer to key.
13114 * @see elm_thumb_file_set()
13115 * @see elm_thumb_path_get()
13119 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13121 * Get the path and key to the image or video generated by ethumb.
13123 * One just need to make sure that the thumbnail was generated before getting
13124 * its path; otherwise, the path will be NULL. One way to do that is by asking
13125 * for the path when/after the "generate,stop" smart callback is called.
13127 * @param obj The thumb object.
13128 * @param file Pointer to thumb path.
13129 * @param key Pointer to thumb key.
13131 * @see elm_thumb_file_get()
13135 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13137 * Set the animation state for the thumb object. If its content is an animated
13138 * video, you may start/stop the animation or tell it to play continuously and
13141 * @param obj The thumb object.
13142 * @param setting The animation setting.
13144 * @see elm_thumb_file_set()
13148 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
13150 * Get the animation state for the thumb object.
13152 * @param obj The thumb object.
13153 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
13156 * @see elm_thumb_animate_set()
13160 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13162 * Get the ethumb_client handle so custom configuration can be made.
13164 * @return Ethumb_Client instance or NULL.
13166 * This must be called before the objects are created to be sure no object is
13167 * visible and no generation started.
13169 * Example of usage:
13172 * #include <Elementary.h>
13173 * #ifndef ELM_LIB_QUICKLAUNCH
13175 * elm_main(int argc, char **argv)
13177 * Ethumb_Client *client;
13179 * elm_need_ethumb();
13183 * client = elm_thumb_ethumb_client_get();
13186 * ERR("could not get ethumb_client");
13189 * ethumb_client_size_set(client, 100, 100);
13190 * ethumb_client_crop_align_set(client, 0.5, 0.5);
13193 * // Create elm_thumb objects here
13203 * @note There's only one client handle for Ethumb, so once a configuration
13204 * change is done to it, any other request for thumbnails (for any thumbnail
13205 * object) will use that configuration. Thus, this configuration is global.
13209 EAPI void *elm_thumb_ethumb_client_get(void);
13211 * Get the ethumb_client connection state.
13213 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
13216 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
13218 * Make the thumbnail 'editable'.
13220 * @param obj Thumb object.
13221 * @param set Turn on or off editability. Default is @c EINA_FALSE.
13223 * This means the thumbnail is a valid drag target for drag and drop, and can be
13224 * cut or pasted too.
13226 * @see elm_thumb_editable_get()
13230 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
13232 * Make the thumbnail 'editable'.
13234 * @param obj Thumb object.
13235 * @return Editability.
13237 * This means the thumbnail is a valid drag target for drag and drop, and can be
13238 * cut or pasted too.
13240 * @see elm_thumb_editable_set()
13244 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13251 * @defgroup Web Web
13253 * @image html img/widget/web/preview-00.png
13254 * @image latex img/widget/web/preview-00.eps
13256 * A web object is used for displaying web pages (HTML/CSS/JS)
13257 * using WebKit-EFL. You must have compiled Elementary with
13260 * Signals that you can add callbacks for are:
13261 * @li "download,request": A file download has been requested. Event info is
13262 * a pointer to a Elm_Web_Download
13263 * @li "editorclient,contents,changed": Editor client's contents changed
13264 * @li "editorclient,selection,changed": Editor client's selection changed
13265 * @li "frame,created": A new frame was created. Event info is an
13266 * Evas_Object which can be handled with WebKit's ewk_frame API
13267 * @li "icon,received": An icon was received by the main frame
13268 * @li "inputmethod,changed": Input method changed. Event info is an
13269 * Eina_Bool indicating whether it's enabled or not
13270 * @li "js,windowobject,clear": JS window object has been cleared
13271 * @li "link,hover,in": Mouse cursor is hovering over a link. Event info
13272 * is a char *link[2], where the first string contains the URL the link
13273 * points to, and the second one the title of the link
13274 * @li "link,hover,out": Mouse cursor left the link
13275 * @li "load,document,finished": Loading of a document finished. Event info
13276 * is the frame that finished loading
13277 * @li "load,error": Load failed. Event info is a pointer to
13278 * Elm_Web_Frame_Load_Error
13279 * @li "load,finished": Load finished. Event info is NULL on success, on
13280 * error it's a pointer to Elm_Web_Frame_Load_Error
13281 * @li "load,newwindow,show": A new window was created and is ready to be
13283 * @li "load,progress": Overall load progress. Event info is a pointer to
13284 * a double containing a value between 0.0 and 1.0
13285 * @li "load,provisional": Started provisional load
13286 * @li "load,started": Loading of a document started
13287 * @li "menubar,visible,get": Queries if the menubar is visible. Event info
13288 * is a pointer to Eina_Bool where the callback should set EINA_TRUE if
13289 * the menubar is visible, or EINA_FALSE in case it's not
13290 * @li "menubar,visible,set": Informs menubar visibility. Event info is
13291 * an Eina_Bool indicating the visibility
13292 * @li "popup,created": A dropdown widget was activated, requesting its
13293 * popup menu to be created. Event info is a pointer to Elm_Web_Menu
13294 * @li "popup,willdelete": The web object is ready to destroy the popup
13295 * object created. Event info is a pointer to Elm_Web_Menu
13296 * @li "ready": Page is fully loaded
13297 * @li "scrollbars,visible,get": Queries visibility of scrollbars. Event
13298 * info is a pointer to Eina_Bool where the visibility state should be set
13299 * @li "scrollbars,visible,set": Informs scrollbars visibility. Event info
13300 * is an Eina_Bool with the visibility state set
13301 * @li "statusbar,text,set": Text of the statusbar changed. Even info is
13302 * a string with the new text
13303 * @li "statusbar,visible,get": Queries visibility of the status bar.
13304 * Event info is a pointer to Eina_Bool where the visibility state should be
13306 * @li "statusbar,visible,set": Informs statusbar visibility. Event info is
13307 * an Eina_Bool with the visibility value
13308 * @li "title,changed": Title of the main frame changed. Event info is a
13309 * string with the new title
13310 * @li "toolbars,visible,get": Queries visibility of toolbars. Event info
13311 * is a pointer to Eina_Bool where the visibility state should be set
13312 * @li "toolbars,visible,set": Informs the visibility of toolbars. Event
13313 * info is an Eina_Bool with the visibility state
13314 * @li "tooltip,text,set": Show and set text of a tooltip. Event info is
13315 * a string with the text to show
13316 * @li "uri,changed": URI of the main frame changed. Event info is a string
13318 * @li "view,resized": The web object internal's view changed sized
13319 * @li "windows,close,request": A JavaScript request to close the current
13320 * window was requested
13321 * @li "zoom,animated,end": Animated zoom finished
13323 * available styles:
13326 * An example of use of web:
13328 * - @ref web_example_01 TBD
13337 * Structure used to report load errors.
13339 * Load errors are reported as signal by elm_web. All the strings are
13340 * temporary references and should @b not be used after the signal
13341 * callback returns. If it's required, make copies with strdup() or
13342 * eina_stringshare_add() (they are not even guaranteed to be
13343 * stringshared, so must use eina_stringshare_add() and not
13344 * eina_stringshare_ref()).
13346 typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
13348 * Structure used to report load errors.
13350 * Load errors are reported as signal by elm_web. All the strings are
13351 * temporary references and should @b not be used after the signal
13352 * callback returns. If it's required, make copies with strdup() or
13353 * eina_stringshare_add() (they are not even guaranteed to be
13354 * stringshared, so must use eina_stringshare_add() and not
13355 * eina_stringshare_ref()).
13357 struct _Elm_Web_Frame_Load_Error
13359 int code; /**< Numeric error code */
13360 Eina_Bool is_cancellation; /**< Error produced by cancelling a request */
13361 const char *domain; /**< Error domain name */
13362 const char *description; /**< Error description (already localized) */
13363 const char *failing_url; /**< The URL that failed to load */
13364 Evas_Object *frame; /**< Frame object that produced the error */
13368 * The possibles types that the items in a menu can be
13370 typedef enum _Elm_Web_Menu_Item_Type
13372 ELM_WEB_MENU_SEPARATOR,
13373 ELM_WEB_MENU_GROUP,
13374 ELM_WEB_MENU_OPTION
13375 } Elm_Web_Menu_Item_Type;
13378 * Structure describing the items in a menu
13380 typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item;
13382 * Structure describing the items in a menu
13384 struct _Elm_Web_Menu_Item
13386 const char *text; /**< The text for the item */
13387 Elm_Web_Menu_Item_Type type; /**< The type of the item */
13391 * Structure describing the menu of a popup
13393 * This structure will be passed as the @c event_info for the "popup,create"
13394 * signal, which is emitted when a dropdown menu is opened. Users wanting
13395 * to handle these popups by themselves should listen to this signal and
13396 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13397 * property as @c EINA_FALSE means that the user will not handle the popup
13398 * and the default implementation will be used.
13400 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13401 * will be emitted to notify the user that it can destroy any objects and
13402 * free all data related to it.
13404 * @see elm_web_popup_selected_set()
13405 * @see elm_web_popup_destroy()
13407 typedef struct _Elm_Web_Menu Elm_Web_Menu;
13409 * Structure describing the menu of a popup
13411 * This structure will be passed as the @c event_info for the "popup,create"
13412 * signal, which is emitted when a dropdown menu is opened. Users wanting
13413 * to handle these popups by themselves should listen to this signal and
13414 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13415 * property as @c EINA_FALSE means that the user will not handle the popup
13416 * and the default implementation will be used.
13418 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13419 * will be emitted to notify the user that it can destroy any objects and
13420 * free all data related to it.
13422 * @see elm_web_popup_selected_set()
13423 * @see elm_web_popup_destroy()
13425 struct _Elm_Web_Menu
13427 Eina_List *items; /**< List of #Elm_Web_Menu_Item */
13428 int x; /**< The X position of the popup, relative to the elm_web object */
13429 int y; /**< The Y position of the popup, relative to the elm_web object */
13430 int width; /**< Width of the popup menu */
13431 int height; /**< Height of the popup menu */
13433 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. */
13436 typedef struct _Elm_Web_Download Elm_Web_Download;
13437 struct _Elm_Web_Download
13443 * Types of zoom available.
13445 typedef enum _Elm_Web_Zoom_Mode
13447 ELM_WEB_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_web_zoom_set */
13448 ELM_WEB_ZOOM_MODE_AUTO_FIT, /**< Zoom until content fits in web object */
13449 ELM_WEB_ZOOM_MODE_AUTO_FILL, /**< Zoom until content fills web object */
13450 ELM_WEB_ZOOM_MODE_LAST
13451 } Elm_Web_Zoom_Mode;
13453 * Opaque handler containing the features (such as statusbar, menubar, etc)
13454 * that are to be set on a newly requested window.
13456 typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
13458 * Callback type for the create_window hook.
13460 * The function parameters are:
13461 * @li @p data User data pointer set when setting the hook function
13462 * @li @p obj The elm_web object requesting the new window
13463 * @li @p js Set to @c EINA_TRUE if the request was originated from
13464 * JavaScript. @c EINA_FALSE otherwise.
13465 * @li @p window_features A pointer of #Elm_Web_Window_Features indicating
13466 * the features requested for the new window.
13468 * The returned value of the function should be the @c elm_web widget where
13469 * the request will be loaded. That is, if a new window or tab is created,
13470 * the elm_web widget in it should be returned, and @b NOT the window
13472 * Returning @c NULL should cancel the request.
13474 * @see elm_web_window_create_hook_set()
13476 typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
13478 * Callback type for the JS alert hook.
13480 * The function parameters are:
13481 * @li @p data User data pointer set when setting the hook function
13482 * @li @p obj The elm_web object requesting the new window
13483 * @li @p message The message to show in the alert dialog
13485 * The function should return the object representing the alert dialog.
13486 * Elm_Web will run a second main loop to handle the dialog and normal
13487 * flow of the application will be restored when the object is deleted, so
13488 * the user should handle the popup properly in order to delete the object
13489 * when the action is finished.
13490 * If the function returns @c NULL the popup will be ignored.
13492 * @see elm_web_dialog_alert_hook_set()
13494 typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
13496 * Callback type for the JS confirm hook.
13498 * The function parameters are:
13499 * @li @p data User data pointer set when setting the hook function
13500 * @li @p obj The elm_web object requesting the new window
13501 * @li @p message The message to show in the confirm dialog
13502 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13503 * the user selected @c Ok, @c EINA_FALSE otherwise.
13505 * The function should return the object representing the confirm dialog.
13506 * Elm_Web will run a second main loop to handle the dialog and normal
13507 * flow of the application will be restored when the object is deleted, so
13508 * the user should handle the popup properly in order to delete the object
13509 * when the action is finished.
13510 * If the function returns @c NULL the popup will be ignored.
13512 * @see elm_web_dialog_confirm_hook_set()
13514 typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
13516 * Callback type for the JS prompt hook.
13518 * The function parameters are:
13519 * @li @p data User data pointer set when setting the hook function
13520 * @li @p obj The elm_web object requesting the new window
13521 * @li @p message The message to show in the prompt dialog
13522 * @li @p def_value The default value to present the user in the entry
13523 * @li @p value Pointer where to store the value given by the user. Must
13524 * be a malloc'ed string or @c NULL if the user cancelled the popup.
13525 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13526 * the user selected @c Ok, @c EINA_FALSE otherwise.
13528 * The function should return the object representing the prompt dialog.
13529 * Elm_Web will run a second main loop to handle the dialog and normal
13530 * flow of the application will be restored when the object is deleted, so
13531 * the user should handle the popup properly in order to delete the object
13532 * when the action is finished.
13533 * If the function returns @c NULL the popup will be ignored.
13535 * @see elm_web_dialog_prompt_hook_set()
13537 typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret);
13539 * Callback type for the JS file selector hook.
13541 * The function parameters are:
13542 * @li @p data User data pointer set when setting the hook function
13543 * @li @p obj The elm_web object requesting the new window
13544 * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
13545 * @li @p accept_types Mime types accepted
13546 * @li @p selected Pointer where to store the list of malloc'ed strings
13547 * containing the path to each file selected. Must be @c NULL if the file
13548 * dialog is cancelled
13549 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13550 * the user selected @c Ok, @c EINA_FALSE otherwise.
13552 * The function should return the object representing the file selector
13554 * Elm_Web will run a second main loop to handle the dialog and normal
13555 * flow of the application will be restored when the object is deleted, so
13556 * the user should handle the popup properly in order to delete the object
13557 * when the action is finished.
13558 * If the function returns @c NULL the popup will be ignored.
13560 * @see elm_web_dialog_file selector_hook_set()
13562 typedef Evas_Object *(*Elm_Web_Dialog_File_Selector)(void *data, Evas_Object *obj, Eina_Bool allows_multiple, Eina_List *accept_types, Eina_List **selected, Eina_Bool *ret);
13564 * Callback type for the JS console message hook.
13566 * When a console message is added from JavaScript, any set function to the
13567 * console message hook will be called for the user to handle. There is no
13568 * default implementation of this hook.
13570 * The function parameters are:
13571 * @li @p data User data pointer set when setting the hook function
13572 * @li @p obj The elm_web object that originated the message
13573 * @li @p message The message sent
13574 * @li @p line_number The line number
13575 * @li @p source_id Source id
13577 * @see elm_web_console_message_hook_set()
13579 typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
13581 * Add a new web object to the parent.
13583 * @param parent The parent object.
13584 * @return The new object or NULL if it cannot be created.
13586 * @see elm_web_uri_set()
13587 * @see elm_web_webkit_view_get()
13589 EAPI Evas_Object *elm_web_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13592 * Get internal ewk_view object from web object.
13594 * Elementary may not provide some low level features of EWebKit,
13595 * instead of cluttering the API with proxy methods we opted to
13596 * return the internal reference. Be careful using it as it may
13597 * interfere with elm_web behavior.
13599 * @param obj The web object.
13600 * @return The internal ewk_view object or NULL if it does not
13601 * exist. (Failure to create or Elementary compiled without
13604 * @see elm_web_add()
13606 EAPI Evas_Object *elm_web_webkit_view_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13609 * Sets the function to call when a new window is requested
13611 * This hook will be called when a request to create a new window is
13612 * issued from the web page loaded.
13613 * There is no default implementation for this feature, so leaving this
13614 * unset or passing @c NULL in @p func will prevent new windows from
13617 * @param obj The web object where to set the hook function
13618 * @param func The hook function to be called when a window is requested
13619 * @param data User data
13621 EAPI void elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data);
13623 * Sets the function to call when an alert dialog
13625 * This hook will be called when a JavaScript alert dialog is requested.
13626 * If no function is set or @c NULL is passed in @p func, the default
13627 * implementation will take place.
13629 * @param obj The web object where to set the hook function
13630 * @param func The callback function to be used
13631 * @param data User data
13633 * @see elm_web_inwin_mode_set()
13635 EAPI void elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data);
13637 * Sets the function to call when an confirm dialog
13639 * This hook will be called when a JavaScript confirm dialog is requested.
13640 * If no function is set or @c NULL is passed in @p func, the default
13641 * implementation will take place.
13643 * @param obj The web object where to set the hook function
13644 * @param func The callback function to be used
13645 * @param data User data
13647 * @see elm_web_inwin_mode_set()
13649 EAPI void elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data);
13651 * Sets the function to call when an prompt dialog
13653 * This hook will be called when a JavaScript prompt dialog is requested.
13654 * If no function is set or @c NULL is passed in @p func, the default
13655 * implementation will take place.
13657 * @param obj The web object where to set the hook function
13658 * @param func The callback function to be used
13659 * @param data User data
13661 * @see elm_web_inwin_mode_set()
13663 EAPI void elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data);
13665 * Sets the function to call when an file selector dialog
13667 * This hook will be called when a JavaScript file selector dialog is
13669 * If no function is set or @c NULL is passed in @p func, the default
13670 * implementation will take place.
13672 * @param obj The web object where to set the hook function
13673 * @param func The callback function to be used
13674 * @param data User data
13676 * @see elm_web_inwin_mode_set()
13678 EAPI void elm_web_dialog_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data);
13680 * Sets the function to call when a console message is emitted from JS
13682 * This hook will be called when a console message is emitted from
13683 * JavaScript. There is no default implementation for this feature.
13685 * @param obj The web object where to set the hook function
13686 * @param func The callback function to be used
13687 * @param data User data
13689 EAPI void elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data);
13691 * Gets the status of the tab propagation
13693 * @param obj The web object to query
13694 * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
13696 * @see elm_web_tab_propagate_set()
13698 EAPI Eina_Bool elm_web_tab_propagate_get(const Evas_Object *obj);
13700 * Sets whether to use tab propagation
13702 * If tab propagation is enabled, whenever the user presses the Tab key,
13703 * Elementary will handle it and switch focus to the next widget.
13704 * The default value is disabled, where WebKit will handle the Tab key to
13705 * cycle focus though its internal objects, jumping to the next widget
13706 * only when that cycle ends.
13708 * @param obj The web object
13709 * @param propagate Whether to propagate Tab keys to Elementary or not
13711 EAPI void elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate);
13713 * Sets the URI for the web object
13715 * It must be a full URI, with resource included, in the form
13716 * http://www.enlightenment.org or file:///tmp/something.html
13718 * @param obj The web object
13719 * @param uri The URI to set
13720 * @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
13722 EAPI Eina_Bool elm_web_uri_set(Evas_Object *obj, const char *uri);
13724 * Gets the current URI for the object
13726 * The returned string must not be freed and is guaranteed to be
13729 * @param obj The web object
13730 * @return A stringshared internal string with the current URI, or NULL on
13733 EAPI const char *elm_web_uri_get(const Evas_Object *obj);
13735 * Gets the current title
13737 * The returned string must not be freed and is guaranteed to be
13740 * @param obj The web object
13741 * @return A stringshared internal string with the current title, or NULL on
13744 EAPI const char *elm_web_title_get(const Evas_Object *obj);
13746 * Sets the background color to be used by the web object
13748 * This is the color that will be used by default when the loaded page
13749 * does not set it's own. Color values are pre-multiplied.
13751 * @param obj The web object
13752 * @param r Red component
13753 * @param g Green component
13754 * @param b Blue component
13755 * @param a Alpha component
13757 EAPI void elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a);
13759 * Gets the background color to be used by the web object
13761 * This is the color that will be used by default when the loaded page
13762 * does not set it's own. Color values are pre-multiplied.
13764 * @param obj The web object
13765 * @param r Red component
13766 * @param g Green component
13767 * @param b Blue component
13768 * @param a Alpha component
13770 EAPI void elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
13772 * Gets a copy of the currently selected text
13774 * The string returned must be freed by the user when it's done with it.
13776 * @param obj The web object
13777 * @return A newly allocated string, or NULL if nothing is selected or an
13780 EAPI char *elm_view_selection_get(const Evas_Object *obj);
13782 * Tells the web object which index in the currently open popup was selected
13784 * When the user handles the popup creation from the "popup,created" signal,
13785 * it needs to tell the web object which item was selected by calling this
13786 * function with the index corresponding to the item.
13788 * @param obj The web object
13789 * @param index The index selected
13791 * @see elm_web_popup_destroy()
13793 EAPI void elm_web_popup_selected_set(Evas_Object *obj, int index);
13795 * Dismisses an open dropdown popup
13797 * When the popup from a dropdown widget is to be dismissed, either after
13798 * selecting an option or to cancel it, this function must be called, which
13799 * will later emit an "popup,willdelete" signal to notify the user that
13800 * any memory and objects related to this popup can be freed.
13802 * @param obj The web object
13803 * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE
13804 * if there was no menu to destroy
13806 EAPI Eina_Bool elm_web_popup_destroy(Evas_Object *obj);
13808 * Searches the given string in a document.
13810 * @param obj The web object where to search the text
13811 * @param string String to search
13812 * @param case_sensitive If search should be case sensitive or not
13813 * @param forward If search is from cursor and on or backwards
13814 * @param wrap If search should wrap at the end
13816 * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not
13819 EAPI Eina_Bool elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
13821 * Marks matches of the given string in a document.
13823 * @param obj The web object where to search text
13824 * @param string String to match
13825 * @param case_sensitive If match should be case sensitive or not
13826 * @param highlight If matches should be highlighted
13827 * @param limit Maximum amount of matches, or zero to unlimited
13829 * @return number of matched @a string
13831 EAPI unsigned int elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
13833 * Clears all marked matches in the document
13835 * @param obj The web object
13837 * @return EINA_TRUE on success, EINA_FALSE otherwise
13839 EAPI Eina_Bool elm_web_text_matches_unmark_all(Evas_Object *obj);
13841 * Sets whether to highlight the matched marks
13843 * If enabled, marks set with elm_web_text_matches_mark() will be
13846 * @param obj The web object
13847 * @param highlight Whether to highlight the marks or not
13849 * @return EINA_TRUE on success, EINA_FALSE otherwise
13851 EAPI Eina_Bool elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight);
13853 * Gets whether highlighting marks is enabled
13855 * @param The web object
13857 * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
13860 EAPI Eina_Bool elm_web_text_matches_highlight_get(const Evas_Object *obj);
13862 * Gets the overall loading progress of the page
13864 * Returns the estimated loading progress of the page, with a value between
13865 * 0.0 and 1.0. This is an estimated progress accounting for all the frames
13866 * included in the page.
13868 * @param The web object
13870 * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
13873 EAPI double elm_web_load_progress_get(const Evas_Object *obj);
13875 * Stops loading the current page
13877 * Cancels the loading of the current page in the web object. This will
13878 * cause a "load,error" signal to be emitted, with the is_cancellation
13879 * flag set to EINA_TRUE.
13881 * @param obj The web object
13883 * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
13885 EAPI Eina_Bool elm_web_stop(Evas_Object *obj);
13887 * Requests a reload of the current document in the object
13889 * @param obj The web object
13891 * @return EINA_TRUE on success, EINA_FALSE otherwise
13893 EAPI Eina_Bool elm_web_reload(Evas_Object *obj);
13895 * Requests a reload of the current document, avoiding any existing caches
13897 * @param obj The web object
13899 * @return EINA_TRUE on success, EINA_FALSE otherwise
13901 EAPI Eina_Bool elm_web_reload_full(Evas_Object *obj);
13903 * Goes back one step in the browsing history
13905 * This is equivalent to calling elm_web_object_navigate(obj, -1);
13907 * @param obj The web object
13909 * @return EINA_TRUE on success, EINA_FALSE otherwise
13911 * @see elm_web_history_enable_set()
13912 * @see elm_web_back_possible()
13913 * @see elm_web_forward()
13914 * @see elm_web_navigate()
13916 EAPI Eina_Bool elm_web_back(Evas_Object *obj);
13918 * Goes forward one step in the browsing history
13920 * This is equivalent to calling elm_web_object_navigate(obj, 1);
13922 * @param obj The web object
13924 * @return EINA_TRUE on success, EINA_FALSE otherwise
13926 * @see elm_web_history_enable_set()
13927 * @see elm_web_forward_possible()
13928 * @see elm_web_back()
13929 * @see elm_web_navigate()
13931 EAPI Eina_Bool elm_web_forward(Evas_Object *obj);
13933 * Jumps the given number of steps in the browsing history
13935 * The @p steps value can be a negative integer to back in history, or a
13936 * positive to move forward.
13938 * @param obj The web object
13939 * @param steps The number of steps to jump
13941 * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
13942 * history exists to jump the given number of steps
13944 * @see elm_web_history_enable_set()
13945 * @see elm_web_navigate_possible()
13946 * @see elm_web_back()
13947 * @see elm_web_forward()
13949 EAPI Eina_Bool elm_web_navigate(Evas_Object *obj, int steps);
13951 * Queries whether it's possible to go back in history
13953 * @param obj The web object
13955 * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
13958 EAPI Eina_Bool elm_web_back_possible(Evas_Object *obj);
13960 * Queries whether it's possible to go forward in history
13962 * @param obj The web object
13964 * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
13967 EAPI Eina_Bool elm_web_forward_possible(Evas_Object *obj);
13969 * Queries whether it's possible to jump the given number of steps
13971 * The @p steps value can be a negative integer to back in history, or a
13972 * positive to move forward.
13974 * @param obj The web object
13975 * @param steps The number of steps to check for
13977 * @return EINA_TRUE if enough history exists to perform the given jump,
13978 * EINA_FALSE otherwise
13980 EAPI Eina_Bool elm_web_navigate_possible(Evas_Object *obj, int steps);
13982 * Gets whether browsing history is enabled for the given object
13984 * @param obj The web object
13986 * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
13988 EAPI Eina_Bool elm_web_history_enable_get(const Evas_Object *obj);
13990 * Enables or disables the browsing history
13992 * @param obj The web object
13993 * @param enable Whether to enable or disable the browsing history
13995 EAPI void elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
13997 * Sets the zoom level of the web object
13999 * Zoom level matches the Webkit API, so 1.0 means normal zoom, with higher
14000 * values meaning zoom in and lower meaning zoom out. This function will
14001 * only affect the zoom level if the mode set with elm_web_zoom_mode_set()
14002 * is ::ELM_WEB_ZOOM_MODE_MANUAL.
14004 * @param obj The web object
14005 * @param zoom The zoom level to set
14007 EAPI void elm_web_zoom_set(Evas_Object *obj, double zoom);
14009 * Gets the current zoom level set on the web object
14011 * Note that this is the zoom level set on the web object and not that
14012 * of the underlying Webkit one. In the ::ELM_WEB_ZOOM_MODE_MANUAL mode,
14013 * the two zoom levels should match, but for the other two modes the
14014 * Webkit zoom is calculated internally to match the chosen mode without
14015 * changing the zoom level set for the web object.
14017 * @param obj The web object
14019 * @return The zoom level set on the object
14021 EAPI double elm_web_zoom_get(const Evas_Object *obj);
14023 * Sets the zoom mode to use
14025 * The modes can be any of those defined in ::Elm_Web_Zoom_Mode, except
14026 * ::ELM_WEB_ZOOM_MODE_LAST. The default is ::ELM_WEB_ZOOM_MODE_MANUAL.
14028 * ::ELM_WEB_ZOOM_MODE_MANUAL means the zoom level will be controlled
14029 * with the elm_web_zoom_set() function.
14030 * ::ELM_WEB_ZOOM_MODE_AUTO_FIT will calculate the needed zoom level to
14031 * make sure the entirety of the web object's contents are shown.
14032 * ::ELM_WEB_ZOOM_MODE_AUTO_FILL will calculate the needed zoom level to
14033 * fit the contents in the web object's size, without leaving any space
14036 * @param obj The web object
14037 * @param mode The mode to set
14039 EAPI void elm_web_zoom_mode_set(Evas_Object *obj, Elm_Web_Zoom_Mode mode);
14041 * Gets the currently set zoom mode
14043 * @param obj The web object
14045 * @return The current zoom mode set for the object, or
14046 * ::ELM_WEB_ZOOM_MODE_LAST on error
14048 EAPI Elm_Web_Zoom_Mode elm_web_zoom_mode_get(const Evas_Object *obj);
14050 * Shows the given region in the web object
14052 * @param obj The web object
14053 * @param x The x coordinate of the region to show
14054 * @param y The y coordinate of the region to show
14055 * @param w The width of the region to show
14056 * @param h The height of the region to show
14058 EAPI void elm_web_region_show(Evas_Object *obj, int x, int y, int w, int h);
14060 * Brings in the region to the visible area
14062 * Like elm_web_region_show(), but it animates the scrolling of the object
14065 * @param obj The web object
14066 * @param x The x coordinate of the region to show
14067 * @param y The y coordinate of the region to show
14068 * @param w The width of the region to show
14069 * @param h The height of the region to show
14071 EAPI void elm_web_region_bring_in(Evas_Object *obj, int x, int y, int w, int h);
14073 * Sets the default dialogs to use an Inwin instead of a normal window
14075 * If set, then the default implementation for the JavaScript dialogs and
14076 * file selector will be opened in an Inwin. Otherwise they will use a
14077 * normal separated window.
14079 * @param obj The web object
14080 * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
14082 EAPI void elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
14084 * Gets whether Inwin mode is set for the current object
14086 * @param obj The web object
14088 * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
14090 EAPI Eina_Bool elm_web_inwin_mode_get(const Evas_Object *obj);
14092 EAPI void elm_web_window_features_ref(Elm_Web_Window_Features *wf);
14093 EAPI void elm_web_window_features_unref(Elm_Web_Window_Features *wf);
14094 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);
14095 EAPI void elm_web_window_features_int_property_get(const Elm_Web_Window_Features *wf, int *x, int *y, int *w, int *h);
14102 * @defgroup Hoversel Hoversel
14104 * @image html img/widget/hoversel/preview-00.png
14105 * @image latex img/widget/hoversel/preview-00.eps
14107 * A hoversel is a button that pops up a list of items (automatically
14108 * choosing the direction to display) that have a label and, optionally, an
14109 * icon to select from. It is a convenience widget to avoid the need to do
14110 * all the piecing together yourself. It is intended for a small number of
14111 * items in the hoversel menu (no more than 8), though is capable of many
14114 * Signals that you can add callbacks for are:
14115 * "clicked" - the user clicked the hoversel button and popped up the sel
14116 * "selected" - an item in the hoversel list is selected. event_info is the item
14117 * "dismissed" - the hover is dismissed
14119 * See @ref tutorial_hoversel for an example.
14122 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
14124 * @brief Add a new Hoversel object
14126 * @param parent The parent object
14127 * @return The new object or NULL if it cannot be created
14129 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14131 * @brief This sets the hoversel to expand horizontally.
14133 * @param obj The hoversel object
14134 * @param horizontal If true, the hover will expand horizontally to the
14137 * @note The initial button will display horizontally regardless of this
14140 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14142 * @brief This returns whether the hoversel is set to expand horizontally.
14144 * @param obj The hoversel object
14145 * @return If true, the hover will expand horizontally to the right.
14147 * @see elm_hoversel_horizontal_set()
14149 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14151 * @brief Set the Hover parent
14153 * @param obj The hoversel object
14154 * @param parent The parent to use
14156 * Sets the hover parent object, the area that will be darkened when the
14157 * hoversel is clicked. Should probably be the window that the hoversel is
14158 * in. See @ref Hover objects for more information.
14160 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14162 * @brief Get the Hover parent
14164 * @param obj The hoversel object
14165 * @return The used parent
14167 * Gets the hover parent object.
14169 * @see elm_hoversel_hover_parent_set()
14171 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14173 * @brief Set the hoversel button label
14175 * @param obj The hoversel object
14176 * @param label The label text.
14178 * This sets the label of the button that is always visible (before it is
14179 * clicked and expanded).
14181 * @deprecated elm_object_text_set()
14183 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14185 * @brief Get the hoversel button label
14187 * @param obj The hoversel object
14188 * @return The label text.
14190 * @deprecated elm_object_text_get()
14192 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14194 * @brief Set the icon of the hoversel button
14196 * @param obj The hoversel object
14197 * @param icon The icon object
14199 * Sets the icon of the button that is always visible (before it is clicked
14200 * and expanded). Once the icon object is set, a previously set one will be
14201 * deleted, if you want to keep that old content object, use the
14202 * elm_hoversel_icon_unset() function.
14204 * @see elm_object_content_set() for the button widget
14206 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
14208 * @brief Get the icon of the hoversel button
14210 * @param obj The hoversel object
14211 * @return The icon object
14213 * Get the icon of the button that is always visible (before it is clicked
14214 * and expanded). Also see elm_object_content_get() for the button widget.
14216 * @see elm_hoversel_icon_set()
14218 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14220 * @brief Get and unparent the icon of the hoversel button
14222 * @param obj The hoversel object
14223 * @return The icon object that was being used
14225 * Unparent and return the icon of the button that is always visible
14226 * (before it is clicked and expanded).
14228 * @see elm_hoversel_icon_set()
14229 * @see elm_object_content_unset() for the button widget
14231 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14233 * @brief This triggers the hoversel popup from code, the same as if the user
14234 * had clicked the button.
14236 * @param obj The hoversel object
14238 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
14240 * @brief This dismisses the hoversel popup as if the user had clicked
14241 * outside the hover.
14243 * @param obj The hoversel object
14245 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
14247 * @brief Returns whether the hoversel is expanded.
14249 * @param obj The hoversel object
14250 * @return This will return EINA_TRUE if the hoversel is expanded or
14251 * EINA_FALSE if it is not expanded.
14253 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14255 * @brief This will remove all the children items from the hoversel.
14257 * @param obj The hoversel object
14259 * @warning Should @b not be called while the hoversel is active; use
14260 * elm_hoversel_expanded_get() to check first.
14262 * @see elm_hoversel_item_del_cb_set()
14263 * @see elm_hoversel_item_del()
14265 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14267 * @brief Get the list of items within the given hoversel.
14269 * @param obj The hoversel object
14270 * @return Returns a list of Elm_Hoversel_Item*
14272 * @see elm_hoversel_item_add()
14274 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14276 * @brief Add an item to the hoversel button
14278 * @param obj The hoversel object
14279 * @param label The text label to use for the item (NULL if not desired)
14280 * @param icon_file An image file path on disk to use for the icon or standard
14281 * icon name (NULL if not desired)
14282 * @param icon_type The icon type if relevant
14283 * @param func Convenience function to call when this item is selected
14284 * @param data Data to pass to item-related functions
14285 * @return A handle to the item added.
14287 * This adds an item to the hoversel to show when it is clicked. Note: if you
14288 * need to use an icon from an edje file then use
14289 * elm_hoversel_item_icon_set() right after the this function, and set
14290 * icon_file to NULL here.
14292 * For more information on what @p icon_file and @p icon_type are see the
14293 * @ref Icon "icon documentation".
14295 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);
14297 * @brief Delete an item from the hoversel
14299 * @param item The item to delete
14301 * This deletes the item from the hoversel (should not be called while the
14302 * hoversel is active; use elm_hoversel_expanded_get() to check first).
14304 * @see elm_hoversel_item_add()
14305 * @see elm_hoversel_item_del_cb_set()
14307 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
14309 * @brief Set the function to be called when an item from the hoversel is
14312 * @param item The item to set the callback on
14313 * @param func The function called
14315 * That function will receive these parameters:
14316 * @li void *item_data
14317 * @li Evas_Object *the_item_object
14318 * @li Elm_Hoversel_Item *the_object_struct
14320 * @see elm_hoversel_item_add()
14322 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14324 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
14325 * that will be passed to associated function callbacks.
14327 * @param item The item to get the data from
14328 * @return The data pointer set with elm_hoversel_item_add()
14330 * @see elm_hoversel_item_add()
14332 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14334 * @brief This returns the label text of the given hoversel item.
14336 * @param item The item to get the label
14337 * @return The label text of the hoversel item
14339 * @see elm_hoversel_item_add()
14341 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14343 * @brief This sets the icon for the given hoversel item.
14345 * @param item The item to set the icon
14346 * @param icon_file An image file path on disk to use for the icon or standard
14348 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
14349 * to NULL if the icon is not an edje file
14350 * @param icon_type The icon type
14352 * The icon can be loaded from the standard set, from an image file, or from
14355 * @see elm_hoversel_item_add()
14357 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);
14359 * @brief Get the icon object of the hoversel item
14361 * @param item The item to get the icon from
14362 * @param icon_file The image file path on disk used for the icon or standard
14364 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
14365 * if the icon is not an edje file
14366 * @param icon_type The icon type
14368 * @see elm_hoversel_item_icon_set()
14369 * @see elm_hoversel_item_add()
14371 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);
14377 * @defgroup Toolbar Toolbar
14378 * @ingroup Elementary
14380 * @image html img/widget/toolbar/preview-00.png
14381 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
14383 * @image html img/toolbar.png
14384 * @image latex img/toolbar.eps width=\textwidth
14386 * A toolbar is a widget that displays a list of items inside
14387 * a box. It can be scrollable, show a menu with items that don't fit
14388 * to toolbar size or even crop them.
14390 * Only one item can be selected at a time.
14392 * Items can have multiple states, or show menus when selected by the user.
14394 * Smart callbacks one can listen to:
14395 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
14396 * - "language,changed" - when the program language changes
14398 * Available styles for it:
14400 * - @c "transparent" - no background or shadow, just show the content
14402 * List of examples:
14403 * @li @ref toolbar_example_01
14404 * @li @ref toolbar_example_02
14405 * @li @ref toolbar_example_03
14409 * @addtogroup Toolbar
14414 * @enum _Elm_Toolbar_Shrink_Mode
14415 * @typedef Elm_Toolbar_Shrink_Mode
14417 * Set toolbar's items display behavior, it can be scrollabel,
14418 * show a menu with exceeding items, or simply hide them.
14420 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
14423 * Values <b> don't </b> work as bitmask, only one can be choosen.
14425 * @see elm_toolbar_mode_shrink_set()
14426 * @see elm_toolbar_mode_shrink_get()
14430 typedef enum _Elm_Toolbar_Shrink_Mode
14432 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
14433 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
14434 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
14435 ELM_TOOLBAR_SHRINK_MENU, /**< Inserts a button to pop up a menu with exceeding items. */
14436 ELM_TOOLBAR_SHRINK_LAST /**< Indicates error if returned by elm_toolbar_shrink_mode_get() */
14437 } Elm_Toolbar_Shrink_Mode;
14439 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(). */
14441 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(). */
14444 * Add a new toolbar widget to the given parent Elementary
14445 * (container) object.
14447 * @param parent The parent object.
14448 * @return a new toolbar widget handle or @c NULL, on errors.
14450 * This function inserts a new toolbar widget on the canvas.
14454 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14457 * Set the icon size, in pixels, to be used by toolbar items.
14459 * @param obj The toolbar object
14460 * @param icon_size The icon size in pixels
14462 * @note Default value is @c 32. It reads value from elm config.
14464 * @see elm_toolbar_icon_size_get()
14468 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
14471 * Get the icon size, in pixels, to be used by toolbar items.
14473 * @param obj The toolbar object.
14474 * @return The icon size in pixels.
14476 * @see elm_toolbar_icon_size_set() for details.
14480 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14483 * Sets icon lookup order, for toolbar items' icons.
14485 * @param obj The toolbar object.
14486 * @param order The icon lookup order.
14488 * Icons added before calling this function will not be affected.
14489 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
14491 * @see elm_toolbar_icon_order_lookup_get()
14495 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
14498 * Gets the icon lookup order.
14500 * @param obj The toolbar object.
14501 * @return The icon lookup order.
14503 * @see elm_toolbar_icon_order_lookup_set() for details.
14507 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14510 * Set whether the toolbar should always have an item selected.
14512 * @param obj The toolbar object.
14513 * @param wrap @c EINA_TRUE to enable always-select mode or @c EINA_FALSE to
14516 * This will cause the toolbar to always have an item selected, and clicking
14517 * the selected item will not cause a selected event to be emitted. Enabling this mode
14518 * will immediately select the first toolbar item.
14520 * Always-selected is disabled by default.
14522 * @see elm_toolbar_always_select_mode_get().
14526 EAPI void elm_toolbar_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14529 * Get whether the toolbar should always have an item selected.
14531 * @param obj The toolbar object.
14532 * @return @c EINA_TRUE means an item will always be selected, @c EINA_FALSE indicates
14533 * that it is possible to have no items selected. If @p obj is @c NULL, @c EINA_FALSE is returned.
14535 * @see elm_toolbar_always_select_mode_set() for details.
14539 EAPI Eina_Bool elm_toolbar_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14542 * Set whether the toolbar items' should be selected by the user or not.
14544 * @param obj The toolbar object.
14545 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
14548 * This will turn off the ability to select items entirely and they will
14549 * neither appear selected nor emit selected signals. The clicked
14550 * callback function will still be called.
14552 * Selection is enabled by default.
14554 * @see elm_toolbar_no_select_mode_get().
14558 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14561 * Set whether the toolbar items' should be selected by the user or not.
14563 * @param obj The toolbar object.
14564 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
14565 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
14567 * @see elm_toolbar_no_select_mode_set() for details.
14571 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14574 * Append item to the toolbar.
14576 * @param obj The toolbar object.
14577 * @param icon A string with icon name or the absolute path of an image file.
14578 * @param label The label of the item.
14579 * @param func The function to call when the item is clicked.
14580 * @param data The data to associate with the item for related callbacks.
14581 * @return The created item or @c NULL upon failure.
14583 * A new item will be created and appended to the toolbar, i.e., will
14584 * be set as @b last item.
14586 * Items created with this method can be deleted with
14587 * elm_toolbar_item_del().
14589 * Associated @p data can be properly freed when item is deleted if a
14590 * callback function is set with elm_toolbar_item_del_cb_set().
14592 * If a function is passed as argument, it will be called everytime this item
14593 * is selected, i.e., the user clicks over an unselected item.
14594 * If such function isn't needed, just passing
14595 * @c NULL as @p func is enough. The same should be done for @p data.
14597 * Toolbar will load icon image from fdo or current theme.
14598 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14599 * If an absolute path is provided it will load it direct from a file.
14601 * @see elm_toolbar_item_icon_set()
14602 * @see elm_toolbar_item_del()
14603 * @see elm_toolbar_item_del_cb_set()
14607 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);
14610 * Prepend item to the toolbar.
14612 * @param obj The toolbar object.
14613 * @param icon A string with icon name or the absolute path of an image file.
14614 * @param label The label of the item.
14615 * @param func The function to call when the item is clicked.
14616 * @param data The data to associate with the item for related callbacks.
14617 * @return The created item or @c NULL upon failure.
14619 * A new item will be created and prepended to the toolbar, i.e., will
14620 * be set as @b first item.
14622 * Items created with this method can be deleted with
14623 * elm_toolbar_item_del().
14625 * Associated @p data can be properly freed when item is deleted if a
14626 * callback function is set with elm_toolbar_item_del_cb_set().
14628 * If a function is passed as argument, it will be called everytime this item
14629 * is selected, i.e., the user clicks over an unselected item.
14630 * If such function isn't needed, just passing
14631 * @c NULL as @p func is enough. The same should be done for @p data.
14633 * Toolbar will load icon image from fdo or current theme.
14634 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14635 * If an absolute path is provided it will load it direct from a file.
14637 * @see elm_toolbar_item_icon_set()
14638 * @see elm_toolbar_item_del()
14639 * @see elm_toolbar_item_del_cb_set()
14643 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);
14646 * Insert a new item into the toolbar object before item @p before.
14648 * @param obj The toolbar object.
14649 * @param before The toolbar item to insert before.
14650 * @param icon A string with icon name or the absolute path of an image file.
14651 * @param label The label of the item.
14652 * @param func The function to call when the item is clicked.
14653 * @param data The data to associate with the item for related callbacks.
14654 * @return The created item or @c NULL upon failure.
14656 * A new item will be created and added to the toolbar. Its position in
14657 * this toolbar will be just before item @p before.
14659 * Items created with this method can be deleted with
14660 * elm_toolbar_item_del().
14662 * Associated @p data can be properly freed when item is deleted if a
14663 * callback function is set with elm_toolbar_item_del_cb_set().
14665 * If a function is passed as argument, it will be called everytime this item
14666 * is selected, i.e., the user clicks over an unselected item.
14667 * If such function isn't needed, just passing
14668 * @c NULL as @p func is enough. The same should be done for @p data.
14670 * Toolbar will load icon image from fdo or current theme.
14671 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14672 * If an absolute path is provided it will load it direct from a file.
14674 * @see elm_toolbar_item_icon_set()
14675 * @see elm_toolbar_item_del()
14676 * @see elm_toolbar_item_del_cb_set()
14680 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);
14683 * Insert a new item into the toolbar object after item @p after.
14685 * @param obj The toolbar object.
14686 * @param after The toolbar item to insert after.
14687 * @param icon A string with icon name or the absolute path of an image file.
14688 * @param label The label of the item.
14689 * @param func The function to call when the item is clicked.
14690 * @param data The data to associate with the item for related callbacks.
14691 * @return The created item or @c NULL upon failure.
14693 * A new item will be created and added to the toolbar. Its position in
14694 * this toolbar will be just after item @p after.
14696 * Items created with this method can be deleted with
14697 * elm_toolbar_item_del().
14699 * Associated @p data can be properly freed when item is deleted if a
14700 * callback function is set with elm_toolbar_item_del_cb_set().
14702 * If a function is passed as argument, it will be called everytime this item
14703 * is selected, i.e., the user clicks over an unselected item.
14704 * If such function isn't needed, just passing
14705 * @c NULL as @p func is enough. The same should be done for @p data.
14707 * Toolbar will load icon image from fdo or current theme.
14708 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14709 * If an absolute path is provided it will load it direct from a file.
14711 * @see elm_toolbar_item_icon_set()
14712 * @see elm_toolbar_item_del()
14713 * @see elm_toolbar_item_del_cb_set()
14717 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);
14720 * Get the first item in the given toolbar widget's list of
14723 * @param obj The toolbar object
14724 * @return The first item or @c NULL, if it has no items (and on
14727 * @see elm_toolbar_item_append()
14728 * @see elm_toolbar_last_item_get()
14732 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14735 * Get the last item in the given toolbar widget's list of
14738 * @param obj The toolbar object
14739 * @return The last item or @c NULL, if it has no items (and on
14742 * @see elm_toolbar_item_prepend()
14743 * @see elm_toolbar_first_item_get()
14747 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14750 * Get the item after @p item in toolbar.
14752 * @param item The toolbar item.
14753 * @return The item after @p item, or @c NULL if none or on failure.
14755 * @note If it is the last item, @c NULL will be returned.
14757 * @see elm_toolbar_item_append()
14761 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14764 * Get the item before @p item in toolbar.
14766 * @param item The toolbar item.
14767 * @return The item before @p item, or @c NULL if none or on failure.
14769 * @note If it is the first item, @c NULL will be returned.
14771 * @see elm_toolbar_item_prepend()
14775 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14778 * Get the toolbar object from an item.
14780 * @param item The item.
14781 * @return The toolbar object.
14783 * This returns the toolbar object itself that an item belongs to.
14787 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14790 * Set the priority of a toolbar item.
14792 * @param item The toolbar item.
14793 * @param priority The item priority. The default is zero.
14795 * This is used only when the toolbar shrink mode is set to
14796 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
14797 * When space is less than required, items with low priority
14798 * will be removed from the toolbar and added to a dynamically-created menu,
14799 * while items with higher priority will remain on the toolbar,
14800 * with the same order they were added.
14802 * @see elm_toolbar_item_priority_get()
14806 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
14809 * Get the priority of a toolbar item.
14811 * @param item The toolbar item.
14812 * @return The @p item priority, or @c 0 on failure.
14814 * @see elm_toolbar_item_priority_set() for details.
14818 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14821 * Get the label of item.
14823 * @param item The item of toolbar.
14824 * @return The label of item.
14826 * The return value is a pointer to the label associated to @p item when
14827 * it was created, with function elm_toolbar_item_append() or similar,
14829 * with function elm_toolbar_item_label_set. If no label
14830 * was passed as argument, it will return @c NULL.
14832 * @see elm_toolbar_item_label_set() for more details.
14833 * @see elm_toolbar_item_append()
14837 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14840 * Set the label of item.
14842 * @param item The item of toolbar.
14843 * @param text The label of item.
14845 * The label to be displayed by the item.
14846 * Label will be placed at icons bottom (if set).
14848 * If a label was passed as argument on item creation, with function
14849 * elm_toolbar_item_append() or similar, it will be already
14850 * displayed by the item.
14852 * @see elm_toolbar_item_label_get()
14853 * @see elm_toolbar_item_append()
14857 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
14860 * Return the data associated with a given toolbar widget item.
14862 * @param item The toolbar widget item handle.
14863 * @return The data associated with @p item.
14865 * @see elm_toolbar_item_data_set()
14869 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14872 * Set the data associated with a given toolbar widget item.
14874 * @param item The toolbar widget item handle.
14875 * @param data The new data pointer to set to @p item.
14877 * This sets new item data on @p item.
14879 * @warning The old data pointer won't be touched by this function, so
14880 * the user had better to free that old data himself/herself.
14884 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
14887 * Returns a pointer to a toolbar item by its label.
14889 * @param obj The toolbar object.
14890 * @param label The label of the item to find.
14892 * @return The pointer to the toolbar item matching @p label or @c NULL
14897 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14900 * Get whether the @p item is selected or not.
14902 * @param item The toolbar item.
14903 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
14904 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
14906 * @see elm_toolbar_selected_item_set() for details.
14907 * @see elm_toolbar_item_selected_get()
14911 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14914 * Set the selected state of an item.
14916 * @param item The toolbar item
14917 * @param selected The selected state
14919 * This sets the selected state of the given item @p it.
14920 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
14922 * If a new item is selected the previosly selected will be unselected.
14923 * Previoulsy selected item can be get with function
14924 * elm_toolbar_selected_item_get().
14926 * Selected items will be highlighted.
14928 * @see elm_toolbar_item_selected_get()
14929 * @see elm_toolbar_selected_item_get()
14933 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14936 * Get the selected item.
14938 * @param obj The toolbar object.
14939 * @return The selected toolbar item.
14941 * The selected item can be unselected with function
14942 * elm_toolbar_item_selected_set().
14944 * The selected item always will be highlighted on toolbar.
14946 * @see elm_toolbar_selected_items_get()
14950 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14953 * Set the icon associated with @p item.
14955 * @param obj The parent of this item.
14956 * @param item The toolbar item.
14957 * @param icon A string with icon name or the absolute path of an image file.
14959 * Toolbar will load icon image from fdo or current theme.
14960 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14961 * If an absolute path is provided it will load it direct from a file.
14963 * @see elm_toolbar_icon_order_lookup_set()
14964 * @see elm_toolbar_icon_order_lookup_get()
14968 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
14971 * Get the string used to set the icon of @p item.
14973 * @param item The toolbar item.
14974 * @return The string associated with the icon object.
14976 * @see elm_toolbar_item_icon_set() for details.
14980 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14983 * Get the object of @p item.
14985 * @param item The toolbar item.
14986 * @return The object
14990 EAPI Evas_Object *elm_toolbar_item_object_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14993 * Get the icon object of @p item.
14995 * @param item The toolbar item.
14996 * @return The icon object
14998 * @see elm_toolbar_item_icon_set() or elm_toolbar_item_icon_memfile_set() for details.
15002 EAPI Evas_Object *elm_toolbar_item_icon_object_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15005 * Set the icon associated with @p item to an image in a binary buffer.
15007 * @param item The toolbar item.
15008 * @param img The binary data that will be used as an image
15009 * @param size The size of binary data @p img
15010 * @param format Optional format of @p img to pass to the image loader
15011 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
15013 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
15015 * @note The icon image set by this function can be changed by
15016 * elm_toolbar_item_icon_set().
15020 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);
15023 * Delete them item from the toolbar.
15025 * @param item The item of toolbar to be deleted.
15027 * @see elm_toolbar_item_append()
15028 * @see elm_toolbar_item_del_cb_set()
15032 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15035 * Set the function called when a toolbar item is freed.
15037 * @param item The item to set the callback on.
15038 * @param func The function called.
15040 * If there is a @p func, then it will be called prior item's memory release.
15041 * That will be called with the following arguments:
15043 * @li item's Evas object;
15046 * This way, a data associated to a toolbar item could be properly freed.
15050 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15053 * Get a value whether toolbar item is disabled or not.
15055 * @param item The item.
15056 * @return The disabled state.
15058 * @see elm_toolbar_item_disabled_set() for more details.
15062 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15065 * Sets the disabled/enabled state of a toolbar item.
15067 * @param item The item.
15068 * @param disabled The disabled state.
15070 * A disabled item cannot be selected or unselected. It will also
15071 * change its appearance (generally greyed out). This sets the
15072 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
15077 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15080 * Set or unset item as a separator.
15082 * @param item The toolbar item.
15083 * @param setting @c EINA_TRUE to set item @p item as separator or
15084 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
15086 * Items aren't set as separator by default.
15088 * If set as separator it will display separator theme, so won't display
15091 * @see elm_toolbar_item_separator_get()
15095 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
15098 * Get a value whether item is a separator or not.
15100 * @param item The toolbar item.
15101 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
15102 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
15104 * @see elm_toolbar_item_separator_set() for details.
15108 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15111 * Set the shrink state of toolbar @p obj.
15113 * @param obj The toolbar object.
15114 * @param shrink_mode Toolbar's items display behavior.
15116 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
15117 * but will enforce a minimun size so all the items will fit, won't scroll
15118 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
15119 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
15120 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
15124 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
15127 * Get the shrink mode of toolbar @p obj.
15129 * @param obj The toolbar object.
15130 * @return Toolbar's items display behavior.
15132 * @see elm_toolbar_mode_shrink_set() for details.
15136 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15139 * Enable/disable homogenous mode.
15141 * @param obj The toolbar object
15142 * @param homogeneous Assume the items within the toolbar are of the
15143 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15145 * This will enable the homogeneous mode where items are of the same size.
15146 * @see elm_toolbar_homogeneous_get()
15150 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
15153 * Get whether the homogenous mode is enabled.
15155 * @param obj The toolbar object.
15156 * @return Assume the items within the toolbar are of the same height
15157 * and width (EINA_TRUE = on, EINA_FALSE = off).
15159 * @see elm_toolbar_homogeneous_set()
15163 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15166 * Enable/disable homogenous mode.
15168 * @param obj The toolbar object
15169 * @param homogeneous Assume the items within the toolbar are of the
15170 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15172 * This will enable the homogeneous mode where items are of the same size.
15173 * @see elm_toolbar_homogeneous_get()
15175 * @deprecated use elm_toolbar_homogeneous_set() instead.
15179 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
15182 * Get whether the homogenous mode is enabled.
15184 * @param obj The toolbar object.
15185 * @return Assume the items within the toolbar are of the same height
15186 * and width (EINA_TRUE = on, EINA_FALSE = off).
15188 * @see elm_toolbar_homogeneous_set()
15189 * @deprecated use elm_toolbar_homogeneous_get() instead.
15193 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15196 * Set the parent object of the toolbar items' menus.
15198 * @param obj The toolbar object.
15199 * @param parent The parent of the menu objects.
15201 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
15203 * For more details about setting the parent for toolbar menus, see
15204 * elm_menu_parent_set().
15206 * @see elm_menu_parent_set() for details.
15207 * @see elm_toolbar_item_menu_set() for details.
15211 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15214 * Get the parent object of the toolbar items' menus.
15216 * @param obj The toolbar object.
15217 * @return The parent of the menu objects.
15219 * @see elm_toolbar_menu_parent_set() for details.
15223 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15226 * Set the alignment of the items.
15228 * @param obj The toolbar object.
15229 * @param align The new alignment, a float between <tt> 0.0 </tt>
15230 * and <tt> 1.0 </tt>.
15232 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
15233 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
15236 * Centered items by default.
15238 * @see elm_toolbar_align_get()
15242 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
15245 * Get the alignment of the items.
15247 * @param obj The toolbar object.
15248 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
15251 * @see elm_toolbar_align_set() for details.
15255 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15258 * Set whether the toolbar item opens a menu.
15260 * @param item The toolbar item.
15261 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
15263 * A toolbar item can be set to be a menu, using this function.
15265 * Once it is set to be a menu, it can be manipulated through the
15266 * menu-like function elm_toolbar_menu_parent_set() and the other
15267 * elm_menu functions, using the Evas_Object @c menu returned by
15268 * elm_toolbar_item_menu_get().
15270 * So, items to be displayed in this item's menu should be added with
15271 * elm_menu_item_add().
15273 * The following code exemplifies the most basic usage:
15275 * tb = elm_toolbar_add(win)
15276 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
15277 * elm_toolbar_item_menu_set(item, EINA_TRUE);
15278 * elm_toolbar_menu_parent_set(tb, win);
15279 * menu = elm_toolbar_item_menu_get(item);
15280 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
15281 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
15285 * @see elm_toolbar_item_menu_get()
15289 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
15292 * Get toolbar item's menu.
15294 * @param item The toolbar item.
15295 * @return Item's menu object or @c NULL on failure.
15297 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
15298 * this function will set it.
15300 * @see elm_toolbar_item_menu_set() for details.
15304 EAPI Evas_Object *elm_toolbar_item_menu_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15307 * Add a new state to @p item.
15309 * @param item The item.
15310 * @param icon A string with icon name or the absolute path of an image file.
15311 * @param label The label of the new state.
15312 * @param func The function to call when the item is clicked when this
15313 * state is selected.
15314 * @param data The data to associate with the state.
15315 * @return The toolbar item state, or @c NULL upon failure.
15317 * Toolbar will load icon image from fdo or current theme.
15318 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15319 * If an absolute path is provided it will load it direct from a file.
15321 * States created with this function can be removed with
15322 * elm_toolbar_item_state_del().
15324 * @see elm_toolbar_item_state_del()
15325 * @see elm_toolbar_item_state_sel()
15326 * @see elm_toolbar_item_state_get()
15330 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);
15333 * Delete a previoulsy added state to @p item.
15335 * @param item The toolbar item.
15336 * @param state The state to be deleted.
15337 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15339 * @see elm_toolbar_item_state_add()
15341 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15344 * Set @p state as the current state of @p it.
15346 * @param it The item.
15347 * @param state The state to use.
15348 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15350 * If @p state is @c NULL, it won't select any state and the default item's
15351 * icon and label will be used. It's the same behaviour than
15352 * elm_toolbar_item_state_unser().
15354 * @see elm_toolbar_item_state_unset()
15358 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15361 * Unset the state of @p it.
15363 * @param it The item.
15365 * The default icon and label from this item will be displayed.
15367 * @see elm_toolbar_item_state_set() for more details.
15371 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15374 * Get the current state of @p it.
15376 * @param item The item.
15377 * @return The selected state or @c NULL if none is selected or on failure.
15379 * @see elm_toolbar_item_state_set() for details.
15380 * @see elm_toolbar_item_state_unset()
15381 * @see elm_toolbar_item_state_add()
15385 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15388 * Get the state after selected state in toolbar's @p item.
15390 * @param it The toolbar item to change state.
15391 * @return The state after current state, or @c NULL on failure.
15393 * If last state is selected, this function will return first state.
15395 * @see elm_toolbar_item_state_set()
15396 * @see elm_toolbar_item_state_add()
15400 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15403 * Get the state before selected state in toolbar's @p item.
15405 * @param it The toolbar item to change state.
15406 * @return The state before current state, or @c NULL on failure.
15408 * If first state is selected, this function will return last state.
15410 * @see elm_toolbar_item_state_set()
15411 * @see elm_toolbar_item_state_add()
15415 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15418 * Set the text to be shown in a given toolbar item's tooltips.
15420 * @param item Target item.
15421 * @param text The text to set in the content.
15423 * Setup the text as tooltip to object. The item can have only one tooltip,
15424 * so any previous tooltip data - set with this function or
15425 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
15427 * @see elm_object_tooltip_text_set() for more details.
15431 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
15434 * Set the content to be shown in the tooltip item.
15436 * Setup the tooltip to item. The item can have only one tooltip,
15437 * so any previous tooltip data is removed. @p func(with @p data) will
15438 * be called every time that need show the tooltip and it should
15439 * return a valid Evas_Object. This object is then managed fully by
15440 * tooltip system and is deleted when the tooltip is gone.
15442 * @param item the toolbar item being attached a tooltip.
15443 * @param func the function used to create the tooltip contents.
15444 * @param data what to provide to @a func as callback data/context.
15445 * @param del_cb called when data is not needed anymore, either when
15446 * another callback replaces @a func, the tooltip is unset with
15447 * elm_toolbar_item_tooltip_unset() or the owner @a item
15448 * dies. This callback receives as the first parameter the
15449 * given @a data, and @c event_info is the item.
15451 * @see elm_object_tooltip_content_cb_set() for more details.
15455 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);
15458 * Unset tooltip from item.
15460 * @param item toolbar item to remove previously set tooltip.
15462 * Remove tooltip from item. The callback provided as del_cb to
15463 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
15464 * it is not used anymore.
15466 * @see elm_object_tooltip_unset() for more details.
15467 * @see elm_toolbar_item_tooltip_content_cb_set()
15471 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15474 * Sets a different style for this item tooltip.
15476 * @note before you set a style you should define a tooltip with
15477 * elm_toolbar_item_tooltip_content_cb_set() or
15478 * elm_toolbar_item_tooltip_text_set()
15480 * @param item toolbar item with tooltip already set.
15481 * @param style the theme style to use (default, transparent, ...)
15483 * @see elm_object_tooltip_style_set() for more details.
15487 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15490 * Get the style for this item tooltip.
15492 * @param item toolbar item with tooltip already set.
15493 * @return style the theme style in use, defaults to "default". If the
15494 * object does not have a tooltip set, then NULL is returned.
15496 * @see elm_object_tooltip_style_get() for more details.
15497 * @see elm_toolbar_item_tooltip_style_set()
15501 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15504 * Set the type of mouse pointer/cursor decoration to be shown,
15505 * when the mouse pointer is over the given toolbar widget item
15507 * @param item toolbar item to customize cursor on
15508 * @param cursor the cursor type's name
15510 * This function works analogously as elm_object_cursor_set(), but
15511 * here the cursor's changing area is restricted to the item's
15512 * area, and not the whole widget's. Note that that item cursors
15513 * have precedence over widget cursors, so that a mouse over an
15514 * item with custom cursor set will always show @b that cursor.
15516 * If this function is called twice for an object, a previously set
15517 * cursor will be unset on the second call.
15519 * @see elm_object_cursor_set()
15520 * @see elm_toolbar_item_cursor_get()
15521 * @see elm_toolbar_item_cursor_unset()
15525 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15528 * Get the type of mouse pointer/cursor decoration set to be shown,
15529 * when the mouse pointer is over the given toolbar widget item
15531 * @param item toolbar item with custom cursor set
15532 * @return the cursor type's name or @c NULL, if no custom cursors
15533 * were set to @p item (and on errors)
15535 * @see elm_object_cursor_get()
15536 * @see elm_toolbar_item_cursor_set()
15537 * @see elm_toolbar_item_cursor_unset()
15541 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15544 * Unset any custom mouse pointer/cursor decoration set to be
15545 * shown, when the mouse pointer is over the given toolbar widget
15546 * item, thus making it show the @b default cursor again.
15548 * @param item a toolbar item
15550 * Use this call to undo any custom settings on this item's cursor
15551 * decoration, bringing it back to defaults (no custom style set).
15553 * @see elm_object_cursor_unset()
15554 * @see elm_toolbar_item_cursor_set()
15558 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15561 * Set a different @b style for a given custom cursor set for a
15564 * @param item toolbar item with custom cursor set
15565 * @param style the <b>theme style</b> to use (e.g. @c "default",
15566 * @c "transparent", etc)
15568 * This function only makes sense when one is using custom mouse
15569 * cursor decorations <b>defined in a theme file</b>, which can have,
15570 * given a cursor name/type, <b>alternate styles</b> on it. It
15571 * works analogously as elm_object_cursor_style_set(), but here
15572 * applyed only to toolbar item objects.
15574 * @warning Before you set a cursor style you should have definen a
15575 * custom cursor previously on the item, with
15576 * elm_toolbar_item_cursor_set()
15578 * @see elm_toolbar_item_cursor_engine_only_set()
15579 * @see elm_toolbar_item_cursor_style_get()
15583 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15586 * Get the current @b style set for a given toolbar item's custom
15589 * @param item toolbar item with custom cursor set.
15590 * @return style the cursor style in use. If the object does not
15591 * have a cursor set, then @c NULL is returned.
15593 * @see elm_toolbar_item_cursor_style_set() for more details
15597 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15600 * Set if the (custom)cursor for a given toolbar item should be
15601 * searched in its theme, also, or should only rely on the
15602 * rendering engine.
15604 * @param item item with custom (custom) cursor already set on
15605 * @param engine_only Use @c EINA_TRUE to have cursors looked for
15606 * only on those provided by the rendering engine, @c EINA_FALSE to
15607 * have them searched on the widget's theme, as well.
15609 * @note This call is of use only if you've set a custom cursor
15610 * for toolbar items, with elm_toolbar_item_cursor_set().
15612 * @note By default, cursors will only be looked for between those
15613 * provided by the rendering engine.
15617 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15620 * Get if the (custom) cursor for a given toolbar item is being
15621 * searched in its theme, also, or is only relying on the rendering
15624 * @param item a toolbar item
15625 * @return @c EINA_TRUE, if cursors are being looked for only on
15626 * those provided by the rendering engine, @c EINA_FALSE if they
15627 * are being searched on the widget's theme, as well.
15629 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
15633 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15636 * Change a toolbar's orientation
15637 * @param obj The toolbar object
15638 * @param vertical If @c EINA_TRUE, the toolbar is vertical
15639 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15641 * @deprecated use elm_toolbar_horizontal_set() instead.
15643 EINA_DEPRECATED EAPI void elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
15646 * Change a toolbar's orientation
15647 * @param obj The toolbar object
15648 * @param horizontal If @c EINA_TRUE, the toolbar is horizontal
15649 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15652 EAPI void elm_toolbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15655 * Get a toolbar's orientation
15656 * @param obj The toolbar object
15657 * @return If @c EINA_TRUE, the toolbar is vertical
15658 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15660 * @deprecated use elm_toolbar_horizontal_get() instead.
15662 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_orientation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15665 * Get a toolbar's orientation
15666 * @param obj The toolbar object
15667 * @return If @c EINA_TRUE, the toolbar is horizontal
15668 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15671 EAPI Eina_Bool elm_toolbar_horizontal_get(const Evas_Object *obj);
15677 * @defgroup Tooltips Tooltips
15679 * The Tooltip is an (internal, for now) smart object used to show a
15680 * content in a frame on mouse hover of objects(or widgets), with
15681 * tips/information about them.
15686 EAPI double elm_tooltip_delay_get(void);
15687 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
15688 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
15689 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
15690 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
15691 EAPI void elm_object_tooltip_domain_translatable_text_set(Evas_Object *obj, const char *domain, const char *text) EINA_ARG_NONNULL(1, 3);
15692 #define elm_object_tooltip_translatable_text_set(obj, text) elm_object_tooltip_domain_translatable_text_set((obj), NULL, (text))
15693 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);
15694 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15695 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15696 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15697 EAPI Eina_Bool elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
15698 EAPI Eina_Bool elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
15705 * @defgroup Cursors Cursors
15707 * The Elementary cursor is an internal smart object used to
15708 * customize the mouse cursor displayed over objects (or
15709 * widgets). In the most common scenario, the cursor decoration
15710 * comes from the graphical @b engine Elementary is running
15711 * on. Those engines may provide different decorations for cursors,
15712 * and Elementary provides functions to choose them (think of X11
15713 * cursors, as an example).
15715 * There's also the possibility of, besides using engine provided
15716 * cursors, also use ones coming from Edje theming files. Both
15717 * globally and per widget, Elementary makes it possible for one to
15718 * make the cursors lookup to be held on engines only or on
15719 * Elementary's theme file, too. To set cursor's hot spot,
15720 * two data items should be added to cursor's theme: "hot_x" and
15721 * "hot_y", that are the offset from upper-left corner of the cursor
15722 * (coordinates 0,0).
15728 * Set the cursor to be shown when mouse is over the object
15730 * Set the cursor that will be displayed when mouse is over the
15731 * object. The object can have only one cursor set to it, so if
15732 * this function is called twice for an object, the previous set
15734 * If using X cursors, a definition of all the valid cursor names
15735 * is listed on Elementary_Cursors.h. If an invalid name is set
15736 * the default cursor will be used.
15738 * @param obj the object being set a cursor.
15739 * @param cursor the cursor name to be used.
15743 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
15746 * Get the cursor to be shown when mouse is over the object
15748 * @param obj an object with cursor already set.
15749 * @return the cursor name.
15753 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15756 * Unset cursor for object
15758 * Unset cursor for object, and set the cursor to default if the mouse
15759 * was over this object.
15761 * @param obj Target object
15762 * @see elm_object_cursor_set()
15766 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15769 * Sets a different style for this object cursor.
15771 * @note before you set a style you should define a cursor with
15772 * elm_object_cursor_set()
15774 * @param obj an object with cursor already set.
15775 * @param style the theme style to use (default, transparent, ...)
15779 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15782 * Get the style for this object cursor.
15784 * @param obj an object with cursor already set.
15785 * @return style the theme style in use, defaults to "default". If the
15786 * object does not have a cursor set, then NULL is returned.
15790 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15793 * Set if the cursor set should be searched on the theme or should use
15794 * the provided by the engine, only.
15796 * @note before you set if should look on theme you should define a cursor
15797 * with elm_object_cursor_set(). By default it will only look for cursors
15798 * provided by the engine.
15800 * @param obj an object with cursor already set.
15801 * @param engine_only boolean to define it cursors should be looked only
15802 * between the provided by the engine or searched on widget's theme as well.
15806 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15809 * Get the cursor engine only usage for this object cursor.
15811 * @param obj an object with cursor already set.
15812 * @return engine_only boolean to define it cursors should be
15813 * looked only between the provided by the engine or searched on
15814 * widget's theme as well. If the object does not have a cursor
15815 * set, then EINA_FALSE is returned.
15819 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15822 * Get the configured cursor engine only usage
15824 * This gets the globally configured exclusive usage of engine cursors.
15826 * @return 1 if only engine cursors should be used
15829 EAPI int elm_cursor_engine_only_get(void);
15832 * Set the configured cursor engine only usage
15834 * This sets the globally configured exclusive usage of engine cursors.
15835 * It won't affect cursors set before changing this value.
15837 * @param engine_only If 1 only engine cursors will be enabled, if 0 will
15838 * look for them on theme before.
15839 * @return EINA_TRUE if value is valid and setted (0 or 1)
15842 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
15849 * @defgroup Menu Menu
15851 * @image html img/widget/menu/preview-00.png
15852 * @image latex img/widget/menu/preview-00.eps
15854 * A menu is a list of items displayed above its parent. When the menu is
15855 * showing its parent is darkened. Each item can have a sub-menu. The menu
15856 * object can be used to display a menu on a right click event, in a toolbar,
15859 * Signals that you can add callbacks for are:
15860 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
15861 * event_info is NULL.
15863 * @see @ref tutorial_menu
15866 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
15868 * @brief Add a new menu to the parent
15870 * @param parent The parent object.
15871 * @return The new object or NULL if it cannot be created.
15873 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15875 * @brief Set the parent for the given menu widget
15877 * @param obj The menu object.
15878 * @param parent The new parent.
15880 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15882 * @brief Get the parent for the given menu widget
15884 * @param obj The menu object.
15885 * @return The parent.
15887 * @see elm_menu_parent_set()
15889 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15891 * @brief Move the menu to a new position
15893 * @param obj The menu object.
15894 * @param x The new position.
15895 * @param y The new position.
15897 * Sets the top-left position of the menu to (@p x,@p y).
15899 * @note @p x and @p y coordinates are relative to parent.
15901 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
15903 * @brief Close a opened menu
15905 * @param obj the menu object
15908 * Hides the menu and all it's sub-menus.
15910 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
15912 * @brief Returns a list of @p item's items.
15914 * @param obj The menu object
15915 * @return An Eina_List* of @p item's items
15917 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15919 * @brief Get the Evas_Object of an Elm_Menu_Item
15921 * @param item The menu item object.
15922 * @return The edje object containing the swallowed content
15924 * @warning Don't manipulate this object!
15926 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15928 * @brief Add an item at the end of the given menu widget
15930 * @param obj The menu object.
15931 * @param parent The parent menu item (optional)
15932 * @param icon A icon display on the item. The icon will be destryed by the menu.
15933 * @param label The label of the item.
15934 * @param func Function called when the user select the item.
15935 * @param data Data sent by the callback.
15936 * @return Returns the new item.
15938 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);
15940 * @brief Add an object swallowed in an item at the end of the given menu
15943 * @param obj The menu object.
15944 * @param parent The parent menu item (optional)
15945 * @param subobj The object to swallow
15946 * @param func Function called when the user select the item.
15947 * @param data Data sent by the callback.
15948 * @return Returns the new item.
15950 * Add an evas object as an item to the menu.
15952 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);
15954 * @brief Set the label of a menu item
15956 * @param item The menu item object.
15957 * @param label The label to set for @p item
15959 * @warning Don't use this funcion on items created with
15960 * elm_menu_item_add_object() or elm_menu_item_separator_add().
15962 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
15964 * @brief Get the label of a menu item
15966 * @param item The menu item object.
15967 * @return The label of @p item
15969 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15971 * @brief Set the icon of a menu item to the standard icon with name @p icon
15973 * @param item The menu item object.
15974 * @param icon The icon object to set for the content of @p item
15976 * Once this icon is set, any previously set icon will be deleted.
15978 EAPI void elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
15980 * @brief Get the string representation from the icon of a menu item
15982 * @param item The menu item object.
15983 * @return The string representation of @p item's icon or NULL
15985 * @see elm_menu_item_object_icon_name_set()
15987 EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15989 * @brief Set the content object of a menu item
15991 * @param item The menu item object
15992 * @param The content object or NULL
15993 * @return EINA_TRUE on success, else EINA_FALSE
15995 * Use this function to change the object swallowed by a menu item, deleting
15996 * any previously swallowed object.
15998 EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
16000 * @brief Get the content object of a menu item
16002 * @param item The menu item object
16003 * @return The content object or NULL
16004 * @note If @p item was added with elm_menu_item_add_object, this
16005 * function will return the object passed, else it will return the
16008 * @see elm_menu_item_object_content_set()
16010 EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16012 * @brief Set the selected state of @p item.
16014 * @param item The menu item object.
16015 * @param selected The selected/unselected state of the item
16017 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16019 * @brief Get the selected state of @p item.
16021 * @param item The menu item object.
16022 * @return The selected/unselected state of the item
16024 * @see elm_menu_item_selected_set()
16026 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16028 * @brief Set the disabled state of @p item.
16030 * @param item The menu item object.
16031 * @param disabled The enabled/disabled state of the item
16033 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
16035 * @brief Get the disabled state of @p item.
16037 * @param item The menu item object.
16038 * @return The enabled/disabled state of the item
16040 * @see elm_menu_item_disabled_set()
16042 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16044 * @brief Add a separator item to menu @p obj under @p parent.
16046 * @param obj The menu object
16047 * @param parent The item to add the separator under
16048 * @return The created item or NULL on failure
16050 * This is item is a @ref Separator.
16052 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
16054 * @brief Returns whether @p item is a separator.
16056 * @param item The item to check
16057 * @return If true, @p item is a separator
16059 * @see elm_menu_item_separator_add()
16061 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16063 * @brief Deletes an item from the menu.
16065 * @param item The item to delete.
16067 * @see elm_menu_item_add()
16069 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16071 * @brief Set the function called when a menu item is deleted.
16073 * @param item The item to set the callback on
16074 * @param func The function called
16076 * @see elm_menu_item_add()
16077 * @see elm_menu_item_del()
16079 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16081 * @brief Returns the data associated with menu item @p item.
16083 * @param item The item
16084 * @return The data associated with @p item or NULL if none was set.
16086 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
16088 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16090 * @brief Sets the data to be associated with menu item @p item.
16092 * @param item The item
16093 * @param data The data to be associated with @p item
16095 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
16097 * @brief Returns a list of @p item's subitems.
16099 * @param item The item
16100 * @return An Eina_List* of @p item's subitems
16102 * @see elm_menu_add()
16104 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16106 * @brief Get the position of a menu item
16108 * @param item The menu item
16109 * @return The item's index
16111 * This function returns the index position of a menu item in a menu.
16112 * For a sub-menu, this number is relative to the first item in the sub-menu.
16114 * @note Index values begin with 0
16116 EAPI unsigned int elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
16118 * @brief @brief Return a menu item's owner menu
16120 * @param item The menu item
16121 * @return The menu object owning @p item, or NULL on failure
16123 * Use this function to get the menu object owning an item.
16125 EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
16127 * @brief Get the selected item in the menu
16129 * @param obj The menu object
16130 * @return The selected item, or NULL if none
16132 * @see elm_menu_item_selected_get()
16133 * @see elm_menu_item_selected_set()
16135 EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16137 * @brief Get the last item in the menu
16139 * @param obj The menu object
16140 * @return The last item, or NULL if none
16142 EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16144 * @brief Get the first item in the menu
16146 * @param obj The menu object
16147 * @return The first item, or NULL if none
16149 EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16151 * @brief Get the next item in the menu.
16153 * @param item The menu item object.
16154 * @return The item after it, or NULL if none
16156 EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16158 * @brief Get the previous item in the menu.
16160 * @param item The menu item object.
16161 * @return The item before it, or NULL if none
16163 EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16169 * @defgroup List List
16170 * @ingroup Elementary
16172 * @image html img/widget/list/preview-00.png
16173 * @image latex img/widget/list/preview-00.eps width=\textwidth
16175 * @image html img/list.png
16176 * @image latex img/list.eps width=\textwidth
16178 * A list widget is a container whose children are displayed vertically or
16179 * horizontally, in order, and can be selected.
16180 * The list can accept only one or multiple items selection. Also has many
16181 * modes of items displaying.
16183 * A list is a very simple type of list widget. For more robust
16184 * lists, @ref Genlist should probably be used.
16186 * Smart callbacks one can listen to:
16187 * - @c "activated" - The user has double-clicked or pressed
16188 * (enter|return|spacebar) on an item. The @c event_info parameter
16189 * is the item that was activated.
16190 * - @c "clicked,double" - The user has double-clicked an item.
16191 * The @c event_info parameter is the item that was double-clicked.
16192 * - "selected" - when the user selected an item
16193 * - "unselected" - when the user unselected an item
16194 * - "longpressed" - an item in the list is long-pressed
16195 * - "edge,top" - the list is scrolled until the top edge
16196 * - "edge,bottom" - the list is scrolled until the bottom edge
16197 * - "edge,left" - the list is scrolled until the left edge
16198 * - "edge,right" - the list is scrolled until the right edge
16199 * - "language,changed" - the program's language changed
16201 * Available styles for it:
16204 * List of examples:
16205 * @li @ref list_example_01
16206 * @li @ref list_example_02
16207 * @li @ref list_example_03
16216 * @enum _Elm_List_Mode
16217 * @typedef Elm_List_Mode
16219 * Set list's resize behavior, transverse axis scroll and
16220 * items cropping. See each mode's description for more details.
16222 * @note Default value is #ELM_LIST_SCROLL.
16224 * Values <b> don't </b> work as bitmask, only one can be choosen.
16226 * @see elm_list_mode_set()
16227 * @see elm_list_mode_get()
16231 typedef enum _Elm_List_Mode
16233 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. */
16234 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). */
16235 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. */
16236 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. */
16237 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
16240 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(). */
16243 * Add a new list widget to the given parent Elementary
16244 * (container) object.
16246 * @param parent The parent object.
16247 * @return a new list widget handle or @c NULL, on errors.
16249 * This function inserts a new list widget on the canvas.
16253 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16258 * @param obj The list object
16260 * @note Call before running show() on the list object.
16261 * @warning If not called, it won't display the list properly.
16264 * li = elm_list_add(win);
16265 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
16266 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
16268 * evas_object_show(li);
16273 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
16276 * Enable or disable multiple items selection on the list object.
16278 * @param obj The list object
16279 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
16282 * Disabled by default. If disabled, the user can select a single item of
16283 * the list each time. Selected items are highlighted on list.
16284 * If enabled, many items can be selected.
16286 * If a selected item is selected again, it will be unselected.
16288 * @see elm_list_multi_select_get()
16292 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
16295 * Get a value whether multiple items selection is enabled or not.
16297 * @see elm_list_multi_select_set() for details.
16299 * @param obj The list object.
16300 * @return @c EINA_TRUE means multiple items selection is enabled.
16301 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16302 * @c EINA_FALSE is returned.
16306 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16309 * Set which mode to use for the list object.
16311 * @param obj The list object
16312 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16313 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
16315 * Set list's resize behavior, transverse axis scroll and
16316 * items cropping. See each mode's description for more details.
16318 * @note Default value is #ELM_LIST_SCROLL.
16320 * Only one can be set, if a previous one was set, it will be changed
16321 * by the new mode set. Bitmask won't work as well.
16323 * @see elm_list_mode_get()
16327 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16330 * Get the mode the list is at.
16332 * @param obj The list object
16333 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16334 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
16336 * @note see elm_list_mode_set() for more information.
16340 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16343 * Enable or disable horizontal mode on the list object.
16345 * @param obj The list object.
16346 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
16347 * disable it, i.e., to enable vertical mode.
16349 * @note Vertical mode is set by default.
16351 * On horizontal mode items are displayed on list from left to right,
16352 * instead of from top to bottom. Also, the list will scroll horizontally.
16353 * Each item will presents left icon on top and right icon, or end, at
16356 * @see elm_list_horizontal_get()
16360 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16363 * Get a value whether horizontal mode is enabled or not.
16365 * @param obj The list object.
16366 * @return @c EINA_TRUE means horizontal mode selection is enabled.
16367 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16368 * @c EINA_FALSE is returned.
16370 * @see elm_list_horizontal_set() for details.
16374 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16377 * Enable or disable always select mode on the list object.
16379 * @param obj The list object
16380 * @param always_select @c EINA_TRUE to enable always select mode or
16381 * @c EINA_FALSE to disable it.
16383 * @note Always select mode is disabled by default.
16385 * Default behavior of list items is to only call its callback function
16386 * the first time it's pressed, i.e., when it is selected. If a selected
16387 * item is pressed again, and multi-select is disabled, it won't call
16388 * this function (if multi-select is enabled it will unselect the item).
16390 * If always select is enabled, it will call the callback function
16391 * everytime a item is pressed, so it will call when the item is selected,
16392 * and again when a selected item is pressed.
16394 * @see elm_list_always_select_mode_get()
16395 * @see elm_list_multi_select_set()
16399 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16402 * Get a value whether always select mode is enabled or not, meaning that
16403 * an item will always call its callback function, even if already selected.
16405 * @param obj The list object
16406 * @return @c EINA_TRUE means horizontal mode selection is enabled.
16407 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16408 * @c EINA_FALSE is returned.
16410 * @see elm_list_always_select_mode_set() for details.
16414 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16417 * Set bouncing behaviour when the scrolled content reaches an edge.
16419 * Tell the internal scroller object whether it should bounce or not
16420 * when it reaches the respective edges for each axis.
16422 * @param obj The list object
16423 * @param h_bounce Whether to bounce or not in the horizontal axis.
16424 * @param v_bounce Whether to bounce or not in the vertical axis.
16426 * @see elm_scroller_bounce_set()
16430 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
16433 * Get the bouncing behaviour of the internal scroller.
16435 * Get whether the internal scroller should bounce when the edge of each
16436 * axis is reached scrolling.
16438 * @param obj The list object.
16439 * @param h_bounce Pointer where to store the bounce state of the horizontal
16441 * @param v_bounce Pointer where to store the bounce state of the vertical
16444 * @see elm_scroller_bounce_get()
16445 * @see elm_list_bounce_set()
16449 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
16452 * Set the scrollbar policy.
16454 * @param obj The list object
16455 * @param policy_h Horizontal scrollbar policy.
16456 * @param policy_v Vertical scrollbar policy.
16458 * This sets the scrollbar visibility policy for the given scroller.
16459 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
16460 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
16461 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
16462 * This applies respectively for the horizontal and vertical scrollbars.
16464 * The both are disabled by default, i.e., are set to
16465 * #ELM_SCROLLER_POLICY_OFF.
16469 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
16472 * Get the scrollbar policy.
16474 * @see elm_list_scroller_policy_get() for details.
16476 * @param obj The list object.
16477 * @param policy_h Pointer where to store horizontal scrollbar policy.
16478 * @param policy_v Pointer where to store vertical scrollbar policy.
16482 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);
16485 * Append a new item to the list object.
16487 * @param obj The list object.
16488 * @param label The label of the list item.
16489 * @param icon The icon object to use for the left side of the item. An
16490 * icon can be any Evas object, but usually it is an icon created
16491 * with elm_icon_add().
16492 * @param end The icon object to use for the right side of the item. An
16493 * icon can be any Evas object.
16494 * @param func The function to call when the item is clicked.
16495 * @param data The data to associate with the item for related callbacks.
16497 * @return The created item or @c NULL upon failure.
16499 * A new item will be created and appended to the list, i.e., will
16500 * be set as @b last item.
16502 * Items created with this method can be deleted with
16503 * elm_list_item_del().
16505 * Associated @p data can be properly freed when item is deleted if a
16506 * callback function is set with elm_list_item_del_cb_set().
16508 * If a function is passed as argument, it will be called everytime this item
16509 * is selected, i.e., the user clicks over an unselected item.
16510 * If always select is enabled it will call this function every time
16511 * user clicks over an item (already selected or not).
16512 * If such function isn't needed, just passing
16513 * @c NULL as @p func is enough. The same should be done for @p data.
16515 * Simple example (with no function callback or data associated):
16517 * li = elm_list_add(win);
16518 * ic = elm_icon_add(win);
16519 * elm_icon_file_set(ic, "path/to/image", NULL);
16520 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
16521 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
16523 * evas_object_show(li);
16526 * @see elm_list_always_select_mode_set()
16527 * @see elm_list_item_del()
16528 * @see elm_list_item_del_cb_set()
16529 * @see elm_list_clear()
16530 * @see elm_icon_add()
16534 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);
16537 * Prepend a new item to the list object.
16539 * @param obj The list object.
16540 * @param label The label of the list item.
16541 * @param icon The icon object to use for the left side of the item. An
16542 * icon can be any Evas object, but usually it is an icon created
16543 * with elm_icon_add().
16544 * @param end The icon object to use for the right side of the item. An
16545 * icon can be any Evas object.
16546 * @param func The function to call when the item is clicked.
16547 * @param data The data to associate with the item for related callbacks.
16549 * @return The created item or @c NULL upon failure.
16551 * A new item will be created and prepended to the list, i.e., will
16552 * be set as @b first item.
16554 * Items created with this method can be deleted with
16555 * elm_list_item_del().
16557 * Associated @p data can be properly freed when item is deleted if a
16558 * callback function is set with elm_list_item_del_cb_set().
16560 * If a function is passed as argument, it will be called everytime this item
16561 * is selected, i.e., the user clicks over an unselected item.
16562 * If always select is enabled it will call this function every time
16563 * user clicks over an item (already selected or not).
16564 * If such function isn't needed, just passing
16565 * @c NULL as @p func is enough. The same should be done for @p data.
16567 * @see elm_list_item_append() for a simple code example.
16568 * @see elm_list_always_select_mode_set()
16569 * @see elm_list_item_del()
16570 * @see elm_list_item_del_cb_set()
16571 * @see elm_list_clear()
16572 * @see elm_icon_add()
16576 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);
16579 * Insert a new item into the list object before item @p before.
16581 * @param obj The list object.
16582 * @param before The list item to insert before.
16583 * @param label The label of the list item.
16584 * @param icon The icon object to use for the left side of the item. An
16585 * icon can be any Evas object, but usually it is an icon created
16586 * with elm_icon_add().
16587 * @param end The icon object to use for the right side of the item. An
16588 * icon can be any Evas object.
16589 * @param func The function to call when the item is clicked.
16590 * @param data The data to associate with the item for related callbacks.
16592 * @return The created item or @c NULL upon failure.
16594 * A new item will be created and added to the list. Its position in
16595 * this list will be just before item @p before.
16597 * Items created with this method can be deleted with
16598 * elm_list_item_del().
16600 * Associated @p data can be properly freed when item is deleted if a
16601 * callback function is set with elm_list_item_del_cb_set().
16603 * If a function is passed as argument, it will be called everytime this item
16604 * is selected, i.e., the user clicks over an unselected item.
16605 * If always select is enabled it will call this function every time
16606 * user clicks over an item (already selected or not).
16607 * If such function isn't needed, just passing
16608 * @c NULL as @p func is enough. The same should be done for @p data.
16610 * @see elm_list_item_append() for a simple code example.
16611 * @see elm_list_always_select_mode_set()
16612 * @see elm_list_item_del()
16613 * @see elm_list_item_del_cb_set()
16614 * @see elm_list_clear()
16615 * @see elm_icon_add()
16619 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);
16622 * Insert a new item into the list object after item @p after.
16624 * @param obj The list object.
16625 * @param after The list item to insert after.
16626 * @param label The label of the list item.
16627 * @param icon The icon object to use for the left side of the item. An
16628 * icon can be any Evas object, but usually it is an icon created
16629 * with elm_icon_add().
16630 * @param end The icon object to use for the right side of the item. An
16631 * icon can be any Evas object.
16632 * @param func The function to call when the item is clicked.
16633 * @param data The data to associate with the item for related callbacks.
16635 * @return The created item or @c NULL upon failure.
16637 * A new item will be created and added to the list. Its position in
16638 * this list will be just after item @p after.
16640 * Items created with this method can be deleted with
16641 * elm_list_item_del().
16643 * Associated @p data can be properly freed when item is deleted if a
16644 * callback function is set with elm_list_item_del_cb_set().
16646 * If a function is passed as argument, it will be called everytime this item
16647 * is selected, i.e., the user clicks over an unselected item.
16648 * If always select is enabled it will call this function every time
16649 * user clicks over an item (already selected or not).
16650 * If such function isn't needed, just passing
16651 * @c NULL as @p func is enough. The same should be done for @p data.
16653 * @see elm_list_item_append() for a simple code example.
16654 * @see elm_list_always_select_mode_set()
16655 * @see elm_list_item_del()
16656 * @see elm_list_item_del_cb_set()
16657 * @see elm_list_clear()
16658 * @see elm_icon_add()
16662 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);
16665 * Insert a new item into the sorted list object.
16667 * @param obj The list object.
16668 * @param label The label of the list item.
16669 * @param icon The icon object to use for the left side of the item. An
16670 * icon can be any Evas object, but usually it is an icon created
16671 * with elm_icon_add().
16672 * @param end The icon object to use for the right side of the item. An
16673 * icon can be any Evas object.
16674 * @param func The function to call when the item is clicked.
16675 * @param data The data to associate with the item for related callbacks.
16676 * @param cmp_func The comparing function to be used to sort list
16677 * items <b>by #Elm_List_Item item handles</b>. This function will
16678 * receive two items and compare them, returning a non-negative integer
16679 * if the second item should be place after the first, or negative value
16680 * if should be placed before.
16682 * @return The created item or @c NULL upon failure.
16684 * @note This function inserts values into a list object assuming it was
16685 * sorted and the result will be sorted.
16687 * A new item will be created and added to the list. Its position in
16688 * this list will be found comparing the new item with previously inserted
16689 * items using function @p cmp_func.
16691 * Items created with this method can be deleted with
16692 * elm_list_item_del().
16694 * Associated @p data can be properly freed when item is deleted if a
16695 * callback function is set with elm_list_item_del_cb_set().
16697 * If a function is passed as argument, it will be called everytime this item
16698 * is selected, i.e., the user clicks over an unselected item.
16699 * If always select is enabled it will call this function every time
16700 * user clicks over an item (already selected or not).
16701 * If such function isn't needed, just passing
16702 * @c NULL as @p func is enough. The same should be done for @p data.
16704 * @see elm_list_item_append() for a simple code example.
16705 * @see elm_list_always_select_mode_set()
16706 * @see elm_list_item_del()
16707 * @see elm_list_item_del_cb_set()
16708 * @see elm_list_clear()
16709 * @see elm_icon_add()
16713 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);
16716 * Remove all list's items.
16718 * @param obj The list object
16720 * @see elm_list_item_del()
16721 * @see elm_list_item_append()
16725 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16728 * Get a list of all the list items.
16730 * @param obj The list object
16731 * @return An @c Eina_List of list items, #Elm_List_Item,
16732 * or @c NULL on failure.
16734 * @see elm_list_item_append()
16735 * @see elm_list_item_del()
16736 * @see elm_list_clear()
16740 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16743 * Get the selected item.
16745 * @param obj The list object.
16746 * @return The selected list item.
16748 * The selected item can be unselected with function
16749 * elm_list_item_selected_set().
16751 * The selected item always will be highlighted on list.
16753 * @see elm_list_selected_items_get()
16757 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16760 * Return a list of the currently selected list items.
16762 * @param obj The list object.
16763 * @return An @c Eina_List of list items, #Elm_List_Item,
16764 * or @c NULL on failure.
16766 * Multiple items can be selected if multi select is enabled. It can be
16767 * done with elm_list_multi_select_set().
16769 * @see elm_list_selected_item_get()
16770 * @see elm_list_multi_select_set()
16774 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16777 * Set the selected state of an item.
16779 * @param item The list item
16780 * @param selected The selected state
16782 * This sets the selected state of the given item @p it.
16783 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
16785 * If a new item is selected the previosly selected will be unselected,
16786 * unless multiple selection is enabled with elm_list_multi_select_set().
16787 * Previoulsy selected item can be get with function
16788 * elm_list_selected_item_get().
16790 * Selected items will be highlighted.
16792 * @see elm_list_item_selected_get()
16793 * @see elm_list_selected_item_get()
16794 * @see elm_list_multi_select_set()
16798 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16801 * Get whether the @p item is selected or not.
16803 * @param item The list item.
16804 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
16805 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
16807 * @see elm_list_selected_item_set() for details.
16808 * @see elm_list_item_selected_get()
16812 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16815 * Set or unset item as a separator.
16817 * @param it The list item.
16818 * @param setting @c EINA_TRUE to set item @p it as separator or
16819 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
16821 * Items aren't set as separator by default.
16823 * If set as separator it will display separator theme, so won't display
16826 * @see elm_list_item_separator_get()
16830 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
16833 * Get a value whether item is a separator or not.
16835 * @see elm_list_item_separator_set() for details.
16837 * @param it The list item.
16838 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
16839 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
16843 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16846 * Show @p item in the list view.
16848 * @param item The list item to be shown.
16850 * It won't animate list until item is visible. If such behavior is wanted,
16851 * use elm_list_bring_in() intead.
16855 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16858 * Bring in the given item to list view.
16860 * @param item The item.
16862 * This causes list to jump to the given item @p item and show it
16863 * (by scrolling), if it is not fully visible.
16865 * This may use animation to do so and take a period of time.
16867 * If animation isn't wanted, elm_list_item_show() can be used.
16871 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16874 * Delete them item from the list.
16876 * @param item The item of list to be deleted.
16878 * If deleting all list items is required, elm_list_clear()
16879 * should be used instead of getting items list and deleting each one.
16881 * @see elm_list_clear()
16882 * @see elm_list_item_append()
16883 * @see elm_list_item_del_cb_set()
16887 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16890 * Set the function called when a list item is freed.
16892 * @param item The item to set the callback on
16893 * @param func The function called
16895 * If there is a @p func, then it will be called prior item's memory release.
16896 * That will be called with the following arguments:
16898 * @li item's Evas object;
16901 * This way, a data associated to a list item could be properly freed.
16905 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16908 * Get the data associated to the item.
16910 * @param item The list item
16911 * @return The data associated to @p item
16913 * The return value is a pointer to data associated to @p item when it was
16914 * created, with function elm_list_item_append() or similar. If no data
16915 * was passed as argument, it will return @c NULL.
16917 * @see elm_list_item_append()
16921 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16924 * Get the left side icon associated to the item.
16926 * @param item The list item
16927 * @return The left side icon associated to @p item
16929 * The return value is a pointer to the icon associated to @p item when
16931 * created, with function elm_list_item_append() or similar, or later
16932 * with function elm_list_item_icon_set(). If no icon
16933 * was passed as argument, it will return @c NULL.
16935 * @see elm_list_item_append()
16936 * @see elm_list_item_icon_set()
16940 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16943 * Set the left side icon associated to the item.
16945 * @param item The list item
16946 * @param icon The left side icon object to associate with @p item
16948 * The icon object to use at left side of the item. An
16949 * icon can be any Evas object, but usually it is an icon created
16950 * with elm_icon_add().
16952 * Once the icon object is set, a previously set one will be deleted.
16953 * @warning Setting the same icon for two items will cause the icon to
16954 * dissapear from the first item.
16956 * If an icon was passed as argument on item creation, with function
16957 * elm_list_item_append() or similar, it will be already
16958 * associated to the item.
16960 * @see elm_list_item_append()
16961 * @see elm_list_item_icon_get()
16965 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
16968 * Get the right side icon associated to the item.
16970 * @param item The list item
16971 * @return The right side icon associated to @p item
16973 * The return value is a pointer to the icon associated to @p item when
16975 * created, with function elm_list_item_append() or similar, or later
16976 * with function elm_list_item_icon_set(). If no icon
16977 * was passed as argument, it will return @c NULL.
16979 * @see elm_list_item_append()
16980 * @see elm_list_item_icon_set()
16984 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16987 * Set the right side icon associated to the item.
16989 * @param item The list item
16990 * @param end The right side icon object to associate with @p item
16992 * The icon object to use at right side of the item. An
16993 * icon can be any Evas object, but usually it is an icon created
16994 * with elm_icon_add().
16996 * Once the icon object is set, a previously set one will be deleted.
16997 * @warning Setting the same icon for two items will cause the icon to
16998 * dissapear from the first item.
17000 * If an icon was passed as argument on item creation, with function
17001 * elm_list_item_append() or similar, it will be already
17002 * associated to the item.
17004 * @see elm_list_item_append()
17005 * @see elm_list_item_end_get()
17009 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
17012 * Gets the base object of the item.
17014 * @param item The list item
17015 * @return The base object associated with @p item
17017 * Base object is the @c Evas_Object that represents that item.
17021 EAPI Evas_Object *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17022 EINA_DEPRECATED EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17025 * Get the label of item.
17027 * @param item The item of list.
17028 * @return The label of item.
17030 * The return value is a pointer to the label associated to @p item when
17031 * it was created, with function elm_list_item_append(), or later
17032 * with function elm_list_item_label_set. If no label
17033 * was passed as argument, it will return @c NULL.
17035 * @see elm_list_item_label_set() for more details.
17036 * @see elm_list_item_append()
17040 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17043 * Set the label of item.
17045 * @param item The item of list.
17046 * @param text The label of item.
17048 * The label to be displayed by the item.
17049 * Label will be placed between left and right side icons (if set).
17051 * If a label was passed as argument on item creation, with function
17052 * elm_list_item_append() or similar, it will be already
17053 * displayed by the item.
17055 * @see elm_list_item_label_get()
17056 * @see elm_list_item_append()
17060 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17064 * Get the item before @p it in list.
17066 * @param it The list item.
17067 * @return The item before @p it, or @c NULL if none or on failure.
17069 * @note If it is the first item, @c NULL will be returned.
17071 * @see elm_list_item_append()
17072 * @see elm_list_items_get()
17076 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17079 * Get the item after @p it in list.
17081 * @param it The list item.
17082 * @return The item after @p it, or @c NULL if none or on failure.
17084 * @note If it is the last item, @c NULL will be returned.
17086 * @see elm_list_item_append()
17087 * @see elm_list_items_get()
17091 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17094 * Sets the disabled/enabled state of a list item.
17096 * @param it The item.
17097 * @param disabled The disabled state.
17099 * A disabled item cannot be selected or unselected. It will also
17100 * change its appearance (generally greyed out). This sets the
17101 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
17106 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
17109 * Get a value whether list item is disabled or not.
17111 * @param it The item.
17112 * @return The disabled state.
17114 * @see elm_list_item_disabled_set() for more details.
17118 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17121 * Set the text to be shown in a given list item's tooltips.
17123 * @param item Target item.
17124 * @param text The text to set in the content.
17126 * Setup the text as tooltip to object. The item can have only one tooltip,
17127 * so any previous tooltip data - set with this function or
17128 * elm_list_item_tooltip_content_cb_set() - is removed.
17130 * @see elm_object_tooltip_text_set() for more details.
17134 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17138 * @brief Disable size restrictions on an object's tooltip
17139 * @param item The tooltip's anchor object
17140 * @param disable If EINA_TRUE, size restrictions are disabled
17141 * @return EINA_FALSE on failure, EINA_TRUE on success
17143 * This function allows a tooltip to expand beyond its parant window's canvas.
17144 * It will instead be limited only by the size of the display.
17146 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
17148 * @brief Retrieve size restriction state of an object's tooltip
17149 * @param obj The tooltip's anchor object
17150 * @return If EINA_TRUE, size restrictions are disabled
17152 * This function returns whether a tooltip is allowed to expand beyond
17153 * its parant window's canvas.
17154 * It will instead be limited only by the size of the display.
17156 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17159 * Set the content to be shown in the tooltip item.
17161 * Setup the tooltip to item. The item can have only one tooltip,
17162 * so any previous tooltip data is removed. @p func(with @p data) will
17163 * be called every time that need show the tooltip and it should
17164 * return a valid Evas_Object. This object is then managed fully by
17165 * tooltip system and is deleted when the tooltip is gone.
17167 * @param item the list item being attached a tooltip.
17168 * @param func the function used to create the tooltip contents.
17169 * @param data what to provide to @a func as callback data/context.
17170 * @param del_cb called when data is not needed anymore, either when
17171 * another callback replaces @a func, the tooltip is unset with
17172 * elm_list_item_tooltip_unset() or the owner @a item
17173 * dies. This callback receives as the first parameter the
17174 * given @a data, and @c event_info is the item.
17176 * @see elm_object_tooltip_content_cb_set() for more details.
17180 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);
17183 * Unset tooltip from item.
17185 * @param item list item to remove previously set tooltip.
17187 * Remove tooltip from item. The callback provided as del_cb to
17188 * elm_list_item_tooltip_content_cb_set() will be called to notify
17189 * it is not used anymore.
17191 * @see elm_object_tooltip_unset() for more details.
17192 * @see elm_list_item_tooltip_content_cb_set()
17196 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17199 * Sets a different style for this item tooltip.
17201 * @note before you set a style you should define a tooltip with
17202 * elm_list_item_tooltip_content_cb_set() or
17203 * elm_list_item_tooltip_text_set()
17205 * @param item list item with tooltip already set.
17206 * @param style the theme style to use (default, transparent, ...)
17208 * @see elm_object_tooltip_style_set() for more details.
17212 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17215 * Get the style for this item tooltip.
17217 * @param item list item with tooltip already set.
17218 * @return style the theme style in use, defaults to "default". If the
17219 * object does not have a tooltip set, then NULL is returned.
17221 * @see elm_object_tooltip_style_get() for more details.
17222 * @see elm_list_item_tooltip_style_set()
17226 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17229 * Set the type of mouse pointer/cursor decoration to be shown,
17230 * when the mouse pointer is over the given list widget item
17232 * @param item list item to customize cursor on
17233 * @param cursor the cursor type's name
17235 * This function works analogously as elm_object_cursor_set(), but
17236 * here the cursor's changing area is restricted to the item's
17237 * area, and not the whole widget's. Note that that item cursors
17238 * have precedence over widget cursors, so that a mouse over an
17239 * item with custom cursor set will always show @b that cursor.
17241 * If this function is called twice for an object, a previously set
17242 * cursor will be unset on the second call.
17244 * @see elm_object_cursor_set()
17245 * @see elm_list_item_cursor_get()
17246 * @see elm_list_item_cursor_unset()
17250 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
17253 * Get the type of mouse pointer/cursor decoration set to be shown,
17254 * when the mouse pointer is over the given list widget item
17256 * @param item list item with custom cursor set
17257 * @return the cursor type's name or @c NULL, if no custom cursors
17258 * were set to @p item (and on errors)
17260 * @see elm_object_cursor_get()
17261 * @see elm_list_item_cursor_set()
17262 * @see elm_list_item_cursor_unset()
17266 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17269 * Unset any custom mouse pointer/cursor decoration set to be
17270 * shown, when the mouse pointer is over the given list widget
17271 * item, thus making it show the @b default cursor again.
17273 * @param item a list item
17275 * Use this call to undo any custom settings on this item's cursor
17276 * decoration, bringing it back to defaults (no custom style set).
17278 * @see elm_object_cursor_unset()
17279 * @see elm_list_item_cursor_set()
17283 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17286 * Set a different @b style for a given custom cursor set for a
17289 * @param item list item with custom cursor set
17290 * @param style the <b>theme style</b> to use (e.g. @c "default",
17291 * @c "transparent", etc)
17293 * This function only makes sense when one is using custom mouse
17294 * cursor decorations <b>defined in a theme file</b>, which can have,
17295 * given a cursor name/type, <b>alternate styles</b> on it. It
17296 * works analogously as elm_object_cursor_style_set(), but here
17297 * applyed only to list item objects.
17299 * @warning Before you set a cursor style you should have definen a
17300 * custom cursor previously on the item, with
17301 * elm_list_item_cursor_set()
17303 * @see elm_list_item_cursor_engine_only_set()
17304 * @see elm_list_item_cursor_style_get()
17308 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17311 * Get the current @b style set for a given list item's custom
17314 * @param item list item with custom cursor set.
17315 * @return style the cursor style in use. If the object does not
17316 * have a cursor set, then @c NULL is returned.
17318 * @see elm_list_item_cursor_style_set() for more details
17322 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17325 * Set if the (custom)cursor for a given list item should be
17326 * searched in its theme, also, or should only rely on the
17327 * rendering engine.
17329 * @param item item with custom (custom) cursor already set on
17330 * @param engine_only Use @c EINA_TRUE to have cursors looked for
17331 * only on those provided by the rendering engine, @c EINA_FALSE to
17332 * have them searched on the widget's theme, as well.
17334 * @note This call is of use only if you've set a custom cursor
17335 * for list items, with elm_list_item_cursor_set().
17337 * @note By default, cursors will only be looked for between those
17338 * provided by the rendering engine.
17342 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
17345 * Get if the (custom) cursor for a given list item is being
17346 * searched in its theme, also, or is only relying on the rendering
17349 * @param item a list item
17350 * @return @c EINA_TRUE, if cursors are being looked for only on
17351 * those provided by the rendering engine, @c EINA_FALSE if they
17352 * are being searched on the widget's theme, as well.
17354 * @see elm_list_item_cursor_engine_only_set(), for more details
17358 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17365 * @defgroup Slider Slider
17366 * @ingroup Elementary
17368 * @image html img/widget/slider/preview-00.png
17369 * @image latex img/widget/slider/preview-00.eps width=\textwidth
17371 * The slider adds a dragable āsliderā widget for selecting the value of
17372 * something within a range.
17374 * A slider can be horizontal or vertical. It can contain an Icon and has a
17375 * primary label as well as a units label (that is formatted with floating
17376 * point values and thus accepts a printf-style format string, like
17377 * ā%1.2f unitsā. There is also an indicator string that may be somewhere
17378 * else (like on the slider itself) that also accepts a format string like
17379 * units. Label, Icon Unit and Indicator strings/objects are optional.
17381 * A slider may be inverted which means values invert, with high vales being
17382 * on the left or top and low values on the right or bottom (as opposed to
17383 * normally being low on the left or top and high on the bottom and right).
17385 * The slider should have its minimum and maximum values set by the
17386 * application with elm_slider_min_max_set() and value should also be set by
17387 * the application before use with elm_slider_value_set(). The span of the
17388 * slider is its length (horizontally or vertically). This will be scaled by
17389 * the object or applications scaling factor. At any point code can query the
17390 * slider for its value with elm_slider_value_get().
17392 * Smart callbacks one can listen to:
17393 * - "changed" - Whenever the slider value is changed by the user.
17394 * - "slider,drag,start" - dragging the slider indicator around has started.
17395 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
17396 * - "delay,changed" - A short time after the value is changed by the user.
17397 * This will be called only when the user stops dragging for
17398 * a very short period or when they release their
17399 * finger/mouse, so it avoids possibly expensive reactions to
17400 * the value change.
17402 * Available styles for it:
17405 * Default contents parts of the slider widget that you can use for are:
17406 * @li "elm.swallow.icon" - A icon of the slider
17407 * @li "elm.swallow.end" - A end part content of the slider
17409 * Here is an example on its usage:
17410 * @li @ref slider_example
17413 #define ELM_SLIDER_CONTENT_ICON "elm.swallow.icon"
17414 #define ELM_SLIDER_CONTENT_END "elm.swallow.end"
17417 * @addtogroup Slider
17422 * Add a new slider widget to the given parent Elementary
17423 * (container) object.
17425 * @param parent The parent object.
17426 * @return a new slider widget handle or @c NULL, on errors.
17428 * This function inserts a new slider widget on the canvas.
17432 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17435 * Set the label of a given slider widget
17437 * @param obj The progress bar object
17438 * @param label The text label string, in UTF-8
17441 * @deprecated use elm_object_text_set() instead.
17443 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17446 * Get the label of a given slider widget
17448 * @param obj The progressbar object
17449 * @return The text label string, in UTF-8
17452 * @deprecated use elm_object_text_get() instead.
17454 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17457 * Set the icon object of the slider object.
17459 * @param obj The slider object.
17460 * @param icon The icon object.
17462 * On horizontal mode, icon is placed at left, and on vertical mode,
17465 * @note Once the icon object is set, a previously set one will be deleted.
17466 * If you want to keep that old content object, use the
17467 * elm_slider_icon_unset() function.
17469 * @warning If the object being set does not have minimum size hints set,
17470 * it won't get properly displayed.
17473 * @deprecated use elm_object_content_set() instead.
17475 EINA_DEPRECATED EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17478 * Unset an icon set on a given slider widget.
17480 * @param obj The slider object.
17481 * @return The icon object that was being used, if any was set, or
17482 * @c NULL, otherwise (and on errors).
17484 * On horizontal mode, icon is placed at left, and on vertical mode,
17487 * This call will unparent and return the icon object which was set
17488 * for this widget, previously, on success.
17490 * @see elm_slider_icon_set() for more details
17491 * @see elm_slider_icon_get()
17492 * @deprecated use elm_object_content_unset() instead.
17496 EINA_DEPRECATED EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17499 * Retrieve the icon object set for a given slider widget.
17501 * @param obj The slider object.
17502 * @return The icon object's handle, if @p obj had one set, or @c NULL,
17503 * otherwise (and on errors).
17505 * On horizontal mode, icon is placed at left, and on vertical mode,
17508 * @see elm_slider_icon_set() for more details
17509 * @see elm_slider_icon_unset()
17511 * @deprecated use elm_object_content_set() instead.
17515 EINA_DEPRECATED EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17518 * Set the end object of the slider object.
17520 * @param obj The slider object.
17521 * @param end The end object.
17523 * On horizontal mode, end is placed at left, and on vertical mode,
17524 * placed at bottom.
17526 * @note Once the icon object is set, a previously set one will be deleted.
17527 * If you want to keep that old content object, use the
17528 * elm_slider_end_unset() function.
17530 * @warning If the object being set does not have minimum size hints set,
17531 * it won't get properly displayed.
17533 * @deprecated use elm_object_content_part_set(obj, "elm.swallow.end", end) instead.
17537 EINA_DEPRECATED EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
17540 * Unset an end object set on a given slider widget.
17542 * @param obj The slider object.
17543 * @return The end object that was being used, if any was set, or
17544 * @c NULL, otherwise (and on errors).
17546 * On horizontal mode, end is placed at left, and on vertical mode,
17547 * placed at bottom.
17549 * This call will unparent and return the icon object which was set
17550 * for this widget, previously, on success.
17552 * @see elm_slider_end_set() for more details.
17553 * @see elm_slider_end_get()
17555 * @deprecated use elm_object_content_part_unset(obj, "elm.swallow.end") instead.
17559 EINA_DEPRECATED EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17562 * Retrieve the end object set for a given slider widget.
17564 * @param obj The slider object.
17565 * @return The end object's handle, if @p obj had one set, or @c NULL,
17566 * otherwise (and on errors).
17568 * On horizontal mode, icon is placed at right, and on vertical mode,
17569 * placed at bottom.
17571 * @see elm_slider_end_set() for more details.
17572 * @see elm_slider_end_unset()
17576 EINA_DEPRECATED EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17579 * Set the (exact) length of the bar region of a given slider widget.
17581 * @param obj The slider object.
17582 * @param size The length of the slider's bar region.
17584 * This sets the minimum width (when in horizontal mode) or height
17585 * (when in vertical mode) of the actual bar area of the slider
17586 * @p obj. This in turn affects the object's minimum size. Use
17587 * this when you're not setting other size hints expanding on the
17588 * given direction (like weight and alignment hints) and you would
17589 * like it to have a specific size.
17591 * @note Icon, end, label, indicator and unit text around @p obj
17592 * will require their
17593 * own space, which will make @p obj to require more the @p size,
17596 * @see elm_slider_span_size_get()
17600 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17603 * Get the length set for the bar region of a given slider widget
17605 * @param obj The slider object.
17606 * @return The length of the slider's bar region.
17608 * If that size was not set previously, with
17609 * elm_slider_span_size_set(), this call will return @c 0.
17613 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17616 * Set the format string for the unit label.
17618 * @param obj The slider object.
17619 * @param format The format string for the unit display.
17621 * Unit label is displayed all the time, if set, after slider's bar.
17622 * In horizontal mode, at right and in vertical mode, at bottom.
17624 * If @c NULL, unit label won't be visible. If not it sets the format
17625 * string for the label text. To the label text is provided a floating point
17626 * value, so the label text can display up to 1 floating point value.
17627 * Note that this is optional.
17629 * Use a format string such as "%1.2f meters" for example, and it will
17630 * display values like: "3.14 meters" for a value equal to 3.14159.
17632 * Default is unit label disabled.
17634 * @see elm_slider_indicator_format_get()
17638 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17641 * Get the unit label format of the slider.
17643 * @param obj The slider object.
17644 * @return The unit label format string in UTF-8.
17646 * Unit label is displayed all the time, if set, after slider's bar.
17647 * In horizontal mode, at right and in vertical mode, at bottom.
17649 * @see elm_slider_unit_format_set() for more
17650 * information on how this works.
17654 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17657 * Set the format string for the indicator label.
17659 * @param obj The slider object.
17660 * @param indicator The format string for the indicator display.
17662 * The slider may display its value somewhere else then unit label,
17663 * for example, above the slider knob that is dragged around. This function
17664 * sets the format string used for this.
17666 * If @c NULL, indicator label won't be visible. If not it sets the format
17667 * string for the label text. To the label text is provided a floating point
17668 * value, so the label text can display up to 1 floating point value.
17669 * Note that this is optional.
17671 * Use a format string such as "%1.2f meters" for example, and it will
17672 * display values like: "3.14 meters" for a value equal to 3.14159.
17674 * Default is indicator label disabled.
17676 * @see elm_slider_indicator_format_get()
17680 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
17683 * Get the indicator label format of the slider.
17685 * @param obj The slider object.
17686 * @return The indicator label format string in UTF-8.
17688 * The slider may display its value somewhere else then unit label,
17689 * for example, above the slider knob that is dragged around. This function
17690 * gets the format string used for this.
17692 * @see elm_slider_indicator_format_set() for more
17693 * information on how this works.
17697 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17700 * Set the format function pointer for the indicator label
17702 * @param obj The slider object.
17703 * @param func The indicator format function.
17704 * @param free_func The freeing function for the format string.
17706 * Set the callback function to format the indicator string.
17708 * @see elm_slider_indicator_format_set() for more info on how this works.
17712 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);
17715 * Set the format function pointer for the units label
17717 * @param obj The slider object.
17718 * @param func The units format function.
17719 * @param free_func The freeing function for the format string.
17721 * Set the callback function to format the indicator string.
17723 * @see elm_slider_units_format_set() for more info on how this works.
17727 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);
17730 * Set the orientation of a given slider widget.
17732 * @param obj The slider object.
17733 * @param horizontal Use @c EINA_TRUE to make @p obj to be
17734 * @b horizontal, @c EINA_FALSE to make it @b vertical.
17736 * Use this function to change how your slider is to be
17737 * disposed: vertically or horizontally.
17739 * By default it's displayed horizontally.
17741 * @see elm_slider_horizontal_get()
17745 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17748 * Retrieve the orientation of a given slider widget
17750 * @param obj The slider object.
17751 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17752 * @c EINA_FALSE if it's @b vertical (and on errors).
17754 * @see elm_slider_horizontal_set() for more details.
17758 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17761 * Set the minimum and maximum values for the slider.
17763 * @param obj The slider object.
17764 * @param min The minimum value.
17765 * @param max The maximum value.
17767 * Define the allowed range of values to be selected by the user.
17769 * If actual value is less than @p min, it will be updated to @p min. If it
17770 * is bigger then @p max, will be updated to @p max. Actual value can be
17771 * get with elm_slider_value_get().
17773 * By default, min is equal to 0.0, and max is equal to 1.0.
17775 * @warning Maximum must be greater than minimum, otherwise behavior
17778 * @see elm_slider_min_max_get()
17782 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17785 * Get the minimum and maximum values of the slider.
17787 * @param obj The slider object.
17788 * @param min Pointer where to store the minimum value.
17789 * @param max Pointer where to store the maximum value.
17791 * @note If only one value is needed, the other pointer can be passed
17794 * @see elm_slider_min_max_set() for details.
17798 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17801 * Set the value the slider displays.
17803 * @param obj The slider object.
17804 * @param val The value to be displayed.
17806 * Value will be presented on the unit label following format specified with
17807 * elm_slider_unit_format_set() and on indicator with
17808 * elm_slider_indicator_format_set().
17810 * @warning The value must to be between min and max values. This values
17811 * are set by elm_slider_min_max_set().
17813 * @see elm_slider_value_get()
17814 * @see elm_slider_unit_format_set()
17815 * @see elm_slider_indicator_format_set()
17816 * @see elm_slider_min_max_set()
17820 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17823 * Get the value displayed by the spinner.
17825 * @param obj The spinner object.
17826 * @return The value displayed.
17828 * @see elm_spinner_value_set() for details.
17832 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17835 * Invert a given slider widget's displaying values order
17837 * @param obj The slider object.
17838 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17839 * @c EINA_FALSE to bring it back to default, non-inverted values.
17841 * A slider may be @b inverted, in which state it gets its
17842 * values inverted, with high vales being on the left or top and
17843 * low values on the right or bottom, as opposed to normally have
17844 * the low values on the former and high values on the latter,
17845 * respectively, for horizontal and vertical modes.
17847 * @see elm_slider_inverted_get()
17851 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
17854 * Get whether a given slider widget's displaying values are
17857 * @param obj The slider object.
17858 * @return @c EINA_TRUE, if @p obj has inverted values,
17859 * @c EINA_FALSE otherwise (and on errors).
17861 * @see elm_slider_inverted_set() for more details.
17865 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17868 * Set whether to enlarge slider indicator (augmented knob) or not.
17870 * @param obj The slider object.
17871 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
17872 * let the knob always at default size.
17874 * By default, indicator will be bigger while dragged by the user.
17876 * @warning It won't display values set with
17877 * elm_slider_indicator_format_set() if you disable indicator.
17881 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
17884 * Get whether a given slider widget's enlarging indicator or not.
17886 * @param obj The slider object.
17887 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
17888 * @c EINA_FALSE otherwise (and on errors).
17890 * @see elm_slider_indicator_show_set() for details.
17894 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17901 * @addtogroup Actionslider Actionslider
17903 * @image html img/widget/actionslider/preview-00.png
17904 * @image latex img/widget/actionslider/preview-00.eps
17906 * An actionslider is a switcher for 2 or 3 labels with customizable magnet
17907 * properties. The user drags and releases the indicator, to choose a label.
17909 * Labels occupy the following positions.
17914 * Positions can be enabled or disabled.
17916 * Magnets can be set on the above positions.
17918 * When the indicator is released, it will move to its nearest "enabled and magnetized" position.
17920 * @note By default all positions are set as enabled.
17922 * Signals that you can add callbacks for are:
17924 * "selected" - when user selects an enabled position (the label is passed
17927 * "pos_changed" - when the indicator reaches any of the positions("left",
17928 * "right" or "center").
17930 * See an example of actionslider usage @ref actionslider_example_page "here"
17933 typedef enum _Elm_Actionslider_Pos
17935 ELM_ACTIONSLIDER_NONE = 0,
17936 ELM_ACTIONSLIDER_LEFT = 1 << 0,
17937 ELM_ACTIONSLIDER_CENTER = 1 << 1,
17938 ELM_ACTIONSLIDER_RIGHT = 1 << 2,
17939 ELM_ACTIONSLIDER_ALL = (1 << 3) -1
17940 } Elm_Actionslider_Pos;
17943 * Add a new actionslider to the parent.
17945 * @param parent The parent object
17946 * @return The new actionslider object or NULL if it cannot be created
17948 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17950 * Set actionslider labels.
17952 * @param obj The actionslider object
17953 * @param left_label The label to be set on the left.
17954 * @param center_label The label to be set on the center.
17955 * @param right_label The label to be set on the right.
17956 * @deprecated use elm_object_text_set() instead.
17958 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);
17960 * Get actionslider labels.
17962 * @param obj The actionslider object
17963 * @param left_label A char** to place the left_label of @p obj into.
17964 * @param center_label A char** to place the center_label of @p obj into.
17965 * @param right_label A char** to place the right_label of @p obj into.
17966 * @deprecated use elm_object_text_set() instead.
17968 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);
17970 * Get actionslider selected label.
17972 * @param obj The actionslider object
17973 * @return The selected label
17975 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17977 * Set actionslider indicator position.
17979 * @param obj The actionslider object.
17980 * @param pos The position of the indicator.
17982 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
17984 * Get actionslider indicator position.
17986 * @param obj The actionslider object.
17987 * @return The position of the indicator.
17989 EAPI Elm_Actionslider_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17991 * Set actionslider magnet position. To make multiple positions magnets @c or
17992 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
17994 * @param obj The actionslider object.
17995 * @param pos Bit mask indicating the magnet positions.
17997 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
17999 * Get actionslider magnet position.
18001 * @param obj The actionslider object.
18002 * @return The positions with magnet property.
18004 EAPI Elm_Actionslider_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18006 * Set actionslider enabled position. To set multiple positions as enabled @c or
18007 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
18009 * @note All the positions are enabled by default.
18011 * @param obj The actionslider object.
18012 * @param pos Bit mask indicating the enabled positions.
18014 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
18016 * Get actionslider enabled position.
18018 * @param obj The actionslider object.
18019 * @return The enabled positions.
18021 EAPI Elm_Actionslider_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18023 * Set the label used on the indicator.
18025 * @param obj The actionslider object
18026 * @param label The label to be set on the indicator.
18027 * @deprecated use elm_object_text_set() instead.
18029 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18031 * Get the label used on the indicator object.
18033 * @param obj The actionslider object
18034 * @return The indicator label
18035 * @deprecated use elm_object_text_get() instead.
18037 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
18043 * @defgroup Genlist Genlist
18045 * @image html img/widget/genlist/preview-00.png
18046 * @image latex img/widget/genlist/preview-00.eps
18047 * @image html img/genlist.png
18048 * @image latex img/genlist.eps
18050 * This widget aims to have more expansive list than the simple list in
18051 * Elementary that could have more flexible items and allow many more entries
18052 * while still being fast and low on memory usage. At the same time it was
18053 * also made to be able to do tree structures. But the price to pay is more
18054 * complexity when it comes to usage. If all you want is a simple list with
18055 * icons and a single label, use the normal @ref List object.
18057 * Genlist has a fairly large API, mostly because it's relatively complex,
18058 * trying to be both expansive, powerful and efficient. First we will begin
18059 * an overview on the theory behind genlist.
18061 * @section Genlist_Item_Class Genlist item classes - creating items
18063 * In order to have the ability to add and delete items on the fly, genlist
18064 * implements a class (callback) system where the application provides a
18065 * structure with information about that type of item (genlist may contain
18066 * multiple different items with different classes, states and styles).
18067 * Genlist will call the functions in this struct (methods) when an item is
18068 * "realized" (i.e., created dynamically, while the user is scrolling the
18069 * grid). All objects will simply be deleted when no longer needed with
18070 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
18071 * following members:
18072 * - @c item_style - This is a constant string and simply defines the name
18073 * of the item style. It @b must be specified and the default should be @c
18076 * - @c func - A struct with pointers to functions that will be called when
18077 * an item is going to be actually created. All of them receive a @c data
18078 * parameter that will point to the same data passed to
18079 * elm_genlist_item_append() and related item creation functions, and a @c
18080 * obj parameter that points to the genlist object itself.
18082 * The function pointers inside @c func are @c label_get, @c icon_get, @c
18083 * state_get and @c del. The 3 first functions also receive a @c part
18084 * parameter described below. A brief description of these functions follows:
18086 * - @c label_get - The @c part parameter is the name string of one of the
18087 * existing text parts in the Edje group implementing the item's theme.
18088 * This function @b must return a strdup'()ed string, as the caller will
18089 * free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
18090 * - @c content_get - The @c part parameter is the name string of one of the
18091 * existing (content) swallow parts in the Edje group implementing the item's
18092 * theme. It must return @c NULL, when no content is desired, or a valid
18093 * object handle, otherwise. The object will be deleted by the genlist on
18094 * its deletion or when the item is "unrealized". See
18095 * #Elm_Genlist_Item_Icon_Get_Cb.
18096 * - @c func.state_get - The @c part parameter is the name string of one of
18097 * the state parts in the Edje group implementing the item's theme. Return
18098 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
18099 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
18100 * and @c "elm" as "emission" and "source" arguments, respectively, when
18101 * the state is true (the default is false), where @c XXX is the name of
18102 * the (state) part. See #Elm_Genlist_Item_State_Get_Cb.
18103 * - @c func.del - This is intended for use when genlist items are deleted,
18104 * so any data attached to the item (e.g. its data parameter on creation)
18105 * can be deleted. See #Elm_Genlist_Item_Del_Cb.
18107 * available item styles:
18109 * - default_style - The text part is a textblock
18111 * @image html img/widget/genlist/preview-04.png
18112 * @image latex img/widget/genlist/preview-04.eps
18116 * @image html img/widget/genlist/preview-01.png
18117 * @image latex img/widget/genlist/preview-01.eps
18119 * - icon_top_text_bottom
18121 * @image html img/widget/genlist/preview-02.png
18122 * @image latex img/widget/genlist/preview-02.eps
18126 * @image html img/widget/genlist/preview-03.png
18127 * @image latex img/widget/genlist/preview-03.eps
18129 * @section Genlist_Items Structure of items
18131 * An item in a genlist can have 0 or more text labels (they can be regular
18132 * text or textblock Evas objects - that's up to the style to determine), 0
18133 * or more contents (which are simply objects swallowed into the genlist item's
18134 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
18135 * behavior left to the user to define. The Edje part names for each of
18136 * these properties will be looked up, in the theme file for the genlist,
18137 * under the Edje (string) data items named @c "labels", @c "contents" and @c
18138 * "states", respectively. For each of those properties, if more than one
18139 * part is provided, they must have names listed separated by spaces in the
18140 * data fields. For the default genlist item theme, we have @b one label
18141 * part (@c "elm.text"), @b two content parts (@c "elm.swalllow.icon" and @c
18142 * "elm.swallow.end") and @b no state parts.
18144 * A genlist item may be at one of several styles. Elementary provides one
18145 * by default - "default", but this can be extended by system or application
18146 * custom themes/overlays/extensions (see @ref Theme "themes" for more
18149 * @section Genlist_Manipulation Editing and Navigating
18151 * Items can be added by several calls. All of them return a @ref
18152 * Elm_Genlist_Item handle that is an internal member inside the genlist.
18153 * They all take a data parameter that is meant to be used for a handle to
18154 * the applications internal data (eg the struct with the original item
18155 * data). The parent parameter is the parent genlist item this belongs to if
18156 * it is a tree or an indexed group, and NULL if there is no parent. The
18157 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
18158 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
18159 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
18160 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
18161 * is set then this item is group index item that is displayed at the top
18162 * until the next group comes. The func parameter is a convenience callback
18163 * that is called when the item is selected and the data parameter will be
18164 * the func_data parameter, obj be the genlist object and event_info will be
18165 * the genlist item.
18167 * elm_genlist_item_append() adds an item to the end of the list, or if
18168 * there is a parent, to the end of all the child items of the parent.
18169 * elm_genlist_item_prepend() is the same but adds to the beginning of
18170 * the list or children list. elm_genlist_item_insert_before() inserts at
18171 * item before another item and elm_genlist_item_insert_after() inserts after
18172 * the indicated item.
18174 * The application can clear the list with elm_genlist_clear() which deletes
18175 * all the items in the list and elm_genlist_item_del() will delete a specific
18176 * item. elm_genlist_item_subitems_clear() will clear all items that are
18177 * children of the indicated parent item.
18179 * To help inspect list items you can jump to the item at the top of the list
18180 * with elm_genlist_first_item_get() which will return the item pointer, and
18181 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
18182 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
18183 * and previous items respectively relative to the indicated item. Using
18184 * these calls you can walk the entire item list/tree. Note that as a tree
18185 * the items are flattened in the list, so elm_genlist_item_parent_get() will
18186 * let you know which item is the parent (and thus know how to skip them if
18189 * @section Genlist_Muti_Selection Multi-selection
18191 * If the application wants multiple items to be able to be selected,
18192 * elm_genlist_multi_select_set() can enable this. If the list is
18193 * single-selection only (the default), then elm_genlist_selected_item_get()
18194 * will return the selected item, if any, or NULL I none is selected. If the
18195 * list is multi-select then elm_genlist_selected_items_get() will return a
18196 * list (that is only valid as long as no items are modified (added, deleted,
18197 * selected or unselected)).
18199 * @section Genlist_Usage_Hints Usage hints
18201 * There are also convenience functions. elm_genlist_item_genlist_get() will
18202 * return the genlist object the item belongs to. elm_genlist_item_show()
18203 * will make the scroller scroll to show that specific item so its visible.
18204 * elm_genlist_item_data_get() returns the data pointer set by the item
18205 * creation functions.
18207 * If an item changes (state of boolean changes, label or contents change),
18208 * then use elm_genlist_item_update() to have genlist update the item with
18209 * the new state. Genlist will re-realize the item thus call the functions
18210 * in the _Elm_Genlist_Item_Class for that item.
18212 * To programmatically (un)select an item use elm_genlist_item_selected_set().
18213 * To get its selected state use elm_genlist_item_selected_get(). Similarly
18214 * to expand/contract an item and get its expanded state, use
18215 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
18216 * again to make an item disabled (unable to be selected and appear
18217 * differently) use elm_genlist_item_disabled_set() to set this and
18218 * elm_genlist_item_disabled_get() to get the disabled state.
18220 * In general to indicate how the genlist should expand items horizontally to
18221 * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
18222 * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
18223 * mode means that if items are too wide to fit, the scroller will scroll
18224 * horizontally. Otherwise items are expanded to fill the width of the
18225 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
18226 * to the viewport width and limited to that size. This can be combined with
18227 * a different style that uses edjes' ellipsis feature (cutting text off like
18230 * Items will only call their selection func and callback when first becoming
18231 * selected. Any further clicks will do nothing, unless you enable always
18232 * select with elm_genlist_always_select_mode_set(). This means even if
18233 * selected, every click will make the selected callbacks be called.
18234 * elm_genlist_no_select_mode_set() will turn off the ability to select
18235 * items entirely and they will neither appear selected nor call selected
18236 * callback functions.
18238 * Remember that you can create new styles and add your own theme augmentation
18239 * per application with elm_theme_extension_add(). If you absolutely must
18240 * have a specific style that overrides any theme the user or system sets up
18241 * you can use elm_theme_overlay_add() to add such a file.
18243 * @section Genlist_Implementation Implementation
18245 * Evas tracks every object you create. Every time it processes an event
18246 * (mouse move, down, up etc.) it needs to walk through objects and find out
18247 * what event that affects. Even worse every time it renders display updates,
18248 * in order to just calculate what to re-draw, it needs to walk through many
18249 * many many objects. Thus, the more objects you keep active, the more
18250 * overhead Evas has in just doing its work. It is advisable to keep your
18251 * active objects to the minimum working set you need. Also remember that
18252 * object creation and deletion carries an overhead, so there is a
18253 * middle-ground, which is not easily determined. But don't keep massive lists
18254 * of objects you can't see or use. Genlist does this with list objects. It
18255 * creates and destroys them dynamically as you scroll around. It groups them
18256 * into blocks so it can determine the visibility etc. of a whole block at
18257 * once as opposed to having to walk the whole list. This 2-level list allows
18258 * for very large numbers of items to be in the list (tests have used up to
18259 * 2,000,000 items). Also genlist employs a queue for adding items. As items
18260 * may be different sizes, every item added needs to be calculated as to its
18261 * size and thus this presents a lot of overhead on populating the list, this
18262 * genlist employs a queue. Any item added is queued and spooled off over
18263 * time, actually appearing some time later, so if your list has many members
18264 * you may find it takes a while for them to all appear, with your process
18265 * consuming a lot of CPU while it is busy spooling.
18267 * Genlist also implements a tree structure, but it does so with callbacks to
18268 * the application, with the application filling in tree structures when
18269 * requested (allowing for efficient building of a very deep tree that could
18270 * even be used for file-management). See the above smart signal callbacks for
18273 * @section Genlist_Smart_Events Genlist smart events
18275 * Signals that you can add callbacks for are:
18276 * - @c "activated" - The user has double-clicked or pressed
18277 * (enter|return|spacebar) on an item. The @c event_info parameter is the
18278 * item that was activated.
18279 * - @c "clicked,double" - The user has double-clicked an item. The @c
18280 * event_info parameter is the item that was double-clicked.
18281 * - @c "selected" - This is called when a user has made an item selected.
18282 * The event_info parameter is the genlist item that was selected.
18283 * - @c "unselected" - This is called when a user has made an item
18284 * unselected. The event_info parameter is the genlist item that was
18286 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
18287 * called and the item is now meant to be expanded. The event_info
18288 * parameter is the genlist item that was indicated to expand. It is the
18289 * job of this callback to then fill in the child items.
18290 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
18291 * called and the item is now meant to be contracted. The event_info
18292 * parameter is the genlist item that was indicated to contract. It is the
18293 * job of this callback to then delete the child items.
18294 * - @c "expand,request" - This is called when a user has indicated they want
18295 * to expand a tree branch item. The callback should decide if the item can
18296 * expand (has any children) and then call elm_genlist_item_expanded_set()
18297 * appropriately to set the state. The event_info parameter is the genlist
18298 * item that was indicated to expand.
18299 * - @c "contract,request" - This is called when a user has indicated they
18300 * want to contract a tree branch item. The callback should decide if the
18301 * item can contract (has any children) and then call
18302 * elm_genlist_item_expanded_set() appropriately to set the state. The
18303 * event_info parameter is the genlist item that was indicated to contract.
18304 * - @c "realized" - This is called when the item in the list is created as a
18305 * real evas object. event_info parameter is the genlist item that was
18306 * created. The object may be deleted at any time, so it is up to the
18307 * caller to not use the object pointer from elm_genlist_item_object_get()
18308 * in a way where it may point to freed objects.
18309 * - @c "unrealized" - This is called just before an item is unrealized.
18310 * After this call content objects provided will be deleted and the item
18311 * object itself delete or be put into a floating cache.
18312 * - @c "drag,start,up" - This is called when the item in the list has been
18313 * dragged (not scrolled) up.
18314 * - @c "drag,start,down" - This is called when the item in the list has been
18315 * dragged (not scrolled) down.
18316 * - @c "drag,start,left" - This is called when the item in the list has been
18317 * dragged (not scrolled) left.
18318 * - @c "drag,start,right" - This is called when the item in the list has
18319 * been dragged (not scrolled) right.
18320 * - @c "drag,stop" - This is called when the item in the list has stopped
18322 * - @c "drag" - This is called when the item in the list is being dragged.
18323 * - @c "longpressed" - This is called when the item is pressed for a certain
18324 * amount of time. By default it's 1 second.
18325 * - @c "scroll,anim,start" - This is called when scrolling animation has
18327 * - @c "scroll,anim,stop" - This is called when scrolling animation has
18329 * - @c "scroll,drag,start" - This is called when dragging the content has
18331 * - @c "scroll,drag,stop" - This is called when dragging the content has
18333 * - @c "edge,top" - This is called when the genlist is scrolled until
18335 * - @c "edge,bottom" - This is called when the genlist is scrolled
18336 * until the bottom edge.
18337 * - @c "edge,left" - This is called when the genlist is scrolled
18338 * until the left edge.
18339 * - @c "edge,right" - This is called when the genlist is scrolled
18340 * until the right edge.
18341 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
18343 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
18345 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
18347 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
18349 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
18350 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
18351 * multi-touch pinched in.
18352 * - @c "swipe" - This is called when the genlist is swiped.
18353 * - @c "moved" - This is called when a genlist item is moved.
18354 * - @c "language,changed" - This is called when the program's language is
18357 * @section Genlist_Examples Examples
18359 * Here is a list of examples that use the genlist, trying to show some of
18360 * its capabilities:
18361 * - @ref genlist_example_01
18362 * - @ref genlist_example_02
18363 * - @ref genlist_example_03
18364 * - @ref genlist_example_04
18365 * - @ref genlist_example_05
18369 * @addtogroup Genlist
18374 * @enum _Elm_Genlist_Item_Flags
18375 * @typedef Elm_Genlist_Item_Flags
18377 * Defines if the item is of any special type (has subitems or it's the
18378 * index of a group), or is just a simple item.
18382 typedef enum _Elm_Genlist_Item_Flags
18384 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
18385 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
18386 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
18387 } Elm_Genlist_Item_Flags;
18388 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
18389 #define Elm_Genlist_Item_Class Elm_Gen_Item_Class
18390 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18391 #define Elm_Genlist_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18392 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
18393 typedef char *(*Elm_Genlist_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
18394 typedef Evas_Object *(*Elm_Genlist_Item_Content_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Content (swallowed object) fetching class function for genlist item classes. */
18395 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. */
18396 typedef void (*Elm_Genlist_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
18399 * @struct _Elm_Genlist_Item_Class
18401 * Genlist item class definition structs.
18403 * This struct contains the style and fetching functions that will define the
18404 * contents of each item.
18406 * @see @ref Genlist_Item_Class
18408 struct _Elm_Genlist_Item_Class
18410 const char *item_style; /**< style of this class. */
18411 struct Elm_Genlist_Item_Class_Func
18413 Elm_Genlist_Item_Label_Get_Cb label_get; /**< Label fetching class function for genlist item classes.*/
18414 Elm_Genlist_Item_Content_Get_Cb content_get; /**< Content fetching class function for genlist item classes. */
18415 Elm_Genlist_Item_State_Get_Cb state_get; /**< State fetching class function for genlist item classes. */
18416 Elm_Genlist_Item_Del_Cb del; /**< Deletion class function for genlist item classes. */
18419 #define Elm_Genlist_Item_Class_Func Elm_Gen_Item_Class_Func
18421 * Add a new genlist widget to the given parent Elementary
18422 * (container) object
18424 * @param parent The parent object
18425 * @return a new genlist widget handle or @c NULL, on errors
18427 * This function inserts a new genlist widget on the canvas.
18429 * @see elm_genlist_item_append()
18430 * @see elm_genlist_item_del()
18431 * @see elm_genlist_clear()
18435 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18437 * Remove all items from a given genlist widget.
18439 * @param obj The genlist object
18441 * This removes (and deletes) all items in @p obj, leaving it empty.
18443 * @see elm_genlist_item_del(), to remove just one item.
18447 EINA_DEPRECATED EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18449 * Enable or disable multi-selection in the genlist
18451 * @param obj The genlist object
18452 * @param multi Multi-select enable/disable. Default is disabled.
18454 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
18455 * the list. This allows more than 1 item to be selected. To retrieve the list
18456 * of selected items, use elm_genlist_selected_items_get().
18458 * @see elm_genlist_selected_items_get()
18459 * @see elm_genlist_multi_select_get()
18463 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
18465 * Gets if multi-selection in genlist is enabled or disabled.
18467 * @param obj The genlist object
18468 * @return Multi-select enabled/disabled
18469 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
18471 * @see elm_genlist_multi_select_set()
18475 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18477 * This sets the horizontal stretching mode.
18479 * @param obj The genlist object
18480 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
18482 * This sets the mode used for sizing items horizontally. Valid modes
18483 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
18484 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
18485 * the scroller will scroll horizontally. Otherwise items are expanded
18486 * to fill the width of the viewport of the scroller. If it is
18487 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
18488 * limited to that size.
18490 * @see elm_genlist_horizontal_get()
18494 EAPI void elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18495 EINA_DEPRECATED EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18497 * Gets the horizontal stretching mode.
18499 * @param obj The genlist object
18500 * @return The mode to use
18501 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
18503 * @see elm_genlist_horizontal_set()
18507 EAPI Elm_List_Mode elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18508 EINA_DEPRECATED EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18510 * Set the always select mode.
18512 * @param obj The genlist object
18513 * @param always_select The always select mode (@c EINA_TRUE = on, @c
18514 * EINA_FALSE = off). Default is @c EINA_FALSE.
18516 * Items will only call their selection func and callback when first
18517 * becoming selected. Any further clicks will do nothing, unless you
18518 * enable always select with elm_genlist_always_select_mode_set().
18519 * This means that, even if selected, every click will make the selected
18520 * callbacks be called.
18522 * @see elm_genlist_always_select_mode_get()
18526 EINA_DEPRECATED EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
18528 * Get the always select mode.
18530 * @param obj The genlist object
18531 * @return The always select mode
18532 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18534 * @see elm_genlist_always_select_mode_set()
18538 EINA_DEPRECATED EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18540 * Enable/disable the no select mode.
18542 * @param obj The genlist object
18543 * @param no_select The no select mode
18544 * (EINA_TRUE = on, EINA_FALSE = off)
18546 * This will turn off the ability to select items entirely and they
18547 * will neither appear selected nor call selected callback functions.
18549 * @see elm_genlist_no_select_mode_get()
18553 EINA_DEPRECATED EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
18555 * Gets whether the no select mode is enabled.
18557 * @param obj The genlist object
18558 * @return The no select mode
18559 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18561 * @see elm_genlist_no_select_mode_set()
18565 EINA_DEPRECATED EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18567 * Enable/disable compress mode.
18569 * @param obj The genlist object
18570 * @param compress The compress mode
18571 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
18573 * This will enable the compress mode where items are "compressed"
18574 * horizontally to fit the genlist scrollable viewport width. This is
18575 * special for genlist. Do not rely on
18576 * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
18577 * work as genlist needs to handle it specially.
18579 * @see elm_genlist_compress_mode_get()
18583 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
18585 * Get whether the compress mode is enabled.
18587 * @param obj The genlist object
18588 * @return The compress mode
18589 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18591 * @see elm_genlist_compress_mode_set()
18595 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18597 * Enable/disable height-for-width mode.
18599 * @param obj The genlist object
18600 * @param setting The height-for-width mode (@c EINA_TRUE = on,
18601 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
18603 * With height-for-width mode the item width will be fixed (restricted
18604 * to a minimum of) to the list width when calculating its size in
18605 * order to allow the height to be calculated based on it. This allows,
18606 * for instance, text block to wrap lines if the Edje part is
18607 * configured with "text.min: 0 1".
18609 * @note This mode will make list resize slower as it will have to
18610 * recalculate every item height again whenever the list width
18613 * @note When height-for-width mode is enabled, it also enables
18614 * compress mode (see elm_genlist_compress_mode_set()) and
18615 * disables homogeneous (see elm_genlist_homogeneous_set()).
18619 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
18621 * Get whether the height-for-width mode is enabled.
18623 * @param obj The genlist object
18624 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
18629 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18631 * Enable/disable horizontal and vertical bouncing effect.
18633 * @param obj The genlist object
18634 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
18635 * EINA_FALSE = off). Default is @c EINA_FALSE.
18636 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
18637 * EINA_FALSE = off). Default is @c EINA_TRUE.
18639 * This will enable or disable the scroller bouncing effect for the
18640 * genlist. See elm_scroller_bounce_set() for details.
18642 * @see elm_scroller_bounce_set()
18643 * @see elm_genlist_bounce_get()
18647 EINA_DEPRECATED EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18649 * Get whether the horizontal and vertical bouncing effect is enabled.
18651 * @param obj The genlist object
18652 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
18654 * @param v_bounce Pointer to a bool to receive if the bounce vertically
18657 * @see elm_genlist_bounce_set()
18661 EINA_DEPRECATED EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18663 * Enable/disable homogenous mode.
18665 * @param obj The genlist object
18666 * @param homogeneous Assume the items within the genlist are of the
18667 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
18670 * This will enable the homogeneous mode where items are of the same
18671 * height and width so that genlist may do the lazy-loading at its
18672 * maximum (which increases the performance for scrolling the list). This
18673 * implies 'compressed' mode.
18675 * @see elm_genlist_compress_mode_set()
18676 * @see elm_genlist_homogeneous_get()
18680 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
18682 * Get whether the homogenous mode is enabled.
18684 * @param obj The genlist object
18685 * @return Assume the items within the genlist are of the same height
18686 * and width (EINA_TRUE = on, EINA_FALSE = off)
18688 * @see elm_genlist_homogeneous_set()
18692 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18694 * Set the maximum number of items within an item block
18696 * @param obj The genlist object
18697 * @param n Maximum number of items within an item block. Default is 32.
18699 * This will configure the block count to tune to the target with
18700 * particular performance matrix.
18702 * A block of objects will be used to reduce the number of operations due to
18703 * many objects in the screen. It can determine the visibility, or if the
18704 * object has changed, it theme needs to be updated, etc. doing this kind of
18705 * calculation to the entire block, instead of per object.
18707 * The default value for the block count is enough for most lists, so unless
18708 * you know you will have a lot of objects visible in the screen at the same
18709 * time, don't try to change this.
18711 * @see elm_genlist_block_count_get()
18712 * @see @ref Genlist_Implementation
18716 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
18718 * Get the maximum number of items within an item block
18720 * @param obj The genlist object
18721 * @return Maximum number of items within an item block
18723 * @see elm_genlist_block_count_set()
18727 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18729 * Set the timeout in seconds for the longpress event.
18731 * @param obj The genlist object
18732 * @param timeout timeout in seconds. Default is 1.
18734 * This option will change how long it takes to send an event "longpressed"
18735 * after the mouse down signal is sent to the list. If this event occurs, no
18736 * "clicked" event will be sent.
18738 * @see elm_genlist_longpress_timeout_set()
18742 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18744 * Get the timeout in seconds for the longpress event.
18746 * @param obj The genlist object
18747 * @return timeout in seconds
18749 * @see elm_genlist_longpress_timeout_get()
18753 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18755 * Append a new item in a given genlist widget.
18757 * @param obj The genlist object
18758 * @param itc The item class for the item
18759 * @param data The item data
18760 * @param parent The parent item, or NULL if none
18761 * @param flags Item flags
18762 * @param func Convenience function called when the item is selected
18763 * @param func_data Data passed to @p func above.
18764 * @return A handle to the item added or @c NULL if not possible
18766 * This adds the given item to the end of the list or the end of
18767 * the children list if the @p parent is given.
18769 * @see elm_genlist_item_prepend()
18770 * @see elm_genlist_item_insert_before()
18771 * @see elm_genlist_item_insert_after()
18772 * @see elm_genlist_item_del()
18776 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);
18778 * Prepend a new item in a given genlist widget.
18780 * @param obj The genlist object
18781 * @param itc The item class for the item
18782 * @param data The item data
18783 * @param parent The parent item, or NULL if none
18784 * @param flags Item flags
18785 * @param func Convenience function called when the item is selected
18786 * @param func_data Data passed to @p func above.
18787 * @return A handle to the item added or NULL if not possible
18789 * This adds an item to the beginning of the list or beginning of the
18790 * children of the parent if given.
18792 * @see elm_genlist_item_append()
18793 * @see elm_genlist_item_insert_before()
18794 * @see elm_genlist_item_insert_after()
18795 * @see elm_genlist_item_del()
18799 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);
18801 * Insert an item before another in a genlist widget
18803 * @param obj The genlist object
18804 * @param itc The item class for the item
18805 * @param data The item data
18806 * @param before The item to place this new one before.
18807 * @param flags Item flags
18808 * @param func Convenience function called when the item is selected
18809 * @param func_data Data passed to @p func above.
18810 * @return A handle to the item added or @c NULL if not possible
18812 * This inserts an item before another in the list. It will be in the
18813 * same tree level or group as the item it is inserted before.
18815 * @see elm_genlist_item_append()
18816 * @see elm_genlist_item_prepend()
18817 * @see elm_genlist_item_insert_after()
18818 * @see elm_genlist_item_del()
18822 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);
18824 * Insert an item after another in a genlist widget
18826 * @param obj The genlist object
18827 * @param itc The item class for the item
18828 * @param data The item data
18829 * @param after The item to place this new one after.
18830 * @param flags Item flags
18831 * @param func Convenience function called when the item is selected
18832 * @param func_data Data passed to @p func above.
18833 * @return A handle to the item added or @c NULL if not possible
18835 * This inserts an item after another in the list. It will be in the
18836 * same tree level or group as the item it is inserted after.
18838 * @see elm_genlist_item_append()
18839 * @see elm_genlist_item_prepend()
18840 * @see elm_genlist_item_insert_before()
18841 * @see elm_genlist_item_del()
18845 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);
18847 * Insert a new item into the sorted genlist object
18849 * @param obj The genlist object
18850 * @param itc The item class for the item
18851 * @param data The item data
18852 * @param parent The parent item, or NULL if none
18853 * @param flags Item flags
18854 * @param comp The function called for the sort
18855 * @param func Convenience function called when item selected
18856 * @param func_data Data passed to @p func above.
18857 * @return A handle to the item added or NULL if not possible
18861 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);
18862 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);
18863 /* operations to retrieve existing items */
18865 * Get the selectd item in the genlist.
18867 * @param obj The genlist object
18868 * @return The selected item, or NULL if none is selected.
18870 * This gets the selected item in the list (if multi-selection is enabled, only
18871 * the item that was first selected in the list is returned - which is not very
18872 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
18875 * If no item is selected, NULL is returned.
18877 * @see elm_genlist_selected_items_get()
18881 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18883 * Get a list of selected items in the genlist.
18885 * @param obj The genlist object
18886 * @return The list of selected items, or NULL if none are selected.
18888 * It returns a list of the selected items. This list pointer is only valid so
18889 * long as the selection doesn't change (no items are selected or unselected, or
18890 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
18891 * pointers. The order of the items in this list is the order which they were
18892 * selected, i.e. the first item in this list is the first item that was
18893 * selected, and so on.
18895 * @note If not in multi-select mode, consider using function
18896 * elm_genlist_selected_item_get() instead.
18898 * @see elm_genlist_multi_select_set()
18899 * @see elm_genlist_selected_item_get()
18903 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18905 * Get the mode item style of items in the genlist
18906 * @param obj The genlist object
18907 * @return The mode item style string, or NULL if none is specified
18909 * This is a constant string and simply defines the name of the
18910 * style that will be used for mode animations. It can be
18911 * @c NULL if you don't plan to use Genlist mode. See
18912 * elm_genlist_item_mode_set() for more info.
18916 EAPI const char *elm_genlist_mode_item_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18918 * Set the mode item style of items in the genlist
18919 * @param obj The genlist object
18920 * @param style The mode item style string, or NULL if none is desired
18922 * This is a constant string and simply defines the name of the
18923 * style that will be used for mode animations. It can be
18924 * @c NULL if you don't plan to use Genlist mode. See
18925 * elm_genlist_item_mode_set() for more info.
18929 EAPI void elm_genlist_mode_item_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
18931 * Get a list of realized items in genlist
18933 * @param obj The genlist object
18934 * @return The list of realized items, nor NULL if none are realized.
18936 * This returns a list of the realized items in the genlist. The list
18937 * contains Elm_Genlist_Item pointers. The list must be freed by the
18938 * caller when done with eina_list_free(). The item pointers in the
18939 * list are only valid so long as those items are not deleted or the
18940 * genlist is not deleted.
18942 * @see elm_genlist_realized_items_update()
18946 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18948 * Get the item that is at the x, y canvas coords.
18950 * @param obj The gelinst object.
18951 * @param x The input x coordinate
18952 * @param y The input y coordinate
18953 * @param posret The position relative to the item returned here
18954 * @return The item at the coordinates or NULL if none
18956 * This returns the item at the given coordinates (which are canvas
18957 * relative, not object-relative). If an item is at that coordinate,
18958 * that item handle is returned, and if @p posret is not NULL, the
18959 * integer pointed to is set to a value of -1, 0 or 1, depending if
18960 * the coordinate is on the upper portion of that item (-1), on the
18961 * middle section (0) or on the lower part (1). If NULL is returned as
18962 * an item (no item found there), then posret may indicate -1 or 1
18963 * based if the coordinate is above or below all items respectively in
18968 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);
18970 * Get the first item in the genlist
18972 * This returns the first item in the list.
18974 * @param obj The genlist object
18975 * @return The first item, or NULL if none
18979 EINA_DEPRECATED EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18981 * Get the last item in the genlist
18983 * This returns the last item in the list.
18985 * @return The last item, or NULL if none
18989 EINA_DEPRECATED EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18991 * Set the scrollbar policy
18993 * @param obj The genlist object
18994 * @param policy_h Horizontal scrollbar policy.
18995 * @param policy_v Vertical scrollbar policy.
18997 * This sets the scrollbar visibility policy for the given genlist
18998 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
18999 * made visible if it is needed, and otherwise kept hidden.
19000 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
19001 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
19002 * respectively for the horizontal and vertical scrollbars. Default is
19003 * #ELM_SMART_SCROLLER_POLICY_AUTO
19005 * @see elm_genlist_scroller_policy_get()
19009 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
19011 * Get the scrollbar policy
19013 * @param obj The genlist object
19014 * @param policy_h Pointer to store the horizontal scrollbar policy.
19015 * @param policy_v Pointer to store the vertical scrollbar policy.
19017 * @see elm_genlist_scroller_policy_set()
19021 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);
19023 * Get the @b next item in a genlist widget's internal list of items,
19024 * given a handle to one of those items.
19026 * @param item The genlist item to fetch next from
19027 * @return The item after @p item, or @c NULL if there's none (and
19030 * This returns the item placed after the @p item, on the container
19033 * @see elm_genlist_item_prev_get()
19037 EINA_DEPRECATED EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19039 * Get the @b previous item in a genlist widget's internal list of items,
19040 * given a handle to one of those items.
19042 * @param item The genlist item to fetch previous from
19043 * @return The item before @p item, or @c NULL if there's none (and
19046 * This returns the item placed before the @p item, on the container
19049 * @see elm_genlist_item_next_get()
19053 EINA_DEPRECATED EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19055 * Get the genlist object's handle which contains a given genlist
19058 * @param item The item to fetch the container from
19059 * @return The genlist (parent) object
19061 * This returns the genlist object itself that an item belongs to.
19065 EINA_DEPRECATED EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19067 * Get the parent item of the given item
19069 * @param it The item
19070 * @return The parent of the item or @c NULL if it has no parent.
19072 * This returns the item that was specified as parent of the item @p it on
19073 * elm_genlist_item_append() and insertion related functions.
19077 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19079 * Remove all sub-items (children) of the given item
19081 * @param it The item
19083 * This removes all items that are children (and their descendants) of the
19084 * given item @p it.
19086 * @see elm_genlist_clear()
19087 * @see elm_genlist_item_del()
19091 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19093 * Set whether a given genlist item is selected or not
19095 * @param it The item
19096 * @param selected Use @c EINA_TRUE, to make it selected, @c
19097 * EINA_FALSE to make it unselected
19099 * This sets the selected state of an item. If multi selection is
19100 * not enabled on the containing genlist and @p selected is @c
19101 * EINA_TRUE, any other previously selected items will get
19102 * unselected in favor of this new one.
19104 * @see elm_genlist_item_selected_get()
19108 EINA_DEPRECATED EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
19110 * Get whether a given genlist item is selected or not
19112 * @param it The item
19113 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
19115 * @see elm_genlist_item_selected_set() for more details
19119 EINA_DEPRECATED EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19121 * Sets the expanded state of an item.
19123 * @param it The item
19124 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
19126 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
19129 * The theme will respond to this change visually, and a signal "expanded" or
19130 * "contracted" will be sent from the genlist with a pointer to the item that
19131 * has been expanded/contracted.
19133 * Calling this function won't show or hide any child of this item (if it is
19134 * a parent). You must manually delete and create them on the callbacks fo
19135 * the "expanded" or "contracted" signals.
19137 * @see elm_genlist_item_expanded_get()
19141 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
19143 * Get the expanded state of an item
19145 * @param it The item
19146 * @return The expanded state
19148 * This gets the expanded state of an item.
19150 * @see elm_genlist_item_expanded_set()
19154 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19156 * Get the depth of expanded item
19158 * @param it The genlist item object
19159 * @return The depth of expanded item
19163 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19165 * Set whether a given genlist item is disabled or not.
19167 * @param it The item
19168 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
19169 * to enable it back.
19171 * A disabled item cannot be selected or unselected. It will also
19172 * change its appearance, to signal the user it's disabled.
19174 * @see elm_genlist_item_disabled_get()
19178 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
19180 * Get whether a given genlist item is disabled or not.
19182 * @param it The item
19183 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
19186 * @see elm_genlist_item_disabled_set() for more details
19190 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19192 * Sets the display only state of an item.
19194 * @param it The item
19195 * @param display_only @c EINA_TRUE if the item is display only, @c
19196 * EINA_FALSE otherwise.
19198 * A display only item cannot be selected or unselected. It is for
19199 * display only and not selecting or otherwise clicking, dragging
19200 * etc. by the user, thus finger size rules will not be applied to
19203 * It's good to set group index items to display only state.
19205 * @see elm_genlist_item_display_only_get()
19209 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
19211 * Get the display only state of an item
19213 * @param it The item
19214 * @return @c EINA_TRUE if the item is display only, @c
19215 * EINA_FALSE otherwise.
19217 * @see elm_genlist_item_display_only_set()
19221 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19223 * Show the portion of a genlist's internal list containing a given
19224 * item, immediately.
19226 * @param it The item to display
19228 * This causes genlist to jump to the given item @p it and show it (by
19229 * immediately scrolling to that position), if it is not fully visible.
19231 * @see elm_genlist_item_bring_in()
19232 * @see elm_genlist_item_top_show()
19233 * @see elm_genlist_item_middle_show()
19237 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19239 * Animatedly bring in, to the visible are of a genlist, a given
19242 * @param it The item to display
19244 * This causes genlist to jump to the given item @p it and show it (by
19245 * animatedly scrolling), if it is not fully visible. This may use animation
19246 * to do so and take a period of time
19248 * @see elm_genlist_item_show()
19249 * @see elm_genlist_item_top_bring_in()
19250 * @see elm_genlist_item_middle_bring_in()
19254 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19256 * Show the portion of a genlist's internal list containing a given
19257 * item, immediately.
19259 * @param it The item to display
19261 * This causes genlist to jump to the given item @p it and show it (by
19262 * immediately scrolling to that position), if it is not fully visible.
19264 * The item will be positioned at the top of the genlist viewport.
19266 * @see elm_genlist_item_show()
19267 * @see elm_genlist_item_top_bring_in()
19271 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19273 * Animatedly bring in, to the visible are of a genlist, a given
19276 * @param it The item
19278 * This causes genlist to jump to the given item @p it and show it (by
19279 * animatedly scrolling), if it is not fully visible. This may use animation
19280 * to do so and take a period of time
19282 * The item will be positioned at the top of the genlist viewport.
19284 * @see elm_genlist_item_bring_in()
19285 * @see elm_genlist_item_top_show()
19289 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19291 * Show the portion of a genlist's internal list containing a given
19292 * item, immediately.
19294 * @param it The item to display
19296 * This causes genlist to jump to the given item @p it and show it (by
19297 * immediately scrolling to that position), if it is not fully visible.
19299 * The item will be positioned at the middle of the genlist viewport.
19301 * @see elm_genlist_item_show()
19302 * @see elm_genlist_item_middle_bring_in()
19306 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19308 * Animatedly bring in, to the visible are of a genlist, a given
19311 * @param it The item
19313 * This causes genlist to jump to the given item @p it and show it (by
19314 * animatedly scrolling), if it is not fully visible. This may use animation
19315 * to do so and take a period of time
19317 * The item will be positioned at the middle of the genlist viewport.
19319 * @see elm_genlist_item_bring_in()
19320 * @see elm_genlist_item_middle_show()
19324 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19326 * Remove a genlist item from the its parent, deleting it.
19328 * @param item The item to be removed.
19329 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
19331 * @see elm_genlist_clear(), to remove all items in a genlist at
19336 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19338 * Return the data associated to a given genlist item
19340 * @param item The genlist item.
19341 * @return the data associated to this item.
19343 * This returns the @c data value passed on the
19344 * elm_genlist_item_append() and related item addition calls.
19346 * @see elm_genlist_item_append()
19347 * @see elm_genlist_item_data_set()
19351 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19353 * Set the data associated to a given genlist item
19355 * @param item The genlist item
19356 * @param data The new data pointer to set on it
19358 * This @b overrides the @c data value passed on the
19359 * elm_genlist_item_append() and related item addition calls. This
19360 * function @b won't call elm_genlist_item_update() automatically,
19361 * so you'd issue it afterwards if you want to hove the item
19362 * updated to reflect the that new data.
19364 * @see elm_genlist_item_data_get()
19368 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
19370 * Tells genlist to "orphan" icons fetchs by the item class
19372 * @param it The item
19374 * This instructs genlist to release references to icons in the item,
19375 * meaning that they will no longer be managed by genlist and are
19376 * floating "orphans" that can be re-used elsewhere if the user wants
19381 EAPI void elm_genlist_item_contents_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19382 EINA_DEPRECATED EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19384 * Get the real Evas object created to implement the view of a
19385 * given genlist item
19387 * @param item The genlist item.
19388 * @return the Evas object implementing this item's view.
19390 * This returns the actual Evas object used to implement the
19391 * specified genlist item's view. This may be @c NULL, as it may
19392 * not have been created or may have been deleted, at any time, by
19393 * the genlist. <b>Do not modify this object</b> (move, resize,
19394 * show, hide, etc.), as the genlist is controlling it. This
19395 * function is for querying, emitting custom signals or hooking
19396 * lower level callbacks for events on that object. Do not delete
19397 * this object under any circumstances.
19399 * @see elm_genlist_item_data_get()
19403 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19405 * Update the contents of an item
19407 * @param it The item
19409 * This updates an item by calling all the item class functions again
19410 * to get the icons, labels and states. Use this when the original
19411 * item data has changed and the changes are desired to be reflected.
19413 * Use elm_genlist_realized_items_update() to update all already realized
19416 * @see elm_genlist_realized_items_update()
19420 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19422 * Update the item class of an item
19424 * @param it The item
19425 * @param itc The item class for the item
19427 * This sets another class fo the item, changing the way that it is
19428 * displayed. After changing the item class, elm_genlist_item_update() is
19429 * called on the item @p it.
19433 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
19434 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19436 * Set the text to be shown in a given genlist item's tooltips.
19438 * @param item The genlist item
19439 * @param text The text to set in the content
19441 * This call will setup the text to be used as tooltip to that item
19442 * (analogous to elm_object_tooltip_text_set(), but being item
19443 * tooltips with higher precedence than object tooltips). It can
19444 * have only one tooltip at a time, so any previous tooltip data
19445 * will get removed.
19447 * In order to set an icon or something else as a tooltip, look at
19448 * elm_genlist_item_tooltip_content_cb_set().
19452 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
19454 * Set the content to be shown in a given genlist item's tooltips
19456 * @param item The genlist item.
19457 * @param func The function returning the tooltip contents.
19458 * @param data What to provide to @a func as callback data/context.
19459 * @param del_cb Called when data is not needed anymore, either when
19460 * another callback replaces @p func, the tooltip is unset with
19461 * elm_genlist_item_tooltip_unset() or the owner @p item
19462 * dies. This callback receives as its first parameter the
19463 * given @p data, being @c event_info the item handle.
19465 * This call will setup the tooltip's contents to @p item
19466 * (analogous to elm_object_tooltip_content_cb_set(), but being
19467 * item tooltips with higher precedence than object tooltips). It
19468 * can have only one tooltip at a time, so any previous tooltip
19469 * content will get removed. @p func (with @p data) will be called
19470 * every time Elementary needs to show the tooltip and it should
19471 * return a valid Evas object, which will be fully managed by the
19472 * tooltip system, getting deleted when the tooltip is gone.
19474 * In order to set just a text as a tooltip, look at
19475 * elm_genlist_item_tooltip_text_set().
19479 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);
19481 * Unset a tooltip from a given genlist item
19483 * @param item genlist item to remove a previously set tooltip from.
19485 * This call removes any tooltip set on @p item. The callback
19486 * provided as @c del_cb to
19487 * elm_genlist_item_tooltip_content_cb_set() will be called to
19488 * notify it is not used anymore (and have resources cleaned, if
19491 * @see elm_genlist_item_tooltip_content_cb_set()
19495 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19497 * Set a different @b style for a given genlist item's tooltip.
19499 * @param item genlist item with tooltip set
19500 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
19501 * "default", @c "transparent", etc)
19503 * Tooltips can have <b>alternate styles</b> to be displayed on,
19504 * which are defined by the theme set on Elementary. This function
19505 * works analogously as elm_object_tooltip_style_set(), but here
19506 * applied only to genlist item objects. The default style for
19507 * tooltips is @c "default".
19509 * @note before you set a style you should define a tooltip with
19510 * elm_genlist_item_tooltip_content_cb_set() or
19511 * elm_genlist_item_tooltip_text_set()
19513 * @see elm_genlist_item_tooltip_style_get()
19517 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19519 * Get the style set a given genlist item's tooltip.
19521 * @param item genlist item with tooltip already set on.
19522 * @return style the theme style in use, which defaults to
19523 * "default". If the object does not have a tooltip set,
19524 * then @c NULL is returned.
19526 * @see elm_genlist_item_tooltip_style_set() for more details
19530 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19532 * @brief Disable size restrictions on an object's tooltip
19533 * @param item The tooltip's anchor object
19534 * @param disable If EINA_TRUE, size restrictions are disabled
19535 * @return EINA_FALSE on failure, EINA_TRUE on success
19537 * This function allows a tooltip to expand beyond its parant window's canvas.
19538 * It will instead be limited only by the size of the display.
19540 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
19542 * @brief Retrieve size restriction state of an object's tooltip
19543 * @param item The tooltip's anchor object
19544 * @return If EINA_TRUE, size restrictions are disabled
19546 * This function returns whether a tooltip is allowed to expand beyond
19547 * its parant window's canvas.
19548 * It will instead be limited only by the size of the display.
19550 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
19552 * Set the type of mouse pointer/cursor decoration to be shown,
19553 * when the mouse pointer is over the given genlist widget item
19555 * @param item genlist item to customize cursor on
19556 * @param cursor the cursor type's name
19558 * This function works analogously as elm_object_cursor_set(), but
19559 * here the cursor's changing area is restricted to the item's
19560 * area, and not the whole widget's. Note that that item cursors
19561 * have precedence over widget cursors, so that a mouse over @p
19562 * item will always show cursor @p type.
19564 * If this function is called twice for an object, a previously set
19565 * cursor will be unset on the second call.
19567 * @see elm_object_cursor_set()
19568 * @see elm_genlist_item_cursor_get()
19569 * @see elm_genlist_item_cursor_unset()
19573 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
19575 * Get the type of mouse pointer/cursor decoration set to be shown,
19576 * when the mouse pointer is over the given genlist widget item
19578 * @param item genlist item with custom cursor set
19579 * @return the cursor type's name or @c NULL, if no custom cursors
19580 * were set to @p item (and on errors)
19582 * @see elm_object_cursor_get()
19583 * @see elm_genlist_item_cursor_set() for more details
19584 * @see elm_genlist_item_cursor_unset()
19588 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19590 * Unset any custom mouse pointer/cursor decoration set to be
19591 * shown, when the mouse pointer is over the given genlist widget
19592 * item, thus making it show the @b default cursor again.
19594 * @param item a genlist item
19596 * Use this call to undo any custom settings on this item's cursor
19597 * decoration, bringing it back to defaults (no custom style set).
19599 * @see elm_object_cursor_unset()
19600 * @see elm_genlist_item_cursor_set() for more details
19604 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19606 * Set a different @b style for a given custom cursor set for a
19609 * @param item genlist item with custom cursor set
19610 * @param style the <b>theme style</b> to use (e.g. @c "default",
19611 * @c "transparent", etc)
19613 * This function only makes sense when one is using custom mouse
19614 * cursor decorations <b>defined in a theme file</b> , which can
19615 * have, given a cursor name/type, <b>alternate styles</b> on
19616 * it. It works analogously as elm_object_cursor_style_set(), but
19617 * here applied only to genlist item objects.
19619 * @warning Before you set a cursor style you should have defined a
19620 * custom cursor previously on the item, with
19621 * elm_genlist_item_cursor_set()
19623 * @see elm_genlist_item_cursor_engine_only_set()
19624 * @see elm_genlist_item_cursor_style_get()
19628 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19630 * Get the current @b style set for a given genlist item's custom
19633 * @param item genlist item with custom cursor set.
19634 * @return style the cursor style in use. If the object does not
19635 * have a cursor set, then @c NULL is returned.
19637 * @see elm_genlist_item_cursor_style_set() for more details
19641 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19643 * Set if the (custom) cursor for a given genlist item should be
19644 * searched in its theme, also, or should only rely on the
19645 * rendering engine.
19647 * @param item item with custom (custom) cursor already set on
19648 * @param engine_only Use @c EINA_TRUE to have cursors looked for
19649 * only on those provided by the rendering engine, @c EINA_FALSE to
19650 * have them searched on the widget's theme, as well.
19652 * @note This call is of use only if you've set a custom cursor
19653 * for genlist items, with elm_genlist_item_cursor_set().
19655 * @note By default, cursors will only be looked for between those
19656 * provided by the rendering engine.
19660 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
19662 * Get if the (custom) cursor for a given genlist item is being
19663 * searched in its theme, also, or is only relying on the rendering
19666 * @param item a genlist item
19667 * @return @c EINA_TRUE, if cursors are being looked for only on
19668 * those provided by the rendering engine, @c EINA_FALSE if they
19669 * are being searched on the widget's theme, as well.
19671 * @see elm_genlist_item_cursor_engine_only_set(), for more details
19675 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19677 * Update the contents of all realized items.
19679 * @param obj The genlist object.
19681 * This updates all realized items by calling all the item class functions again
19682 * to get the icons, labels and states. Use this when the original
19683 * item data has changed and the changes are desired to be reflected.
19685 * To update just one item, use elm_genlist_item_update().
19687 * @see elm_genlist_realized_items_get()
19688 * @see elm_genlist_item_update()
19692 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
19694 * Activate a genlist mode on an item
19696 * @param item The genlist item
19697 * @param mode Mode name
19698 * @param mode_set Boolean to define set or unset mode.
19700 * A genlist mode is a different way of selecting an item. Once a mode is
19701 * activated on an item, any other selected item is immediately unselected.
19702 * This feature provides an easy way of implementing a new kind of animation
19703 * for selecting an item, without having to entirely rewrite the item style
19704 * theme. However, the elm_genlist_selected_* API can't be used to get what
19705 * item is activate for a mode.
19707 * The current item style will still be used, but applying a genlist mode to
19708 * an item will select it using a different kind of animation.
19710 * The current active item for a mode can be found by
19711 * elm_genlist_mode_item_get().
19713 * The characteristics of genlist mode are:
19714 * - Only one mode can be active at any time, and for only one item.
19715 * - Genlist handles deactivating other items when one item is activated.
19716 * - A mode is defined in the genlist theme (edc), and more modes can easily
19718 * - A mode style and the genlist item style are different things. They
19719 * can be combined to provide a default style to the item, with some kind
19720 * of animation for that item when the mode is activated.
19722 * When a mode is activated on an item, a new view for that item is created.
19723 * The theme of this mode defines the animation that will be used to transit
19724 * the item from the old view to the new view. This second (new) view will be
19725 * active for that item while the mode is active on the item, and will be
19726 * destroyed after the mode is totally deactivated from that item.
19728 * @see elm_genlist_mode_get()
19729 * @see elm_genlist_mode_item_get()
19733 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
19735 * Get the last (or current) genlist mode used.
19737 * @param obj The genlist object
19739 * This function just returns the name of the last used genlist mode. It will
19740 * be the current mode if it's still active.
19742 * @see elm_genlist_item_mode_set()
19743 * @see elm_genlist_mode_item_get()
19747 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19749 * Get active genlist mode item
19751 * @param obj The genlist object
19752 * @return The active item for that current mode. Or @c NULL if no item is
19753 * activated with any mode.
19755 * This function returns the item that was activated with a mode, by the
19756 * function elm_genlist_item_mode_set().
19758 * @see elm_genlist_item_mode_set()
19759 * @see elm_genlist_mode_get()
19763 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19768 * @param obj The genlist object
19769 * @param reorder_mode The reorder mode
19770 * (EINA_TRUE = on, EINA_FALSE = off)
19774 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
19777 * Get the reorder mode
19779 * @param obj The genlist object
19780 * @return The reorder mode
19781 * (EINA_TRUE = on, EINA_FALSE = off)
19785 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19792 * @defgroup Check Check
19794 * @image html img/widget/check/preview-00.png
19795 * @image latex img/widget/check/preview-00.eps
19796 * @image html img/widget/check/preview-01.png
19797 * @image latex img/widget/check/preview-01.eps
19798 * @image html img/widget/check/preview-02.png
19799 * @image latex img/widget/check/preview-02.eps
19801 * @brief The check widget allows for toggling a value between true and
19804 * Check objects are a lot like radio objects in layout and functionality
19805 * except they do not work as a group, but independently and only toggle the
19806 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
19807 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
19808 * returns the current state. For convenience, like the radio objects, you
19809 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
19810 * for it to modify.
19812 * Signals that you can add callbacks for are:
19813 * "changed" - This is called whenever the user changes the state of one of
19814 * the check object(event_info is NULL).
19816 * Default contents parts of the check widget that you can use for are:
19817 * @li "elm.swallow.content" - A icon of the check
19819 * Default text parts of the check widget that you can use for are:
19820 * @li "elm.text" - Label of the check
19822 * @ref tutorial_check should give you a firm grasp of how to use this widget
19827 * @brief Add a new Check object
19829 * @param parent The parent object
19830 * @return The new object or NULL if it cannot be created
19832 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19834 * @brief Set the text label of the check object
19836 * @param obj The check object
19837 * @param label The text label string in UTF-8
19839 * @deprecated use elm_object_text_set() instead.
19841 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19843 * @brief Get the text label of the check object
19845 * @param obj The check object
19846 * @return The text label string in UTF-8
19848 * @deprecated use elm_object_text_get() instead.
19850 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19852 * @brief Set the icon object of the check object
19854 * @param obj The check object
19855 * @param icon The icon object
19857 * Once the icon object is set, a previously set one will be deleted.
19858 * If you want to keep that old content object, use the
19859 * elm_object_content_unset() function.
19861 * @deprecated use elm_object_content_set() instead.
19863 EINA_DEPRECATED EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19865 * @brief Get the icon object of the check object
19867 * @param obj The check object
19868 * @return The icon object
19870 EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19872 * @brief Unset the icon used for the check object
19874 * @param obj The check object
19875 * @return The icon object that was being used
19877 * Unparent and return the icon object which was set for this widget.
19879 * @deprecated use elm_object_content_unset() instead.
19881 EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19883 * @brief Set the on/off state of the check object
19885 * @param obj The check object
19886 * @param state The state to use (1 == on, 0 == off)
19888 * This sets the state of the check. If set
19889 * with elm_check_state_pointer_set() the state of that variable is also
19890 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
19892 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
19894 * @brief Get the state of the check object
19896 * @param obj The check object
19897 * @return The boolean state
19899 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19901 * @brief Set a convenience pointer to a boolean to change
19903 * @param obj The check object
19904 * @param statep Pointer to the boolean to modify
19906 * This sets a pointer to a boolean, that, in addition to the check objects
19907 * state will also be modified directly. To stop setting the object pointed
19908 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
19909 * then when this is called, the check objects state will also be modified to
19910 * reflect the value of the boolean @p statep points to, just like calling
19911 * elm_check_state_set().
19913 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
19914 EINA_DEPRECATED EAPI void elm_check_states_labels_set(Evas_Object *obj, const char *ontext, const char *offtext) EINA_ARG_NONNULL(1,2,3);
19915 EINA_DEPRECATED EAPI void elm_check_states_labels_get(const Evas_Object *obj, const char **ontext, const char **offtext) EINA_ARG_NONNULL(1,2,3);
19922 * @defgroup Radio Radio
19924 * @image html img/widget/radio/preview-00.png
19925 * @image latex img/widget/radio/preview-00.eps
19927 * @brief Radio is a widget that allows for 1 or more options to be displayed
19928 * and have the user choose only 1 of them.
19930 * A radio object contains an indicator, an optional Label and an optional
19931 * icon object. While it's possible to have a group of only one radio they,
19932 * are normally used in groups of 2 or more. To add a radio to a group use
19933 * elm_radio_group_add(). The radio object(s) will select from one of a set
19934 * of integer values, so any value they are configuring needs to be mapped to
19935 * a set of integers. To configure what value that radio object represents,
19936 * use elm_radio_state_value_set() to set the integer it represents. To set
19937 * the value the whole group(which one is currently selected) is to indicate
19938 * use elm_radio_value_set() on any group member, and to get the groups value
19939 * use elm_radio_value_get(). For convenience the radio objects are also able
19940 * to directly set an integer(int) to the value that is selected. To specify
19941 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
19942 * The radio objects will modify this directly. That implies the pointer must
19943 * point to valid memory for as long as the radio objects exist.
19945 * Signals that you can add callbacks for are:
19946 * @li changed - This is called whenever the user changes the state of one of
19947 * the radio objects within the group of radio objects that work together.
19949 * Default contents parts of the radio widget that you can use for are:
19950 * @li "elm.swallow.content" - A icon of the radio
19952 * @ref tutorial_radio show most of this API in action.
19956 * @brief Add a new radio to the parent
19958 * @param parent The parent object
19959 * @return The new object or NULL if it cannot be created
19961 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19963 * @brief Set the text label of the radio object
19965 * @param obj The radio object
19966 * @param label The text label string in UTF-8
19968 * @deprecated use elm_object_text_set() instead.
19970 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19972 * @brief Get the text label of the radio object
19974 * @param obj The radio object
19975 * @return The text label string in UTF-8
19977 * @deprecated use elm_object_text_set() instead.
19979 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19981 * @brief Set the icon object of the radio object
19983 * @param obj The radio object
19984 * @param icon The icon object
19986 * Once the icon object is set, a previously set one will be deleted. If you
19987 * want to keep that old content object, use the elm_radio_icon_unset()
19990 * @deprecated use elm_object_content_set() instead.
19992 EINA_DEPRECATED EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19994 * @brief Get the icon object of the radio object
19996 * @param obj The radio object
19997 * @return The icon object
19999 * @see elm_radio_icon_set()
20001 EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20003 * @brief Unset the icon used for the radio object
20005 * @param obj The radio object
20006 * @return The icon object that was being used
20008 * Unparent and return the icon object which was set for this widget.
20010 * @see elm_radio_icon_set()
20011 * @deprecated use elm_object_content_unset() instead.
20013 EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20015 * @brief Add this radio to a group of other radio objects
20017 * @param obj The radio object
20018 * @param group Any object whose group the @p obj is to join.
20020 * Radio objects work in groups. Each member should have a different integer
20021 * value assigned. In order to have them work as a group, they need to know
20022 * about each other. This adds the given radio object to the group of which
20023 * the group object indicated is a member.
20025 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
20027 * @brief Set the integer value that this radio object represents
20029 * @param obj The radio object
20030 * @param value The value to use if this radio object is selected
20032 * This sets the value of the radio.
20034 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
20036 * @brief Get the integer value that this radio object represents
20038 * @param obj The radio object
20039 * @return The value used if this radio object is selected
20041 * This gets the value of the radio.
20043 * @see elm_radio_value_set()
20045 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20047 * @brief Set the value of the radio.
20049 * @param obj The radio object
20050 * @param value The value to use for the group
20052 * This sets the value of the radio group and will also set the value if
20053 * pointed to, to the value supplied, but will not call any callbacks.
20055 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
20057 * @brief Get the state of the radio object
20059 * @param obj The radio object
20060 * @return The integer state
20062 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20064 * @brief Set a convenience pointer to a integer to change
20066 * @param obj The radio object
20067 * @param valuep Pointer to the integer to modify
20069 * This sets a pointer to a integer, that, in addition to the radio objects
20070 * state will also be modified directly. To stop setting the object pointed
20071 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
20072 * when this is called, the radio objects state will also be modified to
20073 * reflect the value of the integer valuep points to, just like calling
20074 * elm_radio_value_set().
20076 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
20082 * @defgroup Pager Pager
20084 * @image html img/widget/pager/preview-00.png
20085 * @image latex img/widget/pager/preview-00.eps
20087 * @brief Widget that allows flipping between 1 or more āpagesā of objects.
20089 * The flipping between āpagesā of objects is animated. All content in pager
20090 * is kept in a stack, the last content to be added will be on the top of the
20091 * stack(be visible).
20093 * Objects can be pushed or popped from the stack or deleted as normal.
20094 * Pushes and pops will animate (and a pop will delete the object once the
20095 * animation is finished). Any object already in the pager can be promoted to
20096 * the top(from its current stacking position) through the use of
20097 * elm_pager_content_promote(). Objects are pushed to the top with
20098 * elm_pager_content_push() and when the top item is no longer wanted, simply
20099 * pop it with elm_pager_content_pop() and it will also be deleted. If an
20100 * object is no longer needed and is not the top item, just delete it as
20101 * normal. You can query which objects are the top and bottom with
20102 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
20104 * Signals that you can add callbacks for are:
20105 * "hide,finished" - when the previous page is hided
20107 * This widget has the following styles available:
20110 * @li fade_translucide
20111 * @li fade_invisible
20112 * @note This styles affect only the flipping animations, the appearance when
20113 * not animating is unaffected by styles.
20115 * @ref tutorial_pager gives a good overview of the usage of the API.
20119 * Add a new pager to the parent
20121 * @param parent The parent object
20122 * @return The new object or NULL if it cannot be created
20126 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20128 * @brief Push an object to the top of the pager stack (and show it).
20130 * @param obj The pager object
20131 * @param content The object to push
20133 * The object pushed becomes a child of the pager, it will be controlled and
20134 * deleted when the pager is deleted.
20136 * @note If the content is already in the stack use
20137 * elm_pager_content_promote().
20138 * @warning Using this function on @p content already in the stack results in
20139 * undefined behavior.
20141 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20143 * @brief Pop the object that is on top of the stack
20145 * @param obj The pager object
20147 * This pops the object that is on the top(visible) of the pager, makes it
20148 * disappear, then deletes the object. The object that was underneath it on
20149 * the stack will become visible.
20151 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
20153 * @brief Moves an object already in the pager stack to the top of the stack.
20155 * @param obj The pager object
20156 * @param content The object to promote
20158 * This will take the @p content and move it to the top of the stack as
20159 * if it had been pushed there.
20161 * @note If the content isn't already in the stack use
20162 * elm_pager_content_push().
20163 * @warning Using this function on @p content not already in the stack
20164 * results in undefined behavior.
20166 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20168 * @brief Return the object at the bottom of the pager stack
20170 * @param obj The pager object
20171 * @return The bottom object or NULL if none
20173 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20175 * @brief Return the object at the top of the pager stack
20177 * @param obj The pager object
20178 * @return The top object or NULL if none
20180 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20187 * @defgroup Slideshow Slideshow
20189 * @image html img/widget/slideshow/preview-00.png
20190 * @image latex img/widget/slideshow/preview-00.eps
20192 * This widget, as the name indicates, is a pre-made image
20193 * slideshow panel, with API functions acting on (child) image
20194 * items presentation. Between those actions, are:
20195 * - advance to next/previous image
20196 * - select the style of image transition animation
20197 * - set the exhibition time for each image
20198 * - start/stop the slideshow
20200 * The transition animations are defined in the widget's theme,
20201 * consequently new animations can be added without having to
20202 * update the widget's code.
20204 * @section Slideshow_Items Slideshow items
20206 * For slideshow items, just like for @ref Genlist "genlist" ones,
20207 * the user defines a @b classes, specifying functions that will be
20208 * called on the item's creation and deletion times.
20210 * The #Elm_Slideshow_Item_Class structure contains the following
20213 * - @c func.get - When an item is displayed, this function is
20214 * called, and it's where one should create the item object, de
20215 * facto. For example, the object can be a pure Evas image object
20216 * or an Elementary @ref Photocam "photocam" widget. See
20217 * #SlideshowItemGetFunc.
20218 * - @c func.del - When an item is no more displayed, this function
20219 * is called, where the user must delete any data associated to
20220 * the item. See #SlideshowItemDelFunc.
20222 * @section Slideshow_Caching Slideshow caching
20224 * The slideshow provides facilities to have items adjacent to the
20225 * one being displayed <b>already "realized"</b> (i.e. loaded) for
20226 * you, so that the system does not have to decode image data
20227 * anymore at the time it has to actually switch images on its
20228 * viewport. The user is able to set the numbers of items to be
20229 * cached @b before and @b after the current item, in the widget's
20232 * Smart events one can add callbacks for are:
20234 * - @c "changed" - when the slideshow switches its view to a new
20237 * List of examples for the slideshow widget:
20238 * @li @ref slideshow_example
20242 * @addtogroup Slideshow
20246 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
20247 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
20248 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Slideshow item handle */
20249 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
20250 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
20253 * @struct _Elm_Slideshow_Item_Class
20255 * Slideshow item class definition. See @ref Slideshow_Items for
20258 struct _Elm_Slideshow_Item_Class
20260 struct _Elm_Slideshow_Item_Class_Func
20262 SlideshowItemGetFunc get;
20263 SlideshowItemDelFunc del;
20265 }; /**< #Elm_Slideshow_Item_Class member definitions */
20268 * Add a new slideshow widget to the given parent Elementary
20269 * (container) object
20271 * @param parent The parent object
20272 * @return A new slideshow widget handle or @c NULL, on errors
20274 * This function inserts a new slideshow widget on the canvas.
20276 * @ingroup Slideshow
20278 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20281 * Add (append) a new item in a given slideshow widget.
20283 * @param obj The slideshow object
20284 * @param itc The item class for the item
20285 * @param data The item's data
20286 * @return A handle to the item added or @c NULL, on errors
20288 * Add a new item to @p obj's internal list of items, appending it.
20289 * The item's class must contain the function really fetching the
20290 * image object to show for this item, which could be an Evas image
20291 * object or an Elementary photo, for example. The @p data
20292 * parameter is going to be passed to both class functions of the
20295 * @see #Elm_Slideshow_Item_Class
20296 * @see elm_slideshow_item_sorted_insert()
20298 * @ingroup Slideshow
20300 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
20303 * Insert a new item into the given slideshow widget, using the @p func
20304 * function to sort items (by item handles).
20306 * @param obj The slideshow object
20307 * @param itc The item class for the item
20308 * @param data The item's data
20309 * @param func The comparing function to be used to sort slideshow
20310 * items <b>by #Elm_Slideshow_Item item handles</b>
20311 * @return Returns The slideshow item handle, on success, or
20312 * @c NULL, on errors
20314 * Add a new item to @p obj's internal list of items, in a position
20315 * determined by the @p func comparing function. The item's class
20316 * must contain the function really fetching the image object to
20317 * show for this item, which could be an Evas image object or an
20318 * Elementary photo, for example. The @p data parameter is going to
20319 * be passed to both class functions of the item.
20321 * @see #Elm_Slideshow_Item_Class
20322 * @see elm_slideshow_item_add()
20324 * @ingroup Slideshow
20326 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);
20329 * Display a given slideshow widget's item, programmatically.
20331 * @param obj The slideshow object
20332 * @param item The item to display on @p obj's viewport
20334 * The change between the current item and @p item will use the
20335 * transition @p obj is set to use (@see
20336 * elm_slideshow_transition_set()).
20338 * @ingroup Slideshow
20340 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20343 * Slide to the @b next item, in a given slideshow widget
20345 * @param obj The slideshow object
20347 * The sliding animation @p obj is set to use will be the
20348 * transition effect used, after this call is issued.
20350 * @note If the end of the slideshow's internal list of items is
20351 * reached, it'll wrap around to the list's beginning, again.
20353 * @ingroup Slideshow
20355 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20358 * Slide to the @b previous item, in a given slideshow widget
20360 * @param obj The slideshow object
20362 * The sliding animation @p obj is set to use will be the
20363 * transition effect used, after this call is issued.
20365 * @note If the beginning of the slideshow's internal list of items
20366 * is reached, it'll wrap around to the list's end, again.
20368 * @ingroup Slideshow
20370 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
20373 * Returns the list of sliding transition/effect names available, for a
20374 * given slideshow widget.
20376 * @param obj The slideshow object
20377 * @return The list of transitions (list of @b stringshared strings
20380 * The transitions, which come from @p obj's theme, must be an EDC
20381 * data item named @c "transitions" on the theme file, with (prefix)
20382 * names of EDC programs actually implementing them.
20384 * The available transitions for slideshows on the default theme are:
20385 * - @c "fade" - the current item fades out, while the new one
20386 * fades in to the slideshow's viewport.
20387 * - @c "black_fade" - the current item fades to black, and just
20388 * then, the new item will fade in.
20389 * - @c "horizontal" - the current item slides horizontally, until
20390 * it gets out of the slideshow's viewport, while the new item
20391 * comes from the left to take its place.
20392 * - @c "vertical" - the current item slides vertically, until it
20393 * gets out of the slideshow's viewport, while the new item comes
20394 * from the bottom to take its place.
20395 * - @c "square" - the new item starts to appear from the middle of
20396 * the current one, but with a tiny size, growing until its
20397 * target (full) size and covering the old one.
20399 * @warning The stringshared strings get no new references
20400 * exclusive to the user grabbing the list, here, so if you'd like
20401 * to use them out of this call's context, you'd better @c
20402 * eina_stringshare_ref() them.
20404 * @see elm_slideshow_transition_set()
20406 * @ingroup Slideshow
20408 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20411 * Set the current slide transition/effect in use for a given
20414 * @param obj The slideshow object
20415 * @param transition The new transition's name string
20417 * If @p transition is implemented in @p obj's theme (i.e., is
20418 * contained in the list returned by
20419 * elm_slideshow_transitions_get()), this new sliding effect will
20420 * be used on the widget.
20422 * @see elm_slideshow_transitions_get() for more details
20424 * @ingroup Slideshow
20426 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
20429 * Get the current slide transition/effect in use for a given
20432 * @param obj The slideshow object
20433 * @return The current transition's name
20435 * @see elm_slideshow_transition_set() for more details
20437 * @ingroup Slideshow
20439 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20442 * Set the interval between each image transition on a given
20443 * slideshow widget, <b>and start the slideshow, itself</b>
20445 * @param obj The slideshow object
20446 * @param timeout The new displaying timeout for images
20448 * After this call, the slideshow widget will start cycling its
20449 * view, sequentially and automatically, with the images of the
20450 * items it has. The time between each new image displayed is going
20451 * to be @p timeout, in @b seconds. If a different timeout was set
20452 * previously and an slideshow was in progress, it will continue
20453 * with the new time between transitions, after this call.
20455 * @note A value less than or equal to 0 on @p timeout will disable
20456 * the widget's internal timer, thus halting any slideshow which
20457 * could be happening on @p obj.
20459 * @see elm_slideshow_timeout_get()
20461 * @ingroup Slideshow
20463 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
20466 * Get the interval set for image transitions on a given slideshow
20469 * @param obj The slideshow object
20470 * @return Returns the timeout set on it
20472 * @see elm_slideshow_timeout_set() for more details
20474 * @ingroup Slideshow
20476 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20479 * Set if, after a slideshow is started, for a given slideshow
20480 * widget, its items should be displayed cyclically or not.
20482 * @param obj The slideshow object
20483 * @param loop Use @c EINA_TRUE to make it cycle through items or
20484 * @c EINA_FALSE for it to stop at the end of @p obj's internal
20487 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
20488 * ignore what is set by this functions, i.e., they'll @b always
20489 * cycle through items. This affects only the "automatic"
20490 * slideshow, as set by elm_slideshow_timeout_set().
20492 * @see elm_slideshow_loop_get()
20494 * @ingroup Slideshow
20496 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
20499 * Get if, after a slideshow is started, for a given slideshow
20500 * widget, its items are to be displayed cyclically or not.
20502 * @param obj The slideshow object
20503 * @return @c EINA_TRUE, if the items in @p obj will be cycled
20504 * through or @c EINA_FALSE, otherwise
20506 * @see elm_slideshow_loop_set() for more details
20508 * @ingroup Slideshow
20510 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20513 * Remove all items from a given slideshow widget
20515 * @param obj The slideshow object
20517 * This removes (and deletes) all items in @p obj, leaving it
20520 * @see elm_slideshow_item_del(), to remove just one item.
20522 * @ingroup Slideshow
20524 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20527 * Get the internal list of items in a given slideshow widget.
20529 * @param obj The slideshow object
20530 * @return The list of items (#Elm_Slideshow_Item as data) or
20531 * @c NULL on errors.
20533 * This list is @b not to be modified in any way and must not be
20534 * freed. Use the list members with functions like
20535 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
20537 * @warning This list is only valid until @p obj object's internal
20538 * items list is changed. It should be fetched again with another
20539 * call to this function when changes happen.
20541 * @ingroup Slideshow
20543 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20546 * Delete a given item from a slideshow widget.
20548 * @param item The slideshow item
20550 * @ingroup Slideshow
20552 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20555 * Return the data associated with a given slideshow item
20557 * @param item The slideshow item
20558 * @return Returns the data associated to this item
20560 * @ingroup Slideshow
20562 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20565 * Returns the currently displayed item, in a given slideshow widget
20567 * @param obj The slideshow object
20568 * @return A handle to the item being displayed in @p obj or
20569 * @c NULL, if none is (and on errors)
20571 * @ingroup Slideshow
20573 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20576 * Get the real Evas object created to implement the view of a
20577 * given slideshow item
20579 * @param item The slideshow item.
20580 * @return the Evas object implementing this item's view.
20582 * This returns the actual Evas object used to implement the
20583 * specified slideshow item's view. This may be @c NULL, as it may
20584 * not have been created or may have been deleted, at any time, by
20585 * the slideshow. <b>Do not modify this object</b> (move, resize,
20586 * show, hide, etc.), as the slideshow is controlling it. This
20587 * function is for querying, emitting custom signals or hooking
20588 * lower level callbacks for events on that object. Do not delete
20589 * this object under any circumstances.
20591 * @see elm_slideshow_item_data_get()
20593 * @ingroup Slideshow
20595 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
20598 * Get the the item, in a given slideshow widget, placed at
20599 * position @p nth, in its internal items list
20601 * @param obj The slideshow object
20602 * @param nth The number of the item to grab a handle to (0 being
20604 * @return The item stored in @p obj at position @p nth or @c NULL,
20605 * if there's no item with that index (and on errors)
20607 * @ingroup Slideshow
20609 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
20612 * Set the current slide layout in use for a given slideshow widget
20614 * @param obj The slideshow object
20615 * @param layout The new layout's name string
20617 * If @p layout is implemented in @p obj's theme (i.e., is contained
20618 * in the list returned by elm_slideshow_layouts_get()), this new
20619 * images layout will be used on the widget.
20621 * @see elm_slideshow_layouts_get() for more details
20623 * @ingroup Slideshow
20625 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
20628 * Get the current slide layout in use for a given slideshow widget
20630 * @param obj The slideshow object
20631 * @return The current layout's name
20633 * @see elm_slideshow_layout_set() for more details
20635 * @ingroup Slideshow
20637 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20640 * Returns the list of @b layout names available, for a given
20641 * slideshow widget.
20643 * @param obj The slideshow object
20644 * @return The list of layouts (list of @b stringshared strings
20647 * Slideshow layouts will change how the widget is to dispose each
20648 * image item in its viewport, with regard to cropping, scaling,
20651 * The layouts, which come from @p obj's theme, must be an EDC
20652 * data item name @c "layouts" on the theme file, with (prefix)
20653 * names of EDC programs actually implementing them.
20655 * The available layouts for slideshows on the default theme are:
20656 * - @c "fullscreen" - item images with original aspect, scaled to
20657 * touch top and down slideshow borders or, if the image's heigh
20658 * is not enough, left and right slideshow borders.
20659 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
20660 * one, but always leaving 10% of the slideshow's dimensions of
20661 * distance between the item image's borders and the slideshow
20662 * borders, for each axis.
20664 * @warning The stringshared strings get no new references
20665 * exclusive to the user grabbing the list, here, so if you'd like
20666 * to use them out of this call's context, you'd better @c
20667 * eina_stringshare_ref() them.
20669 * @see elm_slideshow_layout_set()
20671 * @ingroup Slideshow
20673 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20676 * Set the number of items to cache, on a given slideshow widget,
20677 * <b>before the current item</b>
20679 * @param obj The slideshow object
20680 * @param count Number of items to cache before the current one
20682 * The default value for this property is @c 2. See
20683 * @ref Slideshow_Caching "slideshow caching" for more details.
20685 * @see elm_slideshow_cache_before_get()
20687 * @ingroup Slideshow
20689 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20692 * Retrieve the number of items to cache, on a given slideshow widget,
20693 * <b>before the current item</b>
20695 * @param obj The slideshow object
20696 * @return The number of items set to be cached before the current one
20698 * @see elm_slideshow_cache_before_set() for more details
20700 * @ingroup Slideshow
20702 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20705 * Set the number of items to cache, on a given slideshow widget,
20706 * <b>after the current item</b>
20708 * @param obj The slideshow object
20709 * @param count Number of items to cache after the current one
20711 * The default value for this property is @c 2. See
20712 * @ref Slideshow_Caching "slideshow caching" for more details.
20714 * @see elm_slideshow_cache_after_get()
20716 * @ingroup Slideshow
20718 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20721 * Retrieve the number of items to cache, on a given slideshow widget,
20722 * <b>after the current item</b>
20724 * @param obj The slideshow object
20725 * @return The number of items set to be cached after the current one
20727 * @see elm_slideshow_cache_after_set() for more details
20729 * @ingroup Slideshow
20731 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20734 * Get the number of items stored in a given slideshow widget
20736 * @param obj The slideshow object
20737 * @return The number of items on @p obj, at the moment of this call
20739 * @ingroup Slideshow
20741 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20748 * @defgroup Fileselector File Selector
20750 * @image html img/widget/fileselector/preview-00.png
20751 * @image latex img/widget/fileselector/preview-00.eps
20753 * A file selector is a widget that allows a user to navigate
20754 * through a file system, reporting file selections back via its
20757 * It contains shortcut buttons for home directory (@c ~) and to
20758 * jump one directory upwards (..), as well as cancel/ok buttons to
20759 * confirm/cancel a given selection. After either one of those two
20760 * former actions, the file selector will issue its @c "done" smart
20763 * There's a text entry on it, too, showing the name of the current
20764 * selection. There's the possibility of making it editable, so it
20765 * is useful on file saving dialogs on applications, where one
20766 * gives a file name to save contents to, in a given directory in
20767 * the system. This custom file name will be reported on the @c
20768 * "done" smart callback (explained in sequence).
20770 * Finally, it has a view to display file system items into in two
20775 * If Elementary is built with support of the Ethumb thumbnailing
20776 * library, the second form of view will display preview thumbnails
20777 * of files which it supports.
20779 * Smart callbacks one can register to:
20781 * - @c "selected" - the user has clicked on a file (when not in
20782 * folders-only mode) or directory (when in folders-only mode)
20783 * - @c "directory,open" - the list has been populated with new
20784 * content (@c event_info is a pointer to the directory's
20785 * path, a @b stringshared string)
20786 * - @c "done" - the user has clicked on the "ok" or "cancel"
20787 * buttons (@c event_info is a pointer to the selection's
20788 * path, a @b stringshared string)
20790 * Here is an example on its usage:
20791 * @li @ref fileselector_example
20795 * @addtogroup Fileselector
20800 * Defines how a file selector widget is to layout its contents
20801 * (file system entries).
20803 typedef enum _Elm_Fileselector_Mode
20805 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
20806 ELM_FILESELECTOR_GRID, /**< layout as a grid */
20807 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
20808 } Elm_Fileselector_Mode;
20811 * Add a new file selector widget to the given parent Elementary
20812 * (container) object
20814 * @param parent The parent object
20815 * @return a new file selector widget handle or @c NULL, on errors
20817 * This function inserts a new file selector widget on the canvas.
20819 * @ingroup Fileselector
20821 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20824 * Enable/disable the file name entry box where the user can type
20825 * in a name for a file, in a given file selector widget
20827 * @param obj The file selector object
20828 * @param is_save @c EINA_TRUE to make the file selector a "saving
20829 * dialog", @c EINA_FALSE otherwise
20831 * Having the entry editable is useful on file saving dialogs on
20832 * applications, where one gives a file name to save contents to,
20833 * in a given directory in the system. This custom file name will
20834 * be reported on the @c "done" smart callback.
20836 * @see elm_fileselector_is_save_get()
20838 * @ingroup Fileselector
20840 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
20843 * Get whether the given file selector is in "saving dialog" mode
20845 * @param obj The file selector object
20846 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
20847 * mode, @c EINA_FALSE otherwise (and on errors)
20849 * @see elm_fileselector_is_save_set() for more details
20851 * @ingroup Fileselector
20853 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20856 * Enable/disable folder-only view for a given file selector widget
20858 * @param obj The file selector object
20859 * @param only @c EINA_TRUE to make @p obj only display
20860 * directories, @c EINA_FALSE to make files to be displayed in it
20863 * If enabled, the widget's view will only display folder items,
20866 * @see elm_fileselector_folder_only_get()
20868 * @ingroup Fileselector
20870 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
20873 * Get whether folder-only view is set for a given file selector
20876 * @param obj The file selector object
20877 * @return only @c EINA_TRUE if @p obj is only displaying
20878 * directories, @c EINA_FALSE if files are being displayed in it
20879 * too (and on errors)
20881 * @see elm_fileselector_folder_only_get()
20883 * @ingroup Fileselector
20885 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20888 * Enable/disable the "ok" and "cancel" buttons on a given file
20891 * @param obj The file selector object
20892 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
20894 * @note A file selector without those buttons will never emit the
20895 * @c "done" smart event, and is only usable if one is just hooking
20896 * to the other two events.
20898 * @see elm_fileselector_buttons_ok_cancel_get()
20900 * @ingroup Fileselector
20902 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
20905 * Get whether the "ok" and "cancel" buttons on a given file
20906 * selector widget are being shown.
20908 * @param obj The file selector object
20909 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
20910 * otherwise (and on errors)
20912 * @see elm_fileselector_buttons_ok_cancel_set() for more details
20914 * @ingroup Fileselector
20916 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20919 * Enable/disable a tree view in the given file selector widget,
20920 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
20922 * @param obj The file selector object
20923 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
20926 * In a tree view, arrows are created on the sides of directories,
20927 * allowing them to expand in place.
20929 * @note If it's in other mode, the changes made by this function
20930 * will only be visible when one switches back to "list" mode.
20932 * @see elm_fileselector_expandable_get()
20934 * @ingroup Fileselector
20936 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
20939 * Get whether tree view is enabled for the given file selector
20942 * @param obj The file selector object
20943 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
20944 * otherwise (and or errors)
20946 * @see elm_fileselector_expandable_set() for more details
20948 * @ingroup Fileselector
20950 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20953 * Set, programmatically, the @b directory that a given file
20954 * selector widget will display contents from
20956 * @param obj The file selector object
20957 * @param path The path to display in @p obj
20959 * This will change the @b directory that @p obj is displaying. It
20960 * will also clear the text entry area on the @p obj object, which
20961 * displays select files' names.
20963 * @see elm_fileselector_path_get()
20965 * @ingroup Fileselector
20967 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
20970 * Get the parent directory's path that a given file selector
20971 * widget is displaying
20973 * @param obj The file selector object
20974 * @return The (full) path of the directory the file selector is
20975 * displaying, a @b stringshared string
20977 * @see elm_fileselector_path_set()
20979 * @ingroup Fileselector
20981 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20984 * Set, programmatically, the currently selected file/directory in
20985 * the given file selector widget
20987 * @param obj The file selector object
20988 * @param path The (full) path to a file or directory
20989 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
20990 * latter case occurs if the directory or file pointed to do not
20993 * @see elm_fileselector_selected_get()
20995 * @ingroup Fileselector
20997 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
21000 * Get the currently selected item's (full) path, in the given file
21003 * @param obj The file selector object
21004 * @return The absolute path of the selected item, a @b
21005 * stringshared string
21007 * @note Custom editions on @p obj object's text entry, if made,
21008 * will appear on the return string of this function, naturally.
21010 * @see elm_fileselector_selected_set() for more details
21012 * @ingroup Fileselector
21014 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21017 * Set the mode in which a given file selector widget will display
21018 * (layout) file system entries in its view
21020 * @param obj The file selector object
21021 * @param mode The mode of the fileselector, being it one of
21022 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
21023 * first one, naturally, will display the files in a list. The
21024 * latter will make the widget to display its entries in a grid
21027 * @note By using elm_fileselector_expandable_set(), the user may
21028 * trigger a tree view for that list.
21030 * @note If Elementary is built with support of the Ethumb
21031 * thumbnailing library, the second form of view will display
21032 * preview thumbnails of files which it supports. You must have
21033 * elm_need_ethumb() called in your Elementary for thumbnailing to
21036 * @see elm_fileselector_expandable_set().
21037 * @see elm_fileselector_mode_get().
21039 * @ingroup Fileselector
21041 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
21044 * Get the mode in which a given file selector widget is displaying
21045 * (layouting) file system entries in its view
21047 * @param obj The fileselector object
21048 * @return The mode in which the fileselector is at
21050 * @see elm_fileselector_mode_set() for more details
21052 * @ingroup Fileselector
21054 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21061 * @defgroup Progressbar Progress bar
21063 * The progress bar is a widget for visually representing the
21064 * progress status of a given job/task.
21066 * A progress bar may be horizontal or vertical. It may display an
21067 * icon besides it, as well as primary and @b units labels. The
21068 * former is meant to label the widget as a whole, while the
21069 * latter, which is formatted with floating point values (and thus
21070 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
21071 * units"</c>), is meant to label the widget's <b>progress
21072 * value</b>. Label, icon and unit strings/objects are @b optional
21073 * for progress bars.
21075 * A progress bar may be @b inverted, in which state it gets its
21076 * values inverted, with high values being on the left or top and
21077 * low values on the right or bottom, as opposed to normally have
21078 * the low values on the former and high values on the latter,
21079 * respectively, for horizontal and vertical modes.
21081 * The @b span of the progress, as set by
21082 * elm_progressbar_span_size_set(), is its length (horizontally or
21083 * vertically), unless one puts size hints on the widget to expand
21084 * on desired directions, by any container. That length will be
21085 * scaled by the object or applications scaling factor. At any
21086 * point code can query the progress bar for its value with
21087 * elm_progressbar_value_get().
21089 * Available widget styles for progress bars:
21091 * - @c "wheel" (simple style, no text, no progression, only
21092 * "pulse" effect is available)
21094 * Default contents parts of the progressbar widget that you can use for are:
21095 * @li "elm.swallow.content" - A icon of the progressbar
21097 * Here is an example on its usage:
21098 * @li @ref progressbar_example
21102 * Add a new progress bar widget to the given parent Elementary
21103 * (container) object
21105 * @param parent The parent object
21106 * @return a new progress bar widget handle or @c NULL, on errors
21108 * This function inserts a new progress bar widget on the canvas.
21110 * @ingroup Progressbar
21112 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21115 * Set whether a given progress bar widget is at "pulsing mode" or
21118 * @param obj The progress bar object
21119 * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
21120 * @c EINA_FALSE to put it back to its default one
21122 * By default, progress bars will display values from the low to
21123 * high value boundaries. There are, though, contexts in which the
21124 * state of progression of a given task is @b unknown. For those,
21125 * one can set a progress bar widget to a "pulsing state", to give
21126 * the user an idea that some computation is being held, but
21127 * without exact progress values. In the default theme it will
21128 * animate its bar with the contents filling in constantly and back
21129 * to non-filled, in a loop. To start and stop this pulsing
21130 * animation, one has to explicitly call elm_progressbar_pulse().
21132 * @see elm_progressbar_pulse_get()
21133 * @see elm_progressbar_pulse()
21135 * @ingroup Progressbar
21137 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
21140 * Get whether a given progress bar widget is at "pulsing mode" or
21143 * @param obj The progress bar object
21144 * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
21145 * if it's in the default one (and on errors)
21147 * @ingroup Progressbar
21149 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21152 * Start/stop a given progress bar "pulsing" animation, if its
21155 * @param obj The progress bar object
21156 * @param state @c EINA_TRUE, to @b start the pulsing animation,
21157 * @c EINA_FALSE to @b stop it
21159 * @note This call won't do anything if @p obj is not under "pulsing mode".
21161 * @see elm_progressbar_pulse_set() for more details.
21163 * @ingroup Progressbar
21165 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
21168 * Set the progress value (in percentage) on a given progress bar
21171 * @param obj The progress bar object
21172 * @param val The progress value (@b must be between @c 0.0 and @c
21175 * Use this call to set progress bar levels.
21177 * @note If you passes a value out of the specified range for @p
21178 * val, it will be interpreted as the @b closest of the @b boundary
21179 * values in the range.
21181 * @ingroup Progressbar
21183 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21186 * Get the progress value (in percentage) on a given progress bar
21189 * @param obj The progress bar object
21190 * @return The value of the progressbar
21192 * @see elm_progressbar_value_set() for more details
21194 * @ingroup Progressbar
21196 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21199 * Set the label of a given progress bar widget
21201 * @param obj The progress bar object
21202 * @param label The text label string, in UTF-8
21204 * @ingroup Progressbar
21205 * @deprecated use elm_object_text_set() instead.
21207 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
21210 * Get the label of a given progress bar widget
21212 * @param obj The progressbar object
21213 * @return The text label string, in UTF-8
21215 * @ingroup Progressbar
21216 * @deprecated use elm_object_text_set() instead.
21218 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21221 * Set the icon object of a given progress bar widget
21223 * @param obj The progress bar object
21224 * @param icon The icon object
21226 * Use this call to decorate @p obj with an icon next to it.
21228 * @note Once the icon object is set, a previously set one will be
21229 * deleted. If you want to keep that old content object, use the
21230 * elm_progressbar_icon_unset() function.
21232 * @see elm_progressbar_icon_get()
21233 * @deprecated use elm_object_content_set() instead.
21235 * @ingroup Progressbar
21237 EINA_DEPRECATED EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
21240 * Retrieve the icon object set for a given progress bar widget
21242 * @param obj The progress bar object
21243 * @return The icon object's handle, if @p obj had one set, or @c NULL,
21244 * otherwise (and on errors)
21246 * @see elm_progressbar_icon_set() for more details
21247 * @deprecated use elm_object_content_set() instead.
21249 * @ingroup Progressbar
21251 EINA_DEPRECATED EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21254 * Unset an icon set on a given progress bar widget
21256 * @param obj The progress bar object
21257 * @return The icon object that was being used, if any was set, or
21258 * @c NULL, otherwise (and on errors)
21260 * This call will unparent and return the icon object which was set
21261 * for this widget, previously, on success.
21263 * @see elm_progressbar_icon_set() for more details
21264 * @deprecated use elm_object_content_unset() instead.
21266 * @ingroup Progressbar
21268 EINA_DEPRECATED EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
21271 * Set the (exact) length of the bar region of a given progress bar
21274 * @param obj The progress bar object
21275 * @param size The length of the progress bar's bar region
21277 * This sets the minimum width (when in horizontal mode) or height
21278 * (when in vertical mode) of the actual bar area of the progress
21279 * bar @p obj. This in turn affects the object's minimum size. Use
21280 * this when you're not setting other size hints expanding on the
21281 * given direction (like weight and alignment hints) and you would
21282 * like it to have a specific size.
21284 * @note Icon, label and unit text around @p obj will require their
21285 * own space, which will make @p obj to require more the @p size,
21288 * @see elm_progressbar_span_size_get()
21290 * @ingroup Progressbar
21292 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
21295 * Get the length set for the bar region of a given progress bar
21298 * @param obj The progress bar object
21299 * @return The length of the progress bar's bar region
21301 * If that size was not set previously, with
21302 * elm_progressbar_span_size_set(), this call will return @c 0.
21304 * @ingroup Progressbar
21306 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21309 * Set the format string for a given progress bar widget's units
21312 * @param obj The progress bar object
21313 * @param format The format string for @p obj's units label
21315 * If @c NULL is passed on @p format, it will make @p obj's units
21316 * area to be hidden completely. If not, it'll set the <b>format
21317 * string</b> for the units label's @b text. The units label is
21318 * provided a floating point value, so the units text is up display
21319 * at most one floating point falue. Note that the units label is
21320 * optional. Use a format string such as "%1.2f meters" for
21323 * @note The default format string for a progress bar is an integer
21324 * percentage, as in @c "%.0f %%".
21326 * @see elm_progressbar_unit_format_get()
21328 * @ingroup Progressbar
21330 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
21333 * Retrieve the format string set for a given progress bar widget's
21336 * @param obj The progress bar object
21337 * @return The format set string for @p obj's units label or
21338 * @c NULL, if none was set (and on errors)
21340 * @see elm_progressbar_unit_format_set() for more details
21342 * @ingroup Progressbar
21344 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21347 * Set the orientation of a given progress bar widget
21349 * @param obj The progress bar object
21350 * @param horizontal Use @c EINA_TRUE to make @p obj to be
21351 * @b horizontal, @c EINA_FALSE to make it @b vertical
21353 * Use this function to change how your progress bar is to be
21354 * disposed: vertically or horizontally.
21356 * @see elm_progressbar_horizontal_get()
21358 * @ingroup Progressbar
21360 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21363 * Retrieve the orientation of a given progress bar widget
21365 * @param obj The progress bar object
21366 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
21367 * @c EINA_FALSE if it's @b vertical (and on errors)
21369 * @see elm_progressbar_horizontal_set() for more details
21371 * @ingroup Progressbar
21373 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21376 * Invert a given progress bar widget's displaying values order
21378 * @param obj The progress bar object
21379 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
21380 * @c EINA_FALSE to bring it back to default, non-inverted values.
21382 * A progress bar may be @b inverted, in which state it gets its
21383 * values inverted, with high values being on the left or top and
21384 * low values on the right or bottom, as opposed to normally have
21385 * the low values on the former and high values on the latter,
21386 * respectively, for horizontal and vertical modes.
21388 * @see elm_progressbar_inverted_get()
21390 * @ingroup Progressbar
21392 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
21395 * Get whether a given progress bar widget's displaying values are
21398 * @param obj The progress bar object
21399 * @return @c EINA_TRUE, if @p obj has inverted values,
21400 * @c EINA_FALSE otherwise (and on errors)
21402 * @see elm_progressbar_inverted_set() for more details
21404 * @ingroup Progressbar
21406 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21409 * @defgroup Separator Separator
21411 * @brief Separator is a very thin object used to separate other objects.
21413 * A separator can be vertical or horizontal.
21415 * @ref tutorial_separator is a good example of how to use a separator.
21419 * @brief Add a separator object to @p parent
21421 * @param parent The parent object
21423 * @return The separator object, or NULL upon failure
21425 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21427 * @brief Set the horizontal mode of a separator object
21429 * @param obj The separator object
21430 * @param horizontal If true, the separator is horizontal
21432 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21434 * @brief Get the horizontal mode of a separator object
21436 * @param obj The separator object
21437 * @return If true, the separator is horizontal
21439 * @see elm_separator_horizontal_set()
21441 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21447 * @defgroup Spinner Spinner
21448 * @ingroup Elementary
21450 * @image html img/widget/spinner/preview-00.png
21451 * @image latex img/widget/spinner/preview-00.eps
21453 * A spinner is a widget which allows the user to increase or decrease
21454 * numeric values using arrow buttons, or edit values directly, clicking
21455 * over it and typing the new value.
21457 * By default the spinner will not wrap and has a label
21458 * of "%.0f" (just showing the integer value of the double).
21460 * A spinner has a label that is formatted with floating
21461 * point values and thus accepts a printf-style format string, like
21462 * ā%1.2f unitsā.
21464 * It also allows specific values to be replaced by pre-defined labels.
21466 * Smart callbacks one can register to:
21468 * - "changed" - Whenever the spinner value is changed.
21469 * - "delay,changed" - A short time after the value is changed by the user.
21470 * This will be called only when the user stops dragging for a very short
21471 * period or when they release their finger/mouse, so it avoids possibly
21472 * expensive reactions to the value change.
21474 * Available styles for it:
21476 * - @c "vertical": up/down buttons at the right side and text left aligned.
21478 * Here is an example on its usage:
21479 * @ref spinner_example
21483 * @addtogroup Spinner
21488 * Add a new spinner widget to the given parent Elementary
21489 * (container) object.
21491 * @param parent The parent object.
21492 * @return a new spinner widget handle or @c NULL, on errors.
21494 * This function inserts a new spinner widget on the canvas.
21499 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21502 * Set the format string of the displayed label.
21504 * @param obj The spinner object.
21505 * @param fmt The format string for the label display.
21507 * If @c NULL, this sets the format to "%.0f". If not it sets the format
21508 * string for the label text. The label text is provided a floating point
21509 * value, so the label text can display up to 1 floating point value.
21510 * Note that this is optional.
21512 * Use a format string such as "%1.2f meters" for example, and it will
21513 * display values like: "3.14 meters" for a value equal to 3.14159.
21515 * Default is "%0.f".
21517 * @see elm_spinner_label_format_get()
21521 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
21524 * Get the label format of the spinner.
21526 * @param obj The spinner object.
21527 * @return The text label format string in UTF-8.
21529 * @see elm_spinner_label_format_set() for details.
21533 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21536 * Set the minimum and maximum values for the spinner.
21538 * @param obj The spinner object.
21539 * @param min The minimum value.
21540 * @param max The maximum value.
21542 * Define the allowed range of values to be selected by the user.
21544 * If actual value is less than @p min, it will be updated to @p min. If it
21545 * is bigger then @p max, will be updated to @p max. Actual value can be
21546 * get with elm_spinner_value_get().
21548 * By default, min is equal to 0, and max is equal to 100.
21550 * @warning Maximum must be greater than minimum.
21552 * @see elm_spinner_min_max_get()
21556 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
21559 * Get the minimum and maximum values of the spinner.
21561 * @param obj The spinner object.
21562 * @param min Pointer where to store the minimum value.
21563 * @param max Pointer where to store the maximum value.
21565 * @note If only one value is needed, the other pointer can be passed
21568 * @see elm_spinner_min_max_set() for details.
21572 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
21575 * Set the step used to increment or decrement the spinner value.
21577 * @param obj The spinner object.
21578 * @param step The step value.
21580 * This value will be incremented or decremented to the displayed value.
21581 * It will be incremented while the user keep right or top arrow pressed,
21582 * and will be decremented while the user keep left or bottom arrow pressed.
21584 * The interval to increment / decrement can be set with
21585 * elm_spinner_interval_set().
21587 * By default step value is equal to 1.
21589 * @see elm_spinner_step_get()
21593 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
21596 * Get the step used to increment or decrement the spinner value.
21598 * @param obj The spinner object.
21599 * @return The step value.
21601 * @see elm_spinner_step_get() for more details.
21605 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21608 * Set the value the spinner displays.
21610 * @param obj The spinner object.
21611 * @param val The value to be displayed.
21613 * Value will be presented on the label following format specified with
21614 * elm_spinner_format_set().
21616 * @warning The value must to be between min and max values. This values
21617 * are set by elm_spinner_min_max_set().
21619 * @see elm_spinner_value_get().
21620 * @see elm_spinner_format_set().
21621 * @see elm_spinner_min_max_set().
21625 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21628 * Get the value displayed by the spinner.
21630 * @param obj The spinner object.
21631 * @return The value displayed.
21633 * @see elm_spinner_value_set() for details.
21637 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21640 * Set whether the spinner should wrap when it reaches its
21641 * minimum or maximum value.
21643 * @param obj The spinner object.
21644 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
21647 * Disabled by default. If disabled, when the user tries to increment the
21649 * but displayed value plus step value is bigger than maximum value,
21651 * won't allow it. The same happens when the user tries to decrement it,
21652 * but the value less step is less than minimum value.
21654 * When wrap is enabled, in such situations it will allow these changes,
21655 * but will get the value that would be less than minimum and subtracts
21656 * from maximum. Or add the value that would be more than maximum to
21660 * @li min value = 10
21661 * @li max value = 50
21662 * @li step value = 20
21663 * @li displayed value = 20
21665 * When the user decrement value (using left or bottom arrow), it will
21666 * displays @c 40, because max - (min - (displayed - step)) is
21667 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
21669 * @see elm_spinner_wrap_get().
21673 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
21676 * Get whether the spinner should wrap when it reaches its
21677 * minimum or maximum value.
21679 * @param obj The spinner object
21680 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
21681 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21683 * @see elm_spinner_wrap_set() for details.
21687 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21690 * Set whether the spinner can be directly edited by the user or not.
21692 * @param obj The spinner object.
21693 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
21694 * don't allow users to edit it directly.
21696 * Spinner objects can have edition @b disabled, in which state they will
21697 * be changed only by arrows.
21698 * Useful for contexts
21699 * where you don't want your users to interact with it writting the value.
21701 * when using special values, the user can see real value instead
21702 * of special label on edition.
21704 * It's enabled by default.
21706 * @see elm_spinner_editable_get()
21710 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
21713 * Get whether the spinner can be directly edited by the user or not.
21715 * @param obj The spinner object.
21716 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
21717 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21719 * @see elm_spinner_editable_set() for details.
21723 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21726 * Set a special string to display in the place of the numerical value.
21728 * @param obj The spinner object.
21729 * @param value The value to be replaced.
21730 * @param label The label to be used.
21732 * It's useful for cases when a user should select an item that is
21733 * better indicated by a label than a value. For example, weekdays or months.
21737 * sp = elm_spinner_add(win);
21738 * elm_spinner_min_max_set(sp, 1, 3);
21739 * elm_spinner_special_value_add(sp, 1, "January");
21740 * elm_spinner_special_value_add(sp, 2, "February");
21741 * elm_spinner_special_value_add(sp, 3, "March");
21742 * evas_object_show(sp);
21747 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
21750 * Set the interval on time updates for an user mouse button hold
21751 * on spinner widgets' arrows.
21753 * @param obj The spinner object.
21754 * @param interval The (first) interval value in seconds.
21756 * This interval value is @b decreased while the user holds the
21757 * mouse pointer either incrementing or decrementing spinner's value.
21759 * This helps the user to get to a given value distant from the
21760 * current one easier/faster, as it will start to change quicker and
21761 * quicker on mouse button holds.
21763 * The calculation for the next change interval value, starting from
21764 * the one set with this call, is the previous interval divided by
21765 * @c 1.05, so it decreases a little bit.
21767 * The default starting interval value for automatic changes is
21770 * @see elm_spinner_interval_get()
21774 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21777 * Get the interval on time updates for an user mouse button hold
21778 * on spinner widgets' arrows.
21780 * @param obj The spinner object.
21781 * @return The (first) interval value, in seconds, set on it.
21783 * @see elm_spinner_interval_set() for more details.
21787 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21794 * @defgroup Index Index
21796 * @image html img/widget/index/preview-00.png
21797 * @image latex img/widget/index/preview-00.eps
21799 * An index widget gives you an index for fast access to whichever
21800 * group of other UI items one might have. It's a list of text
21801 * items (usually letters, for alphabetically ordered access).
21803 * Index widgets are by default hidden and just appear when the
21804 * user clicks over it's reserved area in the canvas. In its
21805 * default theme, it's an area one @ref Fingers "finger" wide on
21806 * the right side of the index widget's container.
21808 * When items on the index are selected, smart callbacks get
21809 * called, so that its user can make other container objects to
21810 * show a given area or child object depending on the index item
21811 * selected. You'd probably be using an index together with @ref
21812 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
21815 * Smart events one can add callbacks for are:
21816 * - @c "changed" - When the selected index item changes. @c
21817 * event_info is the selected item's data pointer.
21818 * - @c "delay,changed" - When the selected index item changes, but
21819 * after a small idling period. @c event_info is the selected
21820 * item's data pointer.
21821 * - @c "selected" - When the user releases a mouse button and
21822 * selects an item. @c event_info is the selected item's data
21824 * - @c "level,up" - when the user moves a finger from the first
21825 * level to the second level
21826 * - @c "level,down" - when the user moves a finger from the second
21827 * level to the first level
21829 * The @c "delay,changed" event is so that it'll wait a small time
21830 * before actually reporting those events and, moreover, just the
21831 * last event happening on those time frames will actually be
21834 * Here are some examples on its usage:
21835 * @li @ref index_example_01
21836 * @li @ref index_example_02
21840 * @addtogroup Index
21844 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
21847 * Add a new index widget to the given parent Elementary
21848 * (container) object
21850 * @param parent The parent object
21851 * @return a new index widget handle or @c NULL, on errors
21853 * This function inserts a new index widget on the canvas.
21857 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21860 * Set whether a given index widget is or not visible,
21863 * @param obj The index object
21864 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
21866 * Not to be confused with visible as in @c evas_object_show() --
21867 * visible with regard to the widget's auto hiding feature.
21869 * @see elm_index_active_get()
21873 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
21876 * Get whether a given index widget is currently visible or not.
21878 * @param obj The index object
21879 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
21881 * @see elm_index_active_set() for more details
21885 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21888 * Set the items level for a given index widget.
21890 * @param obj The index object.
21891 * @param level @c 0 or @c 1, the currently implemented levels.
21893 * @see elm_index_item_level_get()
21897 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21900 * Get the items level set for a given index widget.
21902 * @param obj The index object.
21903 * @return @c 0 or @c 1, which are the levels @p obj might be at.
21905 * @see elm_index_item_level_set() for more information
21909 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21912 * Returns the last selected item's data, for a given index widget.
21914 * @param obj The index object.
21915 * @return The item @b data associated to the last selected item on
21916 * @p obj (or @c NULL, on errors).
21918 * @warning The returned value is @b not an #Elm_Index_Item item
21919 * handle, but the data associated to it (see the @c item parameter
21920 * in elm_index_item_append(), as an example).
21924 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21927 * Append a new item on a given index widget.
21929 * @param obj The index object.
21930 * @param letter Letter under which the item should be indexed
21931 * @param item The item data to set for the index's item
21933 * Despite the most common usage of the @p letter argument is for
21934 * single char strings, one could use arbitrary strings as index
21937 * @c item will be the pointer returned back on @c "changed", @c
21938 * "delay,changed" and @c "selected" smart events.
21942 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21945 * Prepend a new item on a given index widget.
21947 * @param obj The index object.
21948 * @param letter Letter under which the item should be indexed
21949 * @param item The item data to set for the index's item
21951 * Despite the most common usage of the @p letter argument is for
21952 * single char strings, one could use arbitrary strings as index
21955 * @c item will be the pointer returned back on @c "changed", @c
21956 * "delay,changed" and @c "selected" smart events.
21960 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21963 * Append a new item, on a given index widget, <b>after the item
21964 * having @p relative as data</b>.
21966 * @param obj The index object.
21967 * @param letter Letter under which the item should be indexed
21968 * @param item The item data to set for the index's item
21969 * @param relative The item data of the index item to be the
21970 * predecessor of this new one
21972 * Despite the most common usage of the @p letter argument is for
21973 * single char strings, one could use arbitrary strings as index
21976 * @c item will be the pointer returned back on @c "changed", @c
21977 * "delay,changed" and @c "selected" smart events.
21979 * @note If @p relative is @c NULL or if it's not found to be data
21980 * set on any previous item on @p obj, this function will behave as
21981 * elm_index_item_append().
21985 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
21988 * Prepend a new item, on a given index widget, <b>after the item
21989 * having @p relative as data</b>.
21991 * @param obj The index object.
21992 * @param letter Letter under which the item should be indexed
21993 * @param item The item data to set for the index's item
21994 * @param relative The item data of the index item to be the
21995 * successor of this new one
21997 * Despite the most common usage of the @p letter argument is for
21998 * single char strings, one could use arbitrary strings as index
22001 * @c item will be the pointer returned back on @c "changed", @c
22002 * "delay,changed" and @c "selected" smart events.
22004 * @note If @p relative is @c NULL or if it's not found to be data
22005 * set on any previous item on @p obj, this function will behave as
22006 * elm_index_item_prepend().
22010 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
22013 * Insert a new item into the given index widget, using @p cmp_func
22014 * function to sort items (by item handles).
22016 * @param obj The index object.
22017 * @param letter Letter under which the item should be indexed
22018 * @param item The item data to set for the index's item
22019 * @param cmp_func The comparing function to be used to sort index
22020 * items <b>by #Elm_Index_Item item handles</b>
22021 * @param cmp_data_func A @b fallback function to be called for the
22022 * sorting of index items <b>by item data</b>). It will be used
22023 * when @p cmp_func returns @c 0 (equality), which means an index
22024 * item with provided item data already exists. To decide which
22025 * data item should be pointed to by the index item in question, @p
22026 * cmp_data_func will be used. If @p cmp_data_func returns a
22027 * non-negative value, the previous index item data will be
22028 * replaced by the given @p item pointer. If the previous data need
22029 * to be freed, it should be done by the @p cmp_data_func function,
22030 * because all references to it will be lost. If this function is
22031 * not provided (@c NULL is given), index items will be @b
22032 * duplicated, if @p cmp_func returns @c 0.
22034 * Despite the most common usage of the @p letter argument is for
22035 * single char strings, one could use arbitrary strings as index
22038 * @c item will be the pointer returned back on @c "changed", @c
22039 * "delay,changed" and @c "selected" smart events.
22043 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);
22046 * Remove an item from a given index widget, <b>to be referenced by
22047 * it's data value</b>.
22049 * @param obj The index object
22050 * @param item The item's data pointer for the item to be removed
22053 * If a deletion callback is set, via elm_index_item_del_cb_set(),
22054 * that callback function will be called by this one.
22056 * @warning The item to be removed from @p obj will be found via
22057 * its item data pointer, and not by an #Elm_Index_Item handle.
22061 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22064 * Find a given index widget's item, <b>using item data</b>.
22066 * @param obj The index object
22067 * @param item The item data pointed to by the desired index item
22068 * @return The index item handle, if found, or @c NULL otherwise
22072 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22075 * Removes @b all items from a given index widget.
22077 * @param obj The index object.
22079 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
22080 * that callback function will be called for each item in @p obj.
22084 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22087 * Go to a given items level on a index widget
22089 * @param obj The index object
22090 * @param level The index level (one of @c 0 or @c 1)
22094 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22097 * Return the data associated with a given index widget item
22099 * @param it The index widget item handle
22100 * @return The data associated with @p it
22102 * @see elm_index_item_data_set()
22106 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22109 * Set the data associated with a given index widget item
22111 * @param it The index widget item handle
22112 * @param data The new data pointer to set to @p it
22114 * This sets new item data on @p it.
22116 * @warning The old data pointer won't be touched by this function, so
22117 * the user had better to free that old data himself/herself.
22121 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
22124 * Set the function to be called when a given index widget item is freed.
22126 * @param it The item to set the callback on
22127 * @param func The function to call on the item's deletion
22129 * When called, @p func will have both @c data and @c event_info
22130 * arguments with the @p it item's data value and, naturally, the
22131 * @c obj argument with a handle to the parent index widget.
22135 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
22138 * Get the letter (string) set on a given index widget item.
22140 * @param it The index item handle
22141 * @return The letter string set on @p it
22145 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22152 * @defgroup Photocam Photocam
22154 * @image html img/widget/photocam/preview-00.png
22155 * @image latex img/widget/photocam/preview-00.eps
22157 * This is a widget specifically for displaying high-resolution digital
22158 * camera photos giving speedy feedback (fast load), low memory footprint
22159 * and zooming and panning as well as fitting logic. It is entirely focused
22160 * on jpeg images, and takes advantage of properties of the jpeg format (via
22161 * evas loader features in the jpeg loader).
22163 * Signals that you can add callbacks for are:
22164 * @li "clicked" - This is called when a user has clicked the photo without
22166 * @li "press" - This is called when a user has pressed down on the photo.
22167 * @li "longpressed" - This is called when a user has pressed down on the
22168 * photo for a long time without dragging around.
22169 * @li "clicked,double" - This is called when a user has double-clicked the
22171 * @li "load" - Photo load begins.
22172 * @li "loaded" - This is called when the image file load is complete for the
22173 * first view (low resolution blurry version).
22174 * @li "load,detail" - Photo detailed data load begins.
22175 * @li "loaded,detail" - This is called when the image file load is complete
22176 * for the detailed image data (full resolution needed).
22177 * @li "zoom,start" - Zoom animation started.
22178 * @li "zoom,stop" - Zoom animation stopped.
22179 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
22180 * @li "scroll" - the content has been scrolled (moved)
22181 * @li "scroll,anim,start" - scrolling animation has started
22182 * @li "scroll,anim,stop" - scrolling animation has stopped
22183 * @li "scroll,drag,start" - dragging the contents around has started
22184 * @li "scroll,drag,stop" - dragging the contents around has stopped
22186 * @ref tutorial_photocam shows the API in action.
22190 * @brief Types of zoom available.
22192 typedef enum _Elm_Photocam_Zoom_Mode
22194 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
22195 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
22196 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
22197 ELM_PHOTOCAM_ZOOM_MODE_LAST
22198 } Elm_Photocam_Zoom_Mode;
22200 * @brief Add a new Photocam object
22202 * @param parent The parent object
22203 * @return The new object or NULL if it cannot be created
22205 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22207 * @brief Set the photo file to be shown
22209 * @param obj The photocam object
22210 * @param file The photo file
22211 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
22213 * This sets (and shows) the specified file (with a relative or absolute
22214 * path) and will return a load error (same error that
22215 * evas_object_image_load_error_get() will return). The image will change and
22216 * adjust its size at this point and begin a background load process for this
22217 * photo that at some time in the future will be displayed at the full
22220 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
22222 * @brief Returns the path of the current image file
22224 * @param obj The photocam object
22225 * @return Returns the path
22227 * @see elm_photocam_file_set()
22229 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22231 * @brief Set the zoom level of the photo
22233 * @param obj The photocam object
22234 * @param zoom The zoom level to set
22236 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
22237 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
22238 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
22239 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
22242 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
22244 * @brief Get the zoom level of the photo
22246 * @param obj The photocam object
22247 * @return The current zoom level
22249 * This returns the current zoom level of the photocam object. Note that if
22250 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
22251 * (which is the default), the zoom level may be changed at any time by the
22252 * photocam object itself to account for photo size and photocam viewpoer
22255 * @see elm_photocam_zoom_set()
22256 * @see elm_photocam_zoom_mode_set()
22258 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22260 * @brief Set the zoom mode
22262 * @param obj The photocam object
22263 * @param mode The desired mode
22265 * This sets the zoom mode to manual or one of several automatic levels.
22266 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
22267 * elm_photocam_zoom_set() and will stay at that level until changed by code
22268 * or until zoom mode is changed. This is the default mode. The Automatic
22269 * modes will allow the photocam object to automatically adjust zoom mode
22270 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
22271 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
22272 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
22273 * pixels within the frame are left unfilled.
22275 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22277 * @brief Get the zoom mode
22279 * @param obj The photocam object
22280 * @return The current zoom mode
22282 * This gets the current zoom mode of the photocam object.
22284 * @see elm_photocam_zoom_mode_set()
22286 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22288 * @brief Get the current image pixel width and height
22290 * @param obj The photocam object
22291 * @param w A pointer to the width return
22292 * @param h A pointer to the height return
22294 * This gets the current photo pixel width and height (for the original).
22295 * The size will be returned in the integers @p w and @p h that are pointed
22298 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
22300 * @brief Get the area of the image that is currently shown
22303 * @param x A pointer to the X-coordinate of region
22304 * @param y A pointer to the Y-coordinate of region
22305 * @param w A pointer to the width
22306 * @param h A pointer to the height
22308 * @see elm_photocam_image_region_show()
22309 * @see elm_photocam_image_region_bring_in()
22311 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
22313 * @brief Set the viewed portion of the image
22315 * @param obj The photocam object
22316 * @param x X-coordinate of region in image original pixels
22317 * @param y Y-coordinate of region in image original pixels
22318 * @param w Width of region in image original pixels
22319 * @param h Height of region in image original pixels
22321 * This shows the region of the image without using animation.
22323 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22325 * @brief Bring in the viewed portion of the image
22327 * @param obj The photocam object
22328 * @param x X-coordinate of region in image original pixels
22329 * @param y Y-coordinate of region in image original pixels
22330 * @param w Width of region in image original pixels
22331 * @param h Height of region in image original pixels
22333 * This shows the region of the image using animation.
22335 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22337 * @brief Set the paused state for photocam
22339 * @param obj The photocam object
22340 * @param paused The pause state to set
22342 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
22343 * photocam. The default is off. This will stop zooming using animation on
22344 * zoom levels changes and change instantly. This will stop any existing
22345 * animations that are running.
22347 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22349 * @brief Get the paused state for photocam
22351 * @param obj The photocam object
22352 * @return The current paused state
22354 * This gets the current paused state for the photocam object.
22356 * @see elm_photocam_paused_set()
22358 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22360 * @brief Get the internal low-res image used for photocam
22362 * @param obj The photocam object
22363 * @return The internal image object handle, or NULL if none exists
22365 * This gets the internal image object inside photocam. Do not modify it. It
22366 * is for inspection only, and hooking callbacks to. Nothing else. It may be
22367 * deleted at any time as well.
22369 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22371 * @brief Set the photocam scrolling bouncing.
22373 * @param obj The photocam object
22374 * @param h_bounce bouncing for horizontal
22375 * @param v_bounce bouncing for vertical
22377 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22379 * @brief Get the photocam scrolling bouncing.
22381 * @param obj The photocam object
22382 * @param h_bounce bouncing for horizontal
22383 * @param v_bounce bouncing for vertical
22385 * @see elm_photocam_bounce_set()
22387 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
22393 * @defgroup Map Map
22394 * @ingroup Elementary
22396 * @image html img/widget/map/preview-00.png
22397 * @image latex img/widget/map/preview-00.eps
22399 * This is a widget specifically for displaying a map. It uses basically
22400 * OpenStreetMap provider http://www.openstreetmap.org/,
22401 * but custom providers can be added.
22403 * It supports some basic but yet nice features:
22404 * @li zoom and scroll
22405 * @li markers with content to be displayed when user clicks over it
22406 * @li group of markers
22409 * Smart callbacks one can listen to:
22411 * - "clicked" - This is called when a user has clicked the map without
22413 * - "press" - This is called when a user has pressed down on the map.
22414 * - "longpressed" - This is called when a user has pressed down on the map
22415 * for a long time without dragging around.
22416 * - "clicked,double" - This is called when a user has double-clicked
22418 * - "load,detail" - Map detailed data load begins.
22419 * - "loaded,detail" - This is called when all currently visible parts of
22420 * the map are loaded.
22421 * - "zoom,start" - Zoom animation started.
22422 * - "zoom,stop" - Zoom animation stopped.
22423 * - "zoom,change" - Zoom changed when using an auto zoom mode.
22424 * - "scroll" - the content has been scrolled (moved).
22425 * - "scroll,anim,start" - scrolling animation has started.
22426 * - "scroll,anim,stop" - scrolling animation has stopped.
22427 * - "scroll,drag,start" - dragging the contents around has started.
22428 * - "scroll,drag,stop" - dragging the contents around has stopped.
22429 * - "downloaded" - This is called when all currently required map images
22431 * - "route,load" - This is called when route request begins.
22432 * - "route,loaded" - This is called when route request ends.
22433 * - "name,load" - This is called when name request begins.
22434 * - "name,loaded- This is called when name request ends.
22436 * Available style for map widget:
22439 * Available style for markers:
22444 * Available style for marker bubble:
22447 * List of examples:
22448 * @li @ref map_example_01
22449 * @li @ref map_example_02
22450 * @li @ref map_example_03
22459 * @enum _Elm_Map_Zoom_Mode
22460 * @typedef Elm_Map_Zoom_Mode
22462 * Set map's zoom behavior. It can be set to manual or automatic.
22464 * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
22466 * Values <b> don't </b> work as bitmask, only one can be choosen.
22468 * @note Valid sizes are 2^zoom, consequently the map may be smaller
22469 * than the scroller view.
22471 * @see elm_map_zoom_mode_set()
22472 * @see elm_map_zoom_mode_get()
22476 typedef enum _Elm_Map_Zoom_Mode
22478 ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
22479 ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
22480 ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
22481 ELM_MAP_ZOOM_MODE_LAST
22482 } Elm_Map_Zoom_Mode;
22485 * @enum _Elm_Map_Route_Sources
22486 * @typedef Elm_Map_Route_Sources
22488 * Set route service to be used. By default used source is
22489 * #ELM_MAP_ROUTE_SOURCE_YOURS.
22491 * @see elm_map_route_source_set()
22492 * @see elm_map_route_source_get()
22496 typedef enum _Elm_Map_Route_Sources
22498 ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
22499 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. */
22500 ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
22501 ELM_MAP_ROUTE_SOURCE_LAST
22502 } Elm_Map_Route_Sources;
22504 typedef enum _Elm_Map_Name_Sources
22506 ELM_MAP_NAME_SOURCE_NOMINATIM,
22507 ELM_MAP_NAME_SOURCE_LAST
22508 } Elm_Map_Name_Sources;
22511 * @enum _Elm_Map_Route_Type
22512 * @typedef Elm_Map_Route_Type
22514 * Set type of transport used on route.
22516 * @see elm_map_route_add()
22520 typedef enum _Elm_Map_Route_Type
22522 ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
22523 ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
22524 ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
22525 ELM_MAP_ROUTE_TYPE_LAST
22526 } Elm_Map_Route_Type;
22529 * @enum _Elm_Map_Route_Method
22530 * @typedef Elm_Map_Route_Method
22532 * Set the routing method, what should be priorized, time or distance.
22534 * @see elm_map_route_add()
22538 typedef enum _Elm_Map_Route_Method
22540 ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
22541 ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
22542 ELM_MAP_ROUTE_METHOD_LAST
22543 } Elm_Map_Route_Method;
22545 typedef enum _Elm_Map_Name_Method
22547 ELM_MAP_NAME_METHOD_SEARCH,
22548 ELM_MAP_NAME_METHOD_REVERSE,
22549 ELM_MAP_NAME_METHOD_LAST
22550 } Elm_Map_Name_Method;
22552 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(). */
22553 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(). */
22554 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(). */
22555 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(). */
22556 typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
22557 typedef struct _Elm_Map_Track Elm_Map_Track;
22559 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. */
22560 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
22561 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
22562 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
22564 typedef char *(*ElmMapModuleSourceFunc) (void);
22565 typedef int (*ElmMapModuleZoomMinFunc) (void);
22566 typedef int (*ElmMapModuleZoomMaxFunc) (void);
22567 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
22568 typedef int (*ElmMapModuleRouteSourceFunc) (void);
22569 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
22570 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
22571 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
22572 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
22575 * Add a new map widget to the given parent Elementary (container) object.
22577 * @param parent The parent object.
22578 * @return a new map widget handle or @c NULL, on errors.
22580 * This function inserts a new map widget on the canvas.
22584 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22587 * Set the zoom level of the map.
22589 * @param obj The map object.
22590 * @param zoom The zoom level to set.
22592 * This sets the zoom level.
22594 * It will respect limits defined by elm_map_source_zoom_min_set() and
22595 * elm_map_source_zoom_max_set().
22597 * By default these values are 0 (world map) and 18 (maximum zoom).
22599 * This function should be used when zoom mode is set to
22600 * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
22601 * with elm_map_zoom_mode_set().
22603 * @see elm_map_zoom_mode_set().
22604 * @see elm_map_zoom_get().
22608 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22611 * Get the zoom level of the map.
22613 * @param obj The map object.
22614 * @return The current zoom level.
22616 * This returns the current zoom level of the map object.
22618 * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
22619 * (which is the default), the zoom level may be changed at any time by the
22620 * map object itself to account for map size and map viewport size.
22622 * @see elm_map_zoom_set() for details.
22626 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22629 * Set the zoom mode used by the map object.
22631 * @param obj The map object.
22632 * @param mode The zoom mode of the map, being it one of
22633 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22634 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22636 * This sets the zoom mode to manual or one of the automatic levels.
22637 * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
22638 * elm_map_zoom_set() and will stay at that level until changed by code
22639 * or until zoom mode is changed. This is the default mode.
22641 * The Automatic modes will allow the map object to automatically
22642 * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
22643 * adjust zoom so the map fits inside the scroll frame with no pixels
22644 * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
22645 * ensure no pixels within the frame are left unfilled. Do not forget that
22646 * the valid sizes are 2^zoom, consequently the map may be smaller than
22647 * the scroller view.
22649 * @see elm_map_zoom_set()
22653 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22656 * Get the zoom mode used by the map object.
22658 * @param obj The map object.
22659 * @return The zoom mode of the map, being it one of
22660 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22661 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22663 * This function returns the current zoom mode used by the map object.
22665 * @see elm_map_zoom_mode_set() for more details.
22669 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22672 * Get the current coordinates of the map.
22674 * @param obj The map object.
22675 * @param lon Pointer where to store longitude.
22676 * @param lat Pointer where to store latitude.
22678 * This gets the current center coordinates of the map object. It can be
22679 * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
22681 * @see elm_map_geo_region_bring_in()
22682 * @see elm_map_geo_region_show()
22686 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
22689 * Animatedly bring in given coordinates to the center of the map.
22691 * @param obj The map object.
22692 * @param lon Longitude to center at.
22693 * @param lat Latitude to center at.
22695 * This causes map to jump to the given @p lat and @p lon coordinates
22696 * and show it (by scrolling) in the center of the viewport, if it is not
22697 * already centered. This will use animation to do so and take a period
22698 * of time to complete.
22700 * @see elm_map_geo_region_show() for a function to avoid animation.
22701 * @see elm_map_geo_region_get()
22705 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22708 * Show the given coordinates at the center of the map, @b immediately.
22710 * @param obj The map object.
22711 * @param lon Longitude to center at.
22712 * @param lat Latitude to center at.
22714 * This causes map to @b redraw its viewport's contents to the
22715 * region contining the given @p lat and @p lon, that will be moved to the
22716 * center of the map.
22718 * @see elm_map_geo_region_bring_in() for a function to move with animation.
22719 * @see elm_map_geo_region_get()
22723 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22726 * Pause or unpause the map.
22728 * @param obj The map object.
22729 * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
22732 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22735 * The default is off.
22737 * This will stop zooming using animation, changing zoom levels will
22738 * change instantly. This will stop any existing animations that are running.
22740 * @see elm_map_paused_get()
22744 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22747 * Get a value whether map is paused or not.
22749 * @param obj The map object.
22750 * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
22751 * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
22753 * This gets the current paused state for the map object.
22755 * @see elm_map_paused_set() for details.
22759 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22762 * Set to show markers during zoom level changes or not.
22764 * @param obj The map object.
22765 * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
22768 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22771 * The default is off.
22773 * This will stop zooming using animation, changing zoom levels will
22774 * change instantly. This will stop any existing animations that are running.
22776 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22779 * The default is off.
22781 * Enabling it will force the map to stop displaying the markers during
22782 * zoom level changes. Set to on if you have a large number of markers.
22784 * @see elm_map_paused_markers_get()
22788 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22791 * Get a value whether markers will be displayed on zoom level changes or not
22793 * @param obj The map object.
22794 * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
22795 * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
22797 * This gets the current markers paused state for the map object.
22799 * @see elm_map_paused_markers_set() for details.
22803 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22806 * Get the information of downloading status.
22808 * @param obj The map object.
22809 * @param try_num Pointer where to store number of tiles being downloaded.
22810 * @param finish_num Pointer where to store number of tiles successfully
22813 * This gets the current downloading status for the map object, the number
22814 * of tiles being downloaded and the number of tiles already downloaded.
22818 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
22821 * Convert a pixel coordinate (x,y) into a geographic coordinate
22822 * (longitude, latitude).
22824 * @param obj The map object.
22825 * @param x the coordinate.
22826 * @param y the coordinate.
22827 * @param size the size in pixels of the map.
22828 * The map is a square and generally his size is : pow(2.0, zoom)*256.
22829 * @param lon Pointer where to store the longitude that correspond to x.
22830 * @param lat Pointer where to store the latitude that correspond to y.
22832 * @note Origin pixel point is the top left corner of the viewport.
22833 * Map zoom and size are taken on account.
22835 * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
22839 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);
22842 * Convert a geographic coordinate (longitude, latitude) into a pixel
22843 * coordinate (x, y).
22845 * @param obj The map object.
22846 * @param lon the longitude.
22847 * @param lat the latitude.
22848 * @param size the size in pixels of the map. The map is a square
22849 * and generally his size is : pow(2.0, zoom)*256.
22850 * @param x Pointer where to store the horizontal pixel coordinate that
22851 * correspond to the longitude.
22852 * @param y Pointer where to store the vertical pixel coordinate that
22853 * correspond to the latitude.
22855 * @note Origin pixel point is the top left corner of the viewport.
22856 * Map zoom and size are taken on account.
22858 * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
22862 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);
22865 * Convert a geographic coordinate (longitude, latitude) into a name
22868 * @param obj The map object.
22869 * @param lon the longitude.
22870 * @param lat the latitude.
22871 * @return name A #Elm_Map_Name handle for this coordinate.
22873 * To get the string for this address, elm_map_name_address_get()
22876 * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
22880 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22883 * Convert a name (address) into a geographic coordinate
22884 * (longitude, latitude).
22886 * @param obj The map object.
22887 * @param name The address.
22888 * @return name A #Elm_Map_Name handle for this address.
22890 * To get the longitude and latitude, elm_map_name_region_get()
22893 * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
22897 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
22900 * Convert a pixel coordinate into a rotated pixel coordinate.
22902 * @param obj The map object.
22903 * @param x horizontal coordinate of the point to rotate.
22904 * @param y vertical coordinate of the point to rotate.
22905 * @param cx rotation's center horizontal position.
22906 * @param cy rotation's center vertical position.
22907 * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
22908 * @param xx Pointer where to store rotated x.
22909 * @param yy Pointer where to store rotated y.
22913 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);
22916 * Add a new marker to the map object.
22918 * @param obj The map object.
22919 * @param lon The longitude of the marker.
22920 * @param lat The latitude of the marker.
22921 * @param clas The class, to use when marker @b isn't grouped to others.
22922 * @param clas_group The class group, to use when marker is grouped to others
22923 * @param data The data passed to the callbacks.
22925 * @return The created marker or @c NULL upon failure.
22927 * A marker will be created and shown in a specific point of the map, defined
22928 * by @p lon and @p lat.
22930 * It will be displayed using style defined by @p class when this marker
22931 * is displayed alone (not grouped). A new class can be created with
22932 * elm_map_marker_class_new().
22934 * If the marker is grouped to other markers, it will be displayed with
22935 * style defined by @p class_group. Markers with the same group are grouped
22936 * if they are close. A new group class can be created with
22937 * elm_map_marker_group_class_new().
22939 * Markers created with this method can be deleted with
22940 * elm_map_marker_remove().
22942 * A marker can have associated content to be displayed by a bubble,
22943 * when a user click over it, as well as an icon. These objects will
22944 * be fetch using class' callback functions.
22946 * @see elm_map_marker_class_new()
22947 * @see elm_map_marker_group_class_new()
22948 * @see elm_map_marker_remove()
22952 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);
22955 * Set the maximum numbers of markers' content to be displayed in a group.
22957 * @param obj The map object.
22958 * @param max The maximum numbers of items displayed in a bubble.
22960 * A bubble will be displayed when the user clicks over the group,
22961 * and will place the content of markers that belong to this group
22964 * A group can have a long list of markers, consequently the creation
22965 * of the content of the bubble can be very slow.
22967 * In order to avoid this, a maximum number of items is displayed
22970 * By default this number is 30.
22972 * Marker with the same group class are grouped if they are close.
22974 * @see elm_map_marker_add()
22978 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
22981 * Remove a marker from the map.
22983 * @param marker The marker to remove.
22985 * @see elm_map_marker_add()
22989 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22992 * Get the current coordinates of the marker.
22994 * @param marker marker.
22995 * @param lat Pointer where to store the marker's latitude.
22996 * @param lon Pointer where to store the marker's longitude.
22998 * These values are set when adding markers, with function
22999 * elm_map_marker_add().
23001 * @see elm_map_marker_add()
23005 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
23008 * Animatedly bring in given marker to the center of the map.
23010 * @param marker The marker to center at.
23012 * This causes map to jump to the given @p marker's coordinates
23013 * and show it (by scrolling) in the center of the viewport, if it is not
23014 * already centered. This will use animation to do so and take a period
23015 * of time to complete.
23017 * @see elm_map_marker_show() for a function to avoid animation.
23018 * @see elm_map_marker_region_get()
23022 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23025 * Show the given marker at the center of the map, @b immediately.
23027 * @param marker The marker to center at.
23029 * This causes map to @b redraw its viewport's contents to the
23030 * region contining the given @p marker's coordinates, that will be
23031 * moved to the center of the map.
23033 * @see elm_map_marker_bring_in() for a function to move with animation.
23034 * @see elm_map_markers_list_show() if more than one marker need to be
23036 * @see elm_map_marker_region_get()
23040 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23043 * Move and zoom the map to display a list of markers.
23045 * @param markers A list of #Elm_Map_Marker handles.
23047 * The map will be centered on the center point of the markers in the list.
23048 * Then the map will be zoomed in order to fit the markers using the maximum
23049 * zoom which allows display of all the markers.
23051 * @warning All the markers should belong to the same map object.
23053 * @see elm_map_marker_show() to show a single marker.
23054 * @see elm_map_marker_bring_in()
23058 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
23061 * Get the Evas object returned by the ElmMapMarkerGetFunc callback
23063 * @param marker The marker wich content should be returned.
23064 * @return Return the evas object if it exists, else @c NULL.
23066 * To set callback function #ElmMapMarkerGetFunc for the marker class,
23067 * elm_map_marker_class_get_cb_set() should be used.
23069 * This content is what will be inside the bubble that will be displayed
23070 * when an user clicks over the marker.
23072 * This returns the actual Evas object used to be placed inside
23073 * the bubble. This may be @c NULL, as it may
23074 * not have been created or may have been deleted, at any time, by
23075 * the map. <b>Do not modify this object</b> (move, resize,
23076 * show, hide, etc.), as the map is controlling it. This
23077 * function is for querying, emitting custom signals or hooking
23078 * lower level callbacks for events on that object. Do not delete
23079 * this object under any circumstances.
23083 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23086 * Update the marker
23088 * @param marker The marker to be updated.
23090 * If a content is set to this marker, it will call function to delete it,
23091 * #ElmMapMarkerDelFunc, and then will fetch the content again with
23092 * #ElmMapMarkerGetFunc.
23094 * These functions are set for the marker class with
23095 * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
23099 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23102 * Close all the bubbles opened by the user.
23104 * @param obj The map object.
23106 * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
23107 * when the user clicks on a marker.
23109 * This functions is set for the marker class with
23110 * elm_map_marker_class_get_cb_set().
23114 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
23117 * Create a new group class.
23119 * @param obj The map object.
23120 * @return Returns the new group class.
23122 * Each marker must be associated to a group class. Markers in the same
23123 * group are grouped if they are close.
23125 * The group class defines the style of the marker when a marker is grouped
23126 * to others markers. When it is alone, another class will be used.
23128 * A group class will need to be provided when creating a marker with
23129 * elm_map_marker_add().
23131 * Some properties and functions can be set by class, as:
23132 * - style, with elm_map_group_class_style_set()
23133 * - data - to be associated to the group class. It can be set using
23134 * elm_map_group_class_data_set().
23135 * - min zoom to display markers, set with
23136 * elm_map_group_class_zoom_displayed_set().
23137 * - max zoom to group markers, set using
23138 * elm_map_group_class_zoom_grouped_set().
23139 * - visibility - set if markers will be visible or not, set with
23140 * elm_map_group_class_hide_set().
23141 * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
23142 * It can be set using elm_map_group_class_icon_cb_set().
23144 * @see elm_map_marker_add()
23145 * @see elm_map_group_class_style_set()
23146 * @see elm_map_group_class_data_set()
23147 * @see elm_map_group_class_zoom_displayed_set()
23148 * @see elm_map_group_class_zoom_grouped_set()
23149 * @see elm_map_group_class_hide_set()
23150 * @see elm_map_group_class_icon_cb_set()
23154 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23157 * Set the marker's style of a group class.
23159 * @param clas The group class.
23160 * @param style The style to be used by markers.
23162 * Each marker must be associated to a group class, and will use the style
23163 * defined by such class when grouped to other markers.
23165 * The following styles are provided by default theme:
23166 * @li @c radio - blue circle
23167 * @li @c radio2 - green circle
23170 * @see elm_map_group_class_new() for more details.
23171 * @see elm_map_marker_add()
23175 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23178 * Set the icon callback function of a group class.
23180 * @param clas The group class.
23181 * @param icon_get The callback function that will return the icon.
23183 * Each marker must be associated to a group class, and it can display a
23184 * custom icon. The function @p icon_get must return this icon.
23186 * @see elm_map_group_class_new() for more details.
23187 * @see elm_map_marker_add()
23191 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23194 * Set the data associated to the group class.
23196 * @param clas The group class.
23197 * @param data The new user data.
23199 * This data will be passed for callback functions, like icon get callback,
23200 * that can be set with elm_map_group_class_icon_cb_set().
23202 * If a data was previously set, the object will lose the pointer for it,
23203 * so if needs to be freed, you must do it yourself.
23205 * @see elm_map_group_class_new() for more details.
23206 * @see elm_map_group_class_icon_cb_set()
23207 * @see elm_map_marker_add()
23211 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
23214 * Set the minimum zoom from where the markers are displayed.
23216 * @param clas The group class.
23217 * @param zoom The minimum zoom.
23219 * Markers only will be displayed when the map is displayed at @p zoom
23222 * @see elm_map_group_class_new() for more details.
23223 * @see elm_map_marker_add()
23227 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23230 * Set the zoom from where the markers are no more grouped.
23232 * @param clas The group class.
23233 * @param zoom The maximum zoom.
23235 * Markers only will be grouped when the map is displayed at
23236 * less than @p zoom.
23238 * @see elm_map_group_class_new() for more details.
23239 * @see elm_map_marker_add()
23243 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23246 * Set if the markers associated to the group class @clas are hidden or not.
23248 * @param clas The group class.
23249 * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
23252 * If @p hide is @c EINA_TRUE the markers will be hidden, but default
23257 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
23260 * Create a new marker class.
23262 * @param obj The map object.
23263 * @return Returns the new group class.
23265 * Each marker must be associated to a class.
23267 * The marker class defines the style of the marker when a marker is
23268 * displayed alone, i.e., not grouped to to others markers. When grouped
23269 * it will use group class style.
23271 * A marker class will need to be provided when creating a marker with
23272 * elm_map_marker_add().
23274 * Some properties and functions can be set by class, as:
23275 * - style, with elm_map_marker_class_style_set()
23276 * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
23277 * It can be set using elm_map_marker_class_icon_cb_set().
23278 * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
23279 * Set using elm_map_marker_class_get_cb_set().
23280 * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
23281 * Set using elm_map_marker_class_del_cb_set().
23283 * @see elm_map_marker_add()
23284 * @see elm_map_marker_class_style_set()
23285 * @see elm_map_marker_class_icon_cb_set()
23286 * @see elm_map_marker_class_get_cb_set()
23287 * @see elm_map_marker_class_del_cb_set()
23291 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23294 * Set the marker's style of a marker class.
23296 * @param clas The marker class.
23297 * @param style The style to be used by markers.
23299 * Each marker must be associated to a marker class, and will use the style
23300 * defined by such class when alone, i.e., @b not grouped to other markers.
23302 * The following styles are provided by default theme:
23307 * @see elm_map_marker_class_new() for more details.
23308 * @see elm_map_marker_add()
23312 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23315 * Set the icon callback function of a marker class.
23317 * @param clas The marker class.
23318 * @param icon_get The callback function that will return the icon.
23320 * Each marker must be associated to a marker class, and it can display a
23321 * custom icon. The function @p icon_get must return this icon.
23323 * @see elm_map_marker_class_new() for more details.
23324 * @see elm_map_marker_add()
23328 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23331 * Set the bubble content callback function of a marker class.
23333 * @param clas The marker class.
23334 * @param get The callback function that will return the content.
23336 * Each marker must be associated to a marker class, and it can display a
23337 * a content on a bubble that opens when the user click over the marker.
23338 * The function @p get must return this content object.
23340 * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
23343 * @see elm_map_marker_class_new() for more details.
23344 * @see elm_map_marker_class_del_cb_set()
23345 * @see elm_map_marker_add()
23349 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
23352 * Set the callback function used to delete bubble content of a marker class.
23354 * @param clas The marker class.
23355 * @param del The callback function that will delete the content.
23357 * Each marker must be associated to a marker class, and it can display a
23358 * a content on a bubble that opens when the user click over the marker.
23359 * The function to return such content can be set with
23360 * elm_map_marker_class_get_cb_set().
23362 * If this content must be freed, a callback function need to be
23363 * set for that task with this function.
23365 * If this callback is defined it will have to delete (or not) the
23366 * object inside, but if the callback is not defined the object will be
23367 * destroyed with evas_object_del().
23369 * @see elm_map_marker_class_new() for more details.
23370 * @see elm_map_marker_class_get_cb_set()
23371 * @see elm_map_marker_add()
23375 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
23378 * Get the list of available sources.
23380 * @param obj The map object.
23381 * @return The source names list.
23383 * It will provide a list with all available sources, that can be set as
23384 * current source with elm_map_source_name_set(), or get with
23385 * elm_map_source_name_get().
23387 * Available sources:
23393 * @see elm_map_source_name_set() for more details.
23394 * @see elm_map_source_name_get()
23398 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23401 * Set the source of the map.
23403 * @param obj The map object.
23404 * @param source The source to be used.
23406 * Map widget retrieves images that composes the map from a web service.
23407 * This web service can be set with this method.
23409 * A different service can return a different maps with different
23410 * information and it can use different zoom values.
23412 * The @p source_name need to match one of the names provided by
23413 * elm_map_source_names_get().
23415 * The current source can be get using elm_map_source_name_get().
23417 * @see elm_map_source_names_get()
23418 * @see elm_map_source_name_get()
23423 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
23426 * Get the name of currently used source.
23428 * @param obj The map object.
23429 * @return Returns the name of the source in use.
23431 * @see elm_map_source_name_set() for more details.
23435 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23438 * Set the source of the route service to be used by the map.
23440 * @param obj The map object.
23441 * @param source The route service to be used, being it one of
23442 * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
23443 * and #ELM_MAP_ROUTE_SOURCE_ORS.
23445 * Each one has its own algorithm, so the route retrieved may
23446 * differ depending on the source route. Now, only the default is working.
23448 * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
23449 * http://www.yournavigation.org/.
23451 * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
23452 * assumptions. Its routing core is based on Contraction Hierarchies.
23454 * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
23456 * @see elm_map_route_source_get().
23460 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
23463 * Get the current route source.
23465 * @param obj The map object.
23466 * @return The source of the route service used by the map.
23468 * @see elm_map_route_source_set() for details.
23472 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23475 * Set the minimum zoom of the source.
23477 * @param obj The map object.
23478 * @param zoom New minimum zoom value to be used.
23480 * By default, it's 0.
23484 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23487 * Get the minimum zoom of the source.
23489 * @param obj The map object.
23490 * @return Returns the minimum zoom of the source.
23492 * @see elm_map_source_zoom_min_set() for details.
23496 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23499 * Set the maximum zoom of the source.
23501 * @param obj The map object.
23502 * @param zoom New maximum zoom value to be used.
23504 * By default, it's 18.
23508 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23511 * Get the maximum zoom of the source.
23513 * @param obj The map object.
23514 * @return Returns the maximum zoom of the source.
23516 * @see elm_map_source_zoom_min_set() for details.
23520 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23523 * Set the user agent used by the map object to access routing services.
23525 * @param obj The map object.
23526 * @param user_agent The user agent to be used by the map.
23528 * User agent is a client application implementing a network protocol used
23529 * in communications within a clientāserver distributed computing system
23531 * The @p user_agent identification string will transmitted in a header
23532 * field @c User-Agent.
23534 * @see elm_map_user_agent_get()
23538 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
23541 * Get the user agent used by the map object.
23543 * @param obj The map object.
23544 * @return The user agent identification string used by the map.
23546 * @see elm_map_user_agent_set() for details.
23550 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23553 * Add a new route to the map object.
23555 * @param obj The map object.
23556 * @param type The type of transport to be considered when tracing a route.
23557 * @param method The routing method, what should be priorized.
23558 * @param flon The start longitude.
23559 * @param flat The start latitude.
23560 * @param tlon The destination longitude.
23561 * @param tlat The destination latitude.
23563 * @return The created route or @c NULL upon failure.
23565 * A route will be traced by point on coordinates (@p flat, @p flon)
23566 * to point on coordinates (@p tlat, @p tlon), using the route service
23567 * set with elm_map_route_source_set().
23569 * It will take @p type on consideration to define the route,
23570 * depending if the user will be walking or driving, the route may vary.
23571 * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
23572 * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
23574 * Another parameter is what the route should priorize, the minor distance
23575 * or the less time to be spend on the route. So @p method should be one
23576 * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
23578 * Routes created with this method can be deleted with
23579 * elm_map_route_remove(), colored with elm_map_route_color_set(),
23580 * and distance can be get with elm_map_route_distance_get().
23582 * @see elm_map_route_remove()
23583 * @see elm_map_route_color_set()
23584 * @see elm_map_route_distance_get()
23585 * @see elm_map_route_source_set()
23589 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);
23592 * Remove a route from the map.
23594 * @param route The route to remove.
23596 * @see elm_map_route_add()
23600 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23603 * Set the route color.
23605 * @param route The route object.
23606 * @param r Red channel value, from 0 to 255.
23607 * @param g Green channel value, from 0 to 255.
23608 * @param b Blue channel value, from 0 to 255.
23609 * @param a Alpha channel value, from 0 to 255.
23611 * It uses an additive color model, so each color channel represents
23612 * how much of each primary colors must to be used. 0 represents
23613 * ausence of this color, so if all of the three are set to 0,
23614 * the color will be black.
23616 * These component values should be integers in the range 0 to 255,
23617 * (single 8-bit byte).
23619 * This sets the color used for the route. By default, it is set to
23620 * solid red (r = 255, g = 0, b = 0, a = 255).
23622 * For alpha channel, 0 represents completely transparent, and 255, opaque.
23624 * @see elm_map_route_color_get()
23628 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
23631 * Get the route color.
23633 * @param route The route object.
23634 * @param r Pointer where to store the red channel value.
23635 * @param g Pointer where to store the green channel value.
23636 * @param b Pointer where to store the blue channel value.
23637 * @param a Pointer where to store the alpha channel value.
23639 * @see elm_map_route_color_set() for details.
23643 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
23646 * Get the route distance in kilometers.
23648 * @param route The route object.
23649 * @return The distance of route (unit : km).
23653 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23656 * Get the information of route nodes.
23658 * @param route The route object.
23659 * @return Returns a string with the nodes of route.
23663 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23666 * Get the information of route waypoint.
23668 * @param route the route object.
23669 * @return Returns a string with information about waypoint of route.
23673 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23676 * Get the address of the name.
23678 * @param name The name handle.
23679 * @return Returns the address string of @p name.
23681 * This gets the coordinates of the @p name, created with one of the
23682 * conversion functions.
23684 * @see elm_map_utils_convert_name_into_coord()
23685 * @see elm_map_utils_convert_coord_into_name()
23689 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23692 * Get the current coordinates of the name.
23694 * @param name The name handle.
23695 * @param lat Pointer where to store the latitude.
23696 * @param lon Pointer where to store The longitude.
23698 * This gets the coordinates of the @p name, created with one of the
23699 * conversion functions.
23701 * @see elm_map_utils_convert_name_into_coord()
23702 * @see elm_map_utils_convert_coord_into_name()
23706 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
23709 * Remove a name from the map.
23711 * @param name The name to remove.
23713 * Basically the struct handled by @p name will be freed, so convertions
23714 * between address and coordinates will be lost.
23716 * @see elm_map_utils_convert_name_into_coord()
23717 * @see elm_map_utils_convert_coord_into_name()
23721 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23726 * @param obj The map object.
23727 * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
23728 * @param cx Rotation's center horizontal position.
23729 * @param cy Rotation's center vertical position.
23731 * @see elm_map_rotate_get()
23735 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
23738 * Get the rotate degree of the map
23740 * @param obj The map object
23741 * @param degree Pointer where to store degrees from 0.0 to 360.0
23742 * to rotate arount Z axis.
23743 * @param cx Pointer where to store rotation's center horizontal position.
23744 * @param cy Pointer where to store rotation's center vertical position.
23746 * @see elm_map_rotate_set() to set map rotation.
23750 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);
23753 * Enable or disable mouse wheel to be used to zoom in / out the map.
23755 * @param obj The map object.
23756 * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
23759 * Mouse wheel can be used for the user to zoom in or zoom out the map.
23761 * It's disabled by default.
23763 * @see elm_map_wheel_disabled_get()
23767 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
23770 * Get a value whether mouse wheel is enabled or not.
23772 * @param obj The map object.
23773 * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
23774 * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23776 * Mouse wheel can be used for the user to zoom in or zoom out the map.
23778 * @see elm_map_wheel_disabled_set() for details.
23782 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23786 * Add a track on the map
23788 * @param obj The map object.
23789 * @param emap The emap route object.
23790 * @return The route object. This is an elm object of type Route.
23792 * @see elm_route_add() for details.
23796 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
23800 * Remove a track from the map
23802 * @param obj The map object.
23803 * @param route The track to remove.
23807 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
23814 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
23816 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
23818 EAPI double elm_route_lon_min_get(Evas_Object *obj);
23819 EAPI double elm_route_lat_min_get(Evas_Object *obj);
23820 EAPI double elm_route_lon_max_get(Evas_Object *obj);
23821 EAPI double elm_route_lat_max_get(Evas_Object *obj);
23825 * @defgroup Panel Panel
23827 * @image html img/widget/panel/preview-00.png
23828 * @image latex img/widget/panel/preview-00.eps
23830 * @brief A panel is a type of animated container that contains subobjects.
23831 * It can be expanded or contracted by clicking the button on it's edge.
23833 * Orientations are as follows:
23834 * @li ELM_PANEL_ORIENT_TOP
23835 * @li ELM_PANEL_ORIENT_LEFT
23836 * @li ELM_PANEL_ORIENT_RIGHT
23838 * To set/get/unset the content of the panel, you can use
23839 * elm_object_content_set/get/unset APIs.
23840 * Once the content object is set, a previously set one will be deleted.
23841 * If you want to keep that old content object, use the
23842 * elm_object_content_unset() function
23844 * @ref tutorial_panel shows one way to use this widget.
23847 typedef enum _Elm_Panel_Orient
23849 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
23850 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
23851 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
23852 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
23853 } Elm_Panel_Orient;
23855 * @brief Adds a panel object
23857 * @param parent The parent object
23859 * @return The panel object, or NULL on failure
23861 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23863 * @brief Sets the orientation of the panel
23865 * @param parent The parent object
23866 * @param orient The panel orientation. Can be one of the following:
23867 * @li ELM_PANEL_ORIENT_TOP
23868 * @li ELM_PANEL_ORIENT_LEFT
23869 * @li ELM_PANEL_ORIENT_RIGHT
23871 * Sets from where the panel will (dis)appear.
23873 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
23875 * @brief Get the orientation of the panel.
23877 * @param obj The panel object
23878 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
23880 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23882 * @brief Set the content of the panel.
23884 * @param obj The panel object
23885 * @param content The panel content
23887 * Once the content object is set, a previously set one will be deleted.
23888 * If you want to keep that old content object, use the
23889 * elm_panel_content_unset() function.
23891 EINA_DEPRECATED EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23893 * @brief Get the content of the panel.
23895 * @param obj The panel object
23896 * @return The content that is being used
23898 * Return the content object which is set for this widget.
23900 * @see elm_panel_content_set()
23902 EINA_DEPRECATED EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23904 * @brief Unset the content of the panel.
23906 * @param obj The panel object
23907 * @return The content that was being used
23909 * Unparent and return the content object which was set for this widget.
23911 * @see elm_panel_content_set()
23913 EINA_DEPRECATED EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23915 * @brief Set the state of the panel.
23917 * @param obj The panel object
23918 * @param hidden If true, the panel will run the animation to contract
23920 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
23922 * @brief Get the state of the panel.
23924 * @param obj The panel object
23925 * @param hidden If true, the panel is in the "hide" state
23927 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23929 * @brief Toggle the hidden state of the panel from code
23931 * @param obj The panel object
23933 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
23939 * @defgroup Panes Panes
23940 * @ingroup Elementary
23942 * @image html img/widget/panes/preview-00.png
23943 * @image latex img/widget/panes/preview-00.eps width=\textwidth
23945 * @image html img/panes.png
23946 * @image latex img/panes.eps width=\textwidth
23948 * The panes adds a dragable bar between two contents. When dragged
23949 * this bar will resize contents size.
23951 * Panes can be displayed vertically or horizontally, and contents
23952 * size proportion can be customized (homogeneous by default).
23954 * Smart callbacks one can listen to:
23955 * - "press" - The panes has been pressed (button wasn't released yet).
23956 * - "unpressed" - The panes was released after being pressed.
23957 * - "clicked" - The panes has been clicked>
23958 * - "clicked,double" - The panes has been double clicked
23960 * Available styles for it:
23963 * Default contents parts of the panes widget that you can use for are:
23964 * @li "elm.swallow.left" - A leftside content of the panes
23965 * @li "elm.swallow.right" - A rightside content of the panes
23967 * If panes is displayed vertically, left content will be displayed at
23970 * Here is an example on its usage:
23971 * @li @ref panes_example
23974 #define ELM_PANES_CONTENT_LEFT "elm.swallow.left"
23975 #define ELM_PANES_CONTENT_RIGHT "elm.swallow.right"
23978 * @addtogroup Panes
23983 * Add a new panes widget to the given parent Elementary
23984 * (container) object.
23986 * @param parent The parent object.
23987 * @return a new panes widget handle or @c NULL, on errors.
23989 * This function inserts a new panes widget on the canvas.
23993 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23996 * Set the left content of the panes widget.
23998 * @param obj The panes object.
23999 * @param content The new left content object.
24001 * Once the content object is set, a previously set one will be deleted.
24002 * If you want to keep that old content object, use the
24003 * elm_panes_content_left_unset() function.
24005 * If panes is displayed vertically, left content will be displayed at
24008 * @see elm_panes_content_left_get()
24009 * @see elm_panes_content_right_set() to set content on the other side.
24013 EINA_DEPRECATED EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24016 * Set the right content of the panes widget.
24018 * @param obj The panes object.
24019 * @param content The new right content object.
24021 * Once the content object is set, a previously set one will be deleted.
24022 * If you want to keep that old content object, use the
24023 * elm_panes_content_right_unset() function.
24025 * If panes is displayed vertically, left content will be displayed at
24028 * @see elm_panes_content_right_get()
24029 * @see elm_panes_content_left_set() to set content on the other side.
24033 EINA_DEPRECATED EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24036 * Get the left content of the panes.
24038 * @param obj The panes object.
24039 * @return The left content object that is being used.
24041 * Return the left content object which is set for this widget.
24043 * @see elm_panes_content_left_set() for details.
24047 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24050 * Get the right content of the panes.
24052 * @param obj The panes object
24053 * @return The right content object that is being used
24055 * Return the right content object which is set for this widget.
24057 * @see elm_panes_content_right_set() for details.
24061 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24064 * Unset the left content used for the panes.
24066 * @param obj The panes object.
24067 * @return The left content object that was being used.
24069 * Unparent and return the left content object which was set for this widget.
24071 * @see elm_panes_content_left_set() for details.
24072 * @see elm_panes_content_left_get().
24076 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24079 * Unset the right content used for the panes.
24081 * @param obj The panes object.
24082 * @return The right content object that was being used.
24084 * Unparent and return the right content object which was set for this
24087 * @see elm_panes_content_right_set() for details.
24088 * @see elm_panes_content_right_get().
24092 EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24095 * Get the size proportion of panes widget's left side.
24097 * @param obj The panes object.
24098 * @return float value between 0.0 and 1.0 representing size proportion
24101 * @see elm_panes_content_left_size_set() for more details.
24105 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24108 * Set the size proportion of panes widget's left side.
24110 * @param obj The panes object.
24111 * @param size Value between 0.0 and 1.0 representing size proportion
24114 * By default it's homogeneous, i.e., both sides have the same size.
24116 * If something different is required, it can be set with this function.
24117 * For example, if the left content should be displayed over
24118 * 75% of the panes size, @p size should be passed as @c 0.75.
24119 * This way, right content will be resized to 25% of panes size.
24121 * If displayed vertically, left content is displayed at top, and
24122 * right content at bottom.
24124 * @note This proportion will change when user drags the panes bar.
24126 * @see elm_panes_content_left_size_get()
24130 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
24133 * Set the orientation of a given panes widget.
24135 * @param obj The panes object.
24136 * @param horizontal Use @c EINA_TRUE to make @p obj to be
24137 * @b horizontal, @c EINA_FALSE to make it @b vertical.
24139 * Use this function to change how your panes is to be
24140 * disposed: vertically or horizontally.
24142 * By default it's displayed horizontally.
24144 * @see elm_panes_horizontal_get()
24148 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
24151 * Retrieve the orientation of a given panes widget.
24153 * @param obj The panes object.
24154 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
24155 * @c EINA_FALSE if it's @b vertical (and on errors).
24157 * @see elm_panes_horizontal_set() for more details.
24161 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24162 EAPI void elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
24163 EAPI Eina_Bool elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24170 * @defgroup Flip Flip
24172 * @image html img/widget/flip/preview-00.png
24173 * @image latex img/widget/flip/preview-00.eps
24175 * This widget holds 2 content objects(Evas_Object): one on the front and one
24176 * on the back. It allows you to flip from front to back and vice-versa using
24177 * various animations.
24179 * If either the front or back contents are not set the flip will treat that
24180 * as transparent. So if you wore to set the front content but not the back,
24181 * and then call elm_flip_go() you would see whatever is below the flip.
24183 * For a list of supported animations see elm_flip_go().
24185 * Signals that you can add callbacks for are:
24186 * "animate,begin" - when a flip animation was started
24187 * "animate,done" - when a flip animation is finished
24189 * @ref tutorial_flip show how to use most of the API.
24193 typedef enum _Elm_Flip_Mode
24195 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
24196 ELM_FLIP_ROTATE_X_CENTER_AXIS,
24197 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
24198 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
24199 ELM_FLIP_CUBE_LEFT,
24200 ELM_FLIP_CUBE_RIGHT,
24202 ELM_FLIP_CUBE_DOWN,
24203 ELM_FLIP_PAGE_LEFT,
24204 ELM_FLIP_PAGE_RIGHT,
24208 typedef enum _Elm_Flip_Interaction
24210 ELM_FLIP_INTERACTION_NONE,
24211 ELM_FLIP_INTERACTION_ROTATE,
24212 ELM_FLIP_INTERACTION_CUBE,
24213 ELM_FLIP_INTERACTION_PAGE
24214 } Elm_Flip_Interaction;
24215 typedef enum _Elm_Flip_Direction
24217 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
24218 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
24219 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
24220 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
24221 } Elm_Flip_Direction;
24223 * @brief Add a new flip to the parent
24225 * @param parent The parent object
24226 * @return The new object or NULL if it cannot be created
24228 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24230 * @brief Set the front content of the flip widget.
24232 * @param obj The flip object
24233 * @param content The new front content object
24235 * Once the content object is set, a previously set one will be deleted.
24236 * If you want to keep that old content object, use the
24237 * elm_flip_content_front_unset() function.
24239 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24241 * @brief Set the back content of the flip widget.
24243 * @param obj The flip object
24244 * @param content The new back content object
24246 * Once the content object is set, a previously set one will be deleted.
24247 * If you want to keep that old content object, use the
24248 * elm_flip_content_back_unset() function.
24250 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24252 * @brief Get the front content used for the flip
24254 * @param obj The flip object
24255 * @return The front content object that is being used
24257 * Return the front content object which is set for this widget.
24259 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24261 * @brief Get the back content used for the flip
24263 * @param obj The flip object
24264 * @return The back content object that is being used
24266 * Return the back content object which is set for this widget.
24268 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24270 * @brief Unset the front content used for the flip
24272 * @param obj The flip object
24273 * @return The front content object that was being used
24275 * Unparent and return the front content object which was set for this widget.
24277 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24279 * @brief Unset the back content used for the flip
24281 * @param obj The flip object
24282 * @return The back content object that was being used
24284 * Unparent and return the back content object which was set for this widget.
24286 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24288 * @brief Get flip front visibility state
24290 * @param obj The flip objct
24291 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
24294 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24296 * @brief Set flip perspective
24298 * @param obj The flip object
24299 * @param foc The coordinate to set the focus on
24300 * @param x The X coordinate
24301 * @param y The Y coordinate
24303 * @warning This function currently does nothing.
24305 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
24307 * @brief Runs the flip animation
24309 * @param obj The flip object
24310 * @param mode The mode type
24312 * Flips the front and back contents using the @p mode animation. This
24313 * efectively hides the currently visible content and shows the hidden one.
24315 * There a number of possible animations to use for the flipping:
24316 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
24317 * around a horizontal axis in the middle of its height, the other content
24318 * is shown as the other side of the flip.
24319 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
24320 * around a vertical axis in the middle of its width, the other content is
24321 * shown as the other side of the flip.
24322 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
24323 * around a diagonal axis in the middle of its width, the other content is
24324 * shown as the other side of the flip.
24325 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
24326 * around a diagonal axis in the middle of its height, the other content is
24327 * shown as the other side of the flip.
24328 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
24329 * as if the flip was a cube, the other content is show as the right face of
24331 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
24332 * right as if the flip was a cube, the other content is show as the left
24333 * face of the cube.
24334 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
24335 * flip was a cube, the other content is show as the bottom face of the cube.
24336 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
24337 * the flip was a cube, the other content is show as the upper face of the
24339 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
24340 * if the flip was a book, the other content is shown as the page below that.
24341 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
24342 * as if the flip was a book, the other content is shown as the page below
24344 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
24345 * flip was a book, the other content is shown as the page below that.
24346 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
24347 * flip was a book, the other content is shown as the page below that.
24349 * @image html elm_flip.png
24350 * @image latex elm_flip.eps width=\textwidth
24352 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
24354 * @brief Set the interactive flip mode
24356 * @param obj The flip object
24357 * @param mode The interactive flip mode to use
24359 * This sets if the flip should be interactive (allow user to click and
24360 * drag a side of the flip to reveal the back page and cause it to flip).
24361 * By default a flip is not interactive. You may also need to set which
24362 * sides of the flip are "active" for flipping and how much space they use
24363 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
24364 * and elm_flip_interacton_direction_hitsize_set()
24366 * The four avilable mode of interaction are:
24367 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
24368 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
24369 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
24370 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
24372 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
24373 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
24374 * happen, those can only be acheived with elm_flip_go();
24376 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
24378 * @brief Get the interactive flip mode
24380 * @param obj The flip object
24381 * @return The interactive flip mode
24383 * Returns the interactive flip mode set by elm_flip_interaction_set()
24385 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
24387 * @brief Set which directions of the flip respond to interactive flip
24389 * @param obj The flip object
24390 * @param dir The direction to change
24391 * @param enabled If that direction is enabled or not
24393 * By default all directions are disabled, so you may want to enable the
24394 * desired directions for flipping if you need interactive flipping. You must
24395 * call this function once for each direction that should be enabled.
24397 * @see elm_flip_interaction_set()
24399 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
24401 * @brief Get the enabled state of that flip direction
24403 * @param obj The flip object
24404 * @param dir The direction to check
24405 * @return If that direction is enabled or not
24407 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
24409 * @see elm_flip_interaction_set()
24411 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
24413 * @brief Set the amount of the flip that is sensitive to interactive flip
24415 * @param obj The flip object
24416 * @param dir The direction to modify
24417 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
24419 * Set the amount of the flip that is sensitive to interactive flip, with 0
24420 * representing no area in the flip and 1 representing the entire flip. There
24421 * is however a consideration to be made in that the area will never be
24422 * smaller than the finger size set(as set in your Elementary configuration).
24424 * @see elm_flip_interaction_set()
24426 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
24428 * @brief Get the amount of the flip that is sensitive to interactive flip
24430 * @param obj The flip object
24431 * @param dir The direction to check
24432 * @return The size set for that direction
24434 * Returns the amount os sensitive area set by
24435 * elm_flip_interacton_direction_hitsize_set().
24437 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
24442 /* scrolledentry */
24443 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24444 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
24445 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24446 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
24447 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24448 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24449 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24450 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24451 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24452 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24453 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24454 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
24455 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
24456 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24457 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
24458 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
24459 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24460 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24461 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
24462 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
24463 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24464 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24465 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24466 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24467 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
24468 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
24469 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24470 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24471 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24472 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24473 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24474 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
24475 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
24476 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
24477 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24478 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);
24479 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24480 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24481 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);
24482 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24483 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);
24484 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
24485 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24486 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24487 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24488 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
24489 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24490 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24491 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24492 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);
24493 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);
24494 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);
24495 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);
24496 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);
24497 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);
24498 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
24499 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
24500 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
24501 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
24502 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24503 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
24504 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
24507 * @defgroup Conformant Conformant
24508 * @ingroup Elementary
24510 * @image html img/widget/conformant/preview-00.png
24511 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
24513 * @image html img/conformant.png
24514 * @image latex img/conformant.eps width=\textwidth
24516 * The aim is to provide a widget that can be used in elementary apps to
24517 * account for space taken up by the indicator, virtual keypad & softkey
24518 * windows when running the illume2 module of E17.
24520 * So conformant content will be sized and positioned considering the
24521 * space required for such stuff, and when they popup, as a keyboard
24522 * shows when an entry is selected, conformant content won't change.
24524 * Available styles for it:
24527 * Default contents parts of the conformant widget that you can use for are:
24528 * @li "elm.swallow.content" - A content of the conformant
24530 * See how to use this widget in this example:
24531 * @ref conformant_example
24535 * @addtogroup Conformant
24540 * Add a new conformant widget to the given parent Elementary
24541 * (container) object.
24543 * @param parent The parent object.
24544 * @return A new conformant widget handle or @c NULL, on errors.
24546 * This function inserts a new conformant widget on the canvas.
24548 * @ingroup Conformant
24550 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24553 * Set the content of the conformant widget.
24555 * @param obj The conformant object.
24556 * @param content The content to be displayed by the conformant.
24558 * Content will be sized and positioned considering the space required
24559 * to display a virtual keyboard. So it won't fill all the conformant
24560 * size. This way is possible to be sure that content won't resize
24561 * or be re-positioned after the keyboard is displayed.
24563 * Once the content object is set, a previously set one will be deleted.
24564 * If you want to keep that old content object, use the
24565 * elm_object_content_unset() function.
24567 * @see elm_object_content_unset()
24568 * @see elm_object_content_get()
24570 * @ingroup Conformant
24572 EINA_DEPRECATED EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24575 * Get the content of the conformant widget.
24577 * @param obj The conformant object.
24578 * @return The content that is being used.
24580 * Return the content object which is set for this widget.
24581 * It won't be unparent from conformant. For that, use
24582 * elm_object_content_unset().
24584 * @see elm_object_content_set().
24585 * @see elm_object_content_unset()
24587 * @ingroup Conformant
24589 EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24592 * Unset the content of the conformant widget.
24594 * @param obj The conformant object.
24595 * @return The content that was being used.
24597 * Unparent and return the content object which was set for this widget.
24599 * @see elm_object_content_set().
24601 * @ingroup Conformant
24603 EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24606 * Returns the Evas_Object that represents the content area.
24608 * @param obj The conformant object.
24609 * @return The content area of the widget.
24611 * @ingroup Conformant
24613 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24620 * @defgroup Mapbuf Mapbuf
24621 * @ingroup Elementary
24623 * @image html img/widget/mapbuf/preview-00.png
24624 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
24626 * This holds one content object and uses an Evas Map of transformation
24627 * points to be later used with this content. So the content will be
24628 * moved, resized, etc as a single image. So it will improve performance
24629 * when you have a complex interafce, with a lot of elements, and will
24630 * need to resize or move it frequently (the content object and its
24633 * To set/get/unset the content of the mapbuf, you can use
24634 * elm_object_content_set/get/unset APIs.
24635 * Once the content object is set, a previously set one will be deleted.
24636 * If you want to keep that old content object, use the
24637 * elm_object_content_unset() function.
24639 * To enable map, elm_mapbuf_enabled_set() should be used.
24641 * See how to use this widget in this example:
24642 * @ref mapbuf_example
24646 * @addtogroup Mapbuf
24651 * Add a new mapbuf widget to the given parent Elementary
24652 * (container) object.
24654 * @param parent The parent object.
24655 * @return A new mapbuf widget handle or @c NULL, on errors.
24657 * This function inserts a new mapbuf widget on the canvas.
24661 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24664 * Set the content of the mapbuf.
24666 * @param obj The mapbuf object.
24667 * @param content The content that will be filled in this mapbuf object.
24669 * Once the content object is set, a previously set one will be deleted.
24670 * If you want to keep that old content object, use the
24671 * elm_mapbuf_content_unset() function.
24673 * To enable map, elm_mapbuf_enabled_set() should be used.
24677 EINA_DEPRECATED EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24680 * Get the content of the mapbuf.
24682 * @param obj The mapbuf object.
24683 * @return The content that is being used.
24685 * Return the content object which is set for this widget.
24687 * @see elm_mapbuf_content_set() for details.
24691 EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24694 * Unset the content of the mapbuf.
24696 * @param obj The mapbuf object.
24697 * @return The content that was being used.
24699 * Unparent and return the content object which was set for this widget.
24701 * @see elm_mapbuf_content_set() for details.
24705 EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24708 * Enable or disable the map.
24710 * @param obj The mapbuf object.
24711 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
24713 * This enables the map that is set or disables it. On enable, the object
24714 * geometry will be saved, and the new geometry will change (position and
24715 * size) to reflect the map geometry set.
24717 * Also, when enabled, alpha and smooth states will be used, so if the
24718 * content isn't solid, alpha should be enabled, for example, otherwise
24719 * a black retangle will fill the content.
24721 * When disabled, the stored map will be freed and geometry prior to
24722 * enabling the map will be restored.
24724 * It's disabled by default.
24726 * @see elm_mapbuf_alpha_set()
24727 * @see elm_mapbuf_smooth_set()
24731 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
24734 * Get a value whether map is enabled or not.
24736 * @param obj The mapbuf object.
24737 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
24738 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24740 * @see elm_mapbuf_enabled_set() for details.
24744 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24747 * Enable or disable smooth map rendering.
24749 * @param obj The mapbuf object.
24750 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
24753 * This sets smoothing for map rendering. If the object is a type that has
24754 * its own smoothing settings, then both the smooth settings for this object
24755 * and the map must be turned off.
24757 * By default smooth maps are enabled.
24761 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
24764 * Get a value whether smooth map rendering is enabled or not.
24766 * @param obj The mapbuf object.
24767 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
24768 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24770 * @see elm_mapbuf_smooth_set() for details.
24774 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24777 * Set or unset alpha flag for map rendering.
24779 * @param obj The mapbuf object.
24780 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
24783 * This sets alpha flag for map rendering. If the object is a type that has
24784 * its own alpha settings, then this will take precedence. Only image objects
24785 * have this currently. It stops alpha blending of the map area, and is
24786 * useful if you know the object and/or all sub-objects is 100% solid.
24788 * Alpha is enabled by default.
24792 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
24795 * Get a value whether alpha blending is enabled or not.
24797 * @param obj The mapbuf object.
24798 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
24799 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24801 * @see elm_mapbuf_alpha_set() for details.
24805 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24812 * @defgroup Flipselector Flip Selector
24814 * @image html img/widget/flipselector/preview-00.png
24815 * @image latex img/widget/flipselector/preview-00.eps
24817 * A flip selector is a widget to show a set of @b text items, one
24818 * at a time, with the same sheet switching style as the @ref Clock
24819 * "clock" widget, when one changes the current displaying sheet
24820 * (thus, the "flip" in the name).
24822 * User clicks to flip sheets which are @b held for some time will
24823 * make the flip selector to flip continuosly and automatically for
24824 * the user. The interval between flips will keep growing in time,
24825 * so that it helps the user to reach an item which is distant from
24826 * the current selection.
24828 * Smart callbacks one can register to:
24829 * - @c "selected" - when the widget's selected text item is changed
24830 * - @c "overflowed" - when the widget's current selection is changed
24831 * from the first item in its list to the last
24832 * - @c "underflowed" - when the widget's current selection is changed
24833 * from the last item in its list to the first
24835 * Available styles for it:
24838 * Here is an example on its usage:
24839 * @li @ref flipselector_example
24843 * @addtogroup Flipselector
24847 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
24850 * Add a new flip selector widget to the given parent Elementary
24851 * (container) widget
24853 * @param parent The parent object
24854 * @return a new flip selector widget handle or @c NULL, on errors
24856 * This function inserts a new flip selector widget on the canvas.
24858 * @ingroup Flipselector
24860 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24863 * Programmatically select the next item of a flip selector widget
24865 * @param obj The flipselector object
24867 * @note The selection will be animated. Also, if it reaches the
24868 * end of its list of member items, it will continue with the first
24871 * @ingroup Flipselector
24873 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24876 * Programmatically select the previous item of a flip selector
24879 * @param obj The flipselector object
24881 * @note The selection will be animated. Also, if it reaches the
24882 * beginning of its list of member items, it will continue with the
24883 * last one backwards.
24885 * @ingroup Flipselector
24887 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24890 * Append a (text) item to a flip selector widget
24892 * @param obj The flipselector object
24893 * @param label The (text) label of the new item
24894 * @param func Convenience callback function to take place when
24896 * @param data Data passed to @p func, above
24897 * @return A handle to the item added or @c NULL, on errors
24899 * The widget's list of labels to show will be appended with the
24900 * given value. If the user wishes so, a callback function pointer
24901 * can be passed, which will get called when this same item is
24904 * @note The current selection @b won't be modified by appending an
24905 * element to the list.
24907 * @note The maximum length of the text label is going to be
24908 * determined <b>by the widget's theme</b>. Strings larger than
24909 * that value are going to be @b truncated.
24911 * @ingroup Flipselector
24913 EAPI Elm_Flipselector_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24916 * Prepend a (text) item to a flip selector widget
24918 * @param obj The flipselector object
24919 * @param label The (text) label of the new item
24920 * @param func Convenience callback function to take place when
24922 * @param data Data passed to @p func, above
24923 * @return A handle to the item added or @c NULL, on errors
24925 * The widget's list of labels to show will be prepended with the
24926 * given value. If the user wishes so, a callback function pointer
24927 * can be passed, which will get called when this same item is
24930 * @note The current selection @b won't be modified by prepending
24931 * an element to the list.
24933 * @note The maximum length of the text label is going to be
24934 * determined <b>by the widget's theme</b>. Strings larger than
24935 * that value are going to be @b truncated.
24937 * @ingroup Flipselector
24939 EAPI Elm_Flipselector_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24942 * Get the internal list of items in a given flip selector widget.
24944 * @param obj The flipselector object
24945 * @return The list of items (#Elm_Flipselector_Item as data) or
24946 * @c NULL on errors.
24948 * This list is @b not to be modified in any way and must not be
24949 * freed. Use the list members with functions like
24950 * elm_flipselector_item_label_set(),
24951 * elm_flipselector_item_label_get(),
24952 * elm_flipselector_item_del(),
24953 * elm_flipselector_item_selected_get(),
24954 * elm_flipselector_item_selected_set().
24956 * @warning This list is only valid until @p obj object's internal
24957 * items list is changed. It should be fetched again with another
24958 * call to this function when changes happen.
24960 * @ingroup Flipselector
24962 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24965 * Get the first item in the given flip selector widget's list of
24968 * @param obj The flipselector object
24969 * @return The first item or @c NULL, if it has no items (and on
24972 * @see elm_flipselector_item_append()
24973 * @see elm_flipselector_last_item_get()
24975 * @ingroup Flipselector
24977 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24980 * Get the last item in the given flip selector widget's list of
24983 * @param obj The flipselector object
24984 * @return The last item or @c NULL, if it has no items (and on
24987 * @see elm_flipselector_item_prepend()
24988 * @see elm_flipselector_first_item_get()
24990 * @ingroup Flipselector
24992 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24995 * Get the currently selected item in a flip selector widget.
24997 * @param obj The flipselector object
24998 * @return The selected item or @c NULL, if the widget has no items
25001 * @ingroup Flipselector
25003 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25006 * Set whether a given flip selector widget's item should be the
25007 * currently selected one.
25009 * @param item The flip selector item
25010 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
25012 * This sets whether @p item is or not the selected (thus, under
25013 * display) one. If @p item is different than one under display,
25014 * the latter will be unselected. If the @p item is set to be
25015 * unselected, on the other hand, the @b first item in the widget's
25016 * internal members list will be the new selected one.
25018 * @see elm_flipselector_item_selected_get()
25020 * @ingroup Flipselector
25022 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
25025 * Get whether a given flip selector widget's item is the currently
25028 * @param item The flip selector item
25029 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
25032 * @see elm_flipselector_item_selected_set()
25034 * @ingroup Flipselector
25036 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
25039 * Delete a given item from a flip selector widget.
25041 * @param item The item to delete
25043 * @ingroup Flipselector
25045 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
25048 * Get the label of a given flip selector widget's item.
25050 * @param item The item to get label from
25051 * @return The text label of @p item or @c NULL, on errors
25053 * @see elm_flipselector_item_label_set()
25055 * @ingroup Flipselector
25057 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
25060 * Set the label of a given flip selector widget's item.
25062 * @param item The item to set label on
25063 * @param label The text label string, in UTF-8 encoding
25065 * @see elm_flipselector_item_label_get()
25067 * @ingroup Flipselector
25069 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
25072 * Gets the item before @p item in a flip selector widget's
25073 * internal list of items.
25075 * @param item The item to fetch previous from
25076 * @return The item before the @p item, in its parent's list. If
25077 * there is no previous item for @p item or there's an
25078 * error, @c NULL is returned.
25080 * @see elm_flipselector_item_next_get()
25082 * @ingroup Flipselector
25084 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
25087 * Gets the item after @p item in a flip selector widget's
25088 * internal list of items.
25090 * @param item The item to fetch next from
25091 * @return The item after the @p item, in its parent's list. If
25092 * there is no next item for @p item or there's an
25093 * error, @c NULL is returned.
25095 * @see elm_flipselector_item_next_get()
25097 * @ingroup Flipselector
25099 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
25102 * Set the interval on time updates for an user mouse button hold
25103 * on a flip selector widget.
25105 * @param obj The flip selector object
25106 * @param interval The (first) interval value in seconds
25108 * This interval value is @b decreased while the user holds the
25109 * mouse pointer either flipping up or flipping doww a given flip
25112 * This helps the user to get to a given item distant from the
25113 * current one easier/faster, as it will start to flip quicker and
25114 * quicker on mouse button holds.
25116 * The calculation for the next flip interval value, starting from
25117 * the one set with this call, is the previous interval divided by
25118 * 1.05, so it decreases a little bit.
25120 * The default starting interval value for automatic flips is
25123 * @see elm_flipselector_interval_get()
25125 * @ingroup Flipselector
25127 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25130 * Get the interval on time updates for an user mouse button hold
25131 * on a flip selector widget.
25133 * @param obj The flip selector object
25134 * @return The (first) interval value, in seconds, set on it
25136 * @see elm_flipselector_interval_set() for more details
25138 * @ingroup Flipselector
25140 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25146 * @addtogroup Calendar
25151 * @enum _Elm_Calendar_Mark_Repeat
25152 * @typedef Elm_Calendar_Mark_Repeat
25154 * Event periodicity, used to define if a mark should be repeated
25155 * @b beyond event's day. It's set when a mark is added.
25157 * So, for a mark added to 13th May with periodicity set to WEEKLY,
25158 * there will be marks every week after this date. Marks will be displayed
25159 * at 13th, 20th, 27th, 3rd June ...
25161 * Values don't work as bitmask, only one can be choosen.
25163 * @see elm_calendar_mark_add()
25165 * @ingroup Calendar
25167 typedef enum _Elm_Calendar_Mark_Repeat
25169 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
25170 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
25171 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
25172 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*/
25173 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. */
25174 } Elm_Calendar_Mark_Repeat;
25176 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(). */
25179 * Add a new calendar widget to the given parent Elementary
25180 * (container) object.
25182 * @param parent The parent object.
25183 * @return a new calendar widget handle or @c NULL, on errors.
25185 * This function inserts a new calendar widget on the canvas.
25187 * @ref calendar_example_01
25189 * @ingroup Calendar
25191 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25194 * Get weekdays names displayed by the calendar.
25196 * @param obj The calendar object.
25197 * @return Array of seven strings to be used as weekday names.
25199 * By default, weekdays abbreviations get from system are displayed:
25200 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25201 * The first string is related to Sunday, the second to Monday...
25203 * @see elm_calendar_weekdays_name_set()
25205 * @ref calendar_example_05
25207 * @ingroup Calendar
25209 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25212 * Set weekdays names to be displayed by the calendar.
25214 * @param obj The calendar object.
25215 * @param weekdays Array of seven strings to be used as weekday names.
25216 * @warning It must have 7 elements, or it will access invalid memory.
25217 * @warning The strings must be NULL terminated ('@\0').
25219 * By default, weekdays abbreviations get from system are displayed:
25220 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25222 * The first string should be related to Sunday, the second to Monday...
25224 * The usage should be like this:
25226 * const char *weekdays[] =
25228 * "Sunday", "Monday", "Tuesday", "Wednesday",
25229 * "Thursday", "Friday", "Saturday"
25231 * elm_calendar_weekdays_names_set(calendar, weekdays);
25234 * @see elm_calendar_weekdays_name_get()
25236 * @ref calendar_example_02
25238 * @ingroup Calendar
25240 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
25243 * Set the minimum and maximum values for the year
25245 * @param obj The calendar object
25246 * @param min The minimum year, greater than 1901;
25247 * @param max The maximum year;
25249 * Maximum must be greater than minimum, except if you don't wan't to set
25251 * Default values are 1902 and -1.
25253 * If the maximum year is a negative value, it will be limited depending
25254 * on the platform architecture (year 2037 for 32 bits);
25256 * @see elm_calendar_min_max_year_get()
25258 * @ref calendar_example_03
25260 * @ingroup Calendar
25262 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
25265 * Get the minimum and maximum values for the year
25267 * @param obj The calendar object.
25268 * @param min The minimum year.
25269 * @param max The maximum year.
25271 * Default values are 1902 and -1.
25273 * @see elm_calendar_min_max_year_get() for more details.
25275 * @ref calendar_example_05
25277 * @ingroup Calendar
25279 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
25282 * Enable or disable day selection
25284 * @param obj The calendar object.
25285 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
25288 * Enabled by default. If disabled, the user still can select months,
25289 * but not days. Selected days are highlighted on calendar.
25290 * It should be used if you won't need such selection for the widget usage.
25292 * When a day is selected, or month is changed, smart callbacks for
25293 * signal "changed" will be called.
25295 * @see elm_calendar_day_selection_enable_get()
25297 * @ref calendar_example_04
25299 * @ingroup Calendar
25301 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25304 * Get a value whether day selection is enabled or not.
25306 * @see elm_calendar_day_selection_enable_set() for details.
25308 * @param obj The calendar object.
25309 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
25310 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
25312 * @ref calendar_example_05
25314 * @ingroup Calendar
25316 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25320 * Set selected date to be highlighted on calendar.
25322 * @param obj The calendar object.
25323 * @param selected_time A @b tm struct to represent the selected date.
25325 * Set the selected date, changing the displayed month if needed.
25326 * Selected date changes when the user goes to next/previous month or
25327 * select a day pressing over it on calendar.
25329 * @see elm_calendar_selected_time_get()
25331 * @ref calendar_example_04
25333 * @ingroup Calendar
25335 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
25338 * Get selected date.
25340 * @param obj The calendar object
25341 * @param selected_time A @b tm struct to point to selected date
25342 * @return EINA_FALSE means an error ocurred and returned time shouldn't
25345 * Get date selected by the user or set by function
25346 * elm_calendar_selected_time_set().
25347 * Selected date changes when the user goes to next/previous month or
25348 * select a day pressing over it on calendar.
25350 * @see elm_calendar_selected_time_get()
25352 * @ref calendar_example_05
25354 * @ingroup Calendar
25356 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
25359 * Set a function to format the string that will be used to display
25362 * @param obj The calendar object
25363 * @param format_function Function to set the month-year string given
25364 * the selected date
25366 * By default it uses strftime with "%B %Y" format string.
25367 * It should allocate the memory that will be used by the string,
25368 * that will be freed by the widget after usage.
25369 * A pointer to the string and a pointer to the time struct will be provided.
25374 * _format_month_year(struct tm *selected_time)
25377 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
25378 * return strdup(buf);
25381 * elm_calendar_format_function_set(calendar, _format_month_year);
25384 * @ref calendar_example_02
25386 * @ingroup Calendar
25388 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
25391 * Add a new mark to the calendar
25393 * @param obj The calendar object
25394 * @param mark_type A string used to define the type of mark. It will be
25395 * emitted to the theme, that should display a related modification on these
25396 * days representation.
25397 * @param mark_time A time struct to represent the date of inclusion of the
25398 * mark. For marks that repeats it will just be displayed after the inclusion
25399 * date in the calendar.
25400 * @param repeat Repeat the event following this periodicity. Can be a unique
25401 * mark (that don't repeat), daily, weekly, monthly or annually.
25402 * @return The created mark or @p NULL upon failure.
25404 * Add a mark that will be drawn in the calendar respecting the insertion
25405 * time and periodicity. It will emit the type as signal to the widget theme.
25406 * Default theme supports "holiday" and "checked", but it can be extended.
25408 * It won't immediately update the calendar, drawing the marks.
25409 * For this, call elm_calendar_marks_draw(). However, when user selects
25410 * next or previous month calendar forces marks drawn.
25412 * Marks created with this method can be deleted with
25413 * elm_calendar_mark_del().
25417 * struct tm selected_time;
25418 * time_t current_time;
25420 * current_time = time(NULL) + 5 * 84600;
25421 * localtime_r(¤t_time, &selected_time);
25422 * elm_calendar_mark_add(cal, "holiday", selected_time,
25423 * ELM_CALENDAR_ANNUALLY);
25425 * current_time = time(NULL) + 1 * 84600;
25426 * localtime_r(¤t_time, &selected_time);
25427 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
25429 * elm_calendar_marks_draw(cal);
25432 * @see elm_calendar_marks_draw()
25433 * @see elm_calendar_mark_del()
25435 * @ref calendar_example_06
25437 * @ingroup Calendar
25439 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);
25442 * Delete mark from the calendar.
25444 * @param mark The mark to be deleted.
25446 * If deleting all calendar marks is required, elm_calendar_marks_clear()
25447 * should be used instead of getting marks list and deleting each one.
25449 * @see elm_calendar_mark_add()
25451 * @ref calendar_example_06
25453 * @ingroup Calendar
25455 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
25458 * Remove all calendar's marks
25460 * @param obj The calendar object.
25462 * @see elm_calendar_mark_add()
25463 * @see elm_calendar_mark_del()
25465 * @ingroup Calendar
25467 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25471 * Get a list of all the calendar marks.
25473 * @param obj The calendar object.
25474 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
25476 * @see elm_calendar_mark_add()
25477 * @see elm_calendar_mark_del()
25478 * @see elm_calendar_marks_clear()
25480 * @ingroup Calendar
25482 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25485 * Draw calendar marks.
25487 * @param obj The calendar object.
25489 * Should be used after adding, removing or clearing marks.
25490 * It will go through the entire marks list updating the calendar.
25491 * If lots of marks will be added, add all the marks and then call
25494 * When the month is changed, i.e. user selects next or previous month,
25495 * marks will be drawed.
25497 * @see elm_calendar_mark_add()
25498 * @see elm_calendar_mark_del()
25499 * @see elm_calendar_marks_clear()
25501 * @ref calendar_example_06
25503 * @ingroup Calendar
25505 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
25508 * Set a day text color to the same that represents Saturdays.
25510 * @param obj The calendar object.
25511 * @param pos The text position. Position is the cell counter, from left
25512 * to right, up to down. It starts on 0 and ends on 41.
25514 * @deprecated use elm_calendar_mark_add() instead like:
25517 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
25518 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25521 * @see elm_calendar_mark_add()
25523 * @ingroup Calendar
25525 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25528 * Set a day text color to the same that represents Sundays.
25530 * @param obj The calendar object.
25531 * @param pos The text position. Position is the cell counter, from left
25532 * to right, up to down. It starts on 0 and ends on 41.
25534 * @deprecated use elm_calendar_mark_add() instead like:
25537 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
25538 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25541 * @see elm_calendar_mark_add()
25543 * @ingroup Calendar
25545 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25548 * Set a day text color to the same that represents Weekdays.
25550 * @param obj The calendar object
25551 * @param pos The text position. Position is the cell counter, from left
25552 * to right, up to down. It starts on 0 and ends on 41.
25554 * @deprecated use elm_calendar_mark_add() instead like:
25557 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
25559 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
25560 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25561 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
25562 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25563 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
25564 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25565 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
25566 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25567 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
25570 * @see elm_calendar_mark_add()
25572 * @ingroup Calendar
25574 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25577 * Set the interval on time updates for an user mouse button hold
25578 * on calendar widgets' month selection.
25580 * @param obj The calendar object
25581 * @param interval The (first) interval value in seconds
25583 * This interval value is @b decreased while the user holds the
25584 * mouse pointer either selecting next or previous month.
25586 * This helps the user to get to a given month distant from the
25587 * current one easier/faster, as it will start to change quicker and
25588 * quicker on mouse button holds.
25590 * The calculation for the next change interval value, starting from
25591 * the one set with this call, is the previous interval divided by
25592 * 1.05, so it decreases a little bit.
25594 * The default starting interval value for automatic changes is
25597 * @see elm_calendar_interval_get()
25599 * @ingroup Calendar
25601 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25604 * Get the interval on time updates for an user mouse button hold
25605 * on calendar widgets' month selection.
25607 * @param obj The calendar object
25608 * @return The (first) interval value, in seconds, set on it
25610 * @see elm_calendar_interval_set() for more details
25612 * @ingroup Calendar
25614 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25621 * @defgroup Diskselector Diskselector
25622 * @ingroup Elementary
25624 * @image html img/widget/diskselector/preview-00.png
25625 * @image latex img/widget/diskselector/preview-00.eps
25627 * A diskselector is a kind of list widget. It scrolls horizontally,
25628 * and can contain label and icon objects. Three items are displayed
25629 * with the selected one in the middle.
25631 * It can act like a circular list with round mode and labels can be
25632 * reduced for a defined length for side items.
25634 * Smart callbacks one can listen to:
25635 * - "selected" - when item is selected, i.e. scroller stops.
25637 * Available styles for it:
25640 * List of examples:
25641 * @li @ref diskselector_example_01
25642 * @li @ref diskselector_example_02
25646 * @addtogroup Diskselector
25650 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(). */
25653 * Add a new diskselector widget to the given parent Elementary
25654 * (container) object.
25656 * @param parent The parent object.
25657 * @return a new diskselector widget handle or @c NULL, on errors.
25659 * This function inserts a new diskselector widget on the canvas.
25661 * @ingroup Diskselector
25663 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25666 * Enable or disable round mode.
25668 * @param obj The diskselector object.
25669 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
25672 * Disabled by default. If round mode is enabled the items list will
25673 * work like a circle list, so when the user reaches the last item,
25674 * the first one will popup.
25676 * @see elm_diskselector_round_get()
25678 * @ingroup Diskselector
25680 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
25683 * Get a value whether round mode is enabled or not.
25685 * @see elm_diskselector_round_set() for details.
25687 * @param obj The diskselector object.
25688 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
25689 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25691 * @ingroup Diskselector
25693 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25696 * Get the side labels max length.
25698 * @deprecated use elm_diskselector_side_label_length_get() instead:
25700 * @param obj The diskselector object.
25701 * @return The max length defined for side labels, or 0 if not a valid
25704 * @ingroup Diskselector
25706 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25709 * Set the side labels max length.
25711 * @deprecated use elm_diskselector_side_label_length_set() instead:
25713 * @param obj The diskselector object.
25714 * @param len The max length defined for side labels.
25716 * @ingroup Diskselector
25718 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25721 * Get the side labels max length.
25723 * @see elm_diskselector_side_label_length_set() for details.
25725 * @param obj The diskselector object.
25726 * @return The max length defined for side labels, or 0 if not a valid
25729 * @ingroup Diskselector
25731 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25734 * Set the side labels max length.
25736 * @param obj The diskselector object.
25737 * @param len The max length defined for side labels.
25739 * Length is the number of characters of items' label that will be
25740 * visible when it's set on side positions. It will just crop
25741 * the string after defined size. E.g.:
25743 * An item with label "January" would be displayed on side position as
25744 * "Jan" if max length is set to 3, or "Janu", if this property
25747 * When it's selected, the entire label will be displayed, except for
25748 * width restrictions. In this case label will be cropped and "..."
25749 * will be concatenated.
25751 * Default side label max length is 3.
25753 * This property will be applyed over all items, included before or
25754 * later this function call.
25756 * @ingroup Diskselector
25758 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25761 * Set the number of items to be displayed.
25763 * @param obj The diskselector object.
25764 * @param num The number of items the diskselector will display.
25766 * Default value is 3, and also it's the minimun. If @p num is less
25767 * than 3, it will be set to 3.
25769 * Also, it can be set on theme, using data item @c display_item_num
25770 * on group "elm/diskselector/item/X", where X is style set.
25773 * group { name: "elm/diskselector/item/X";
25775 * item: "display_item_num" "5";
25778 * @ingroup Diskselector
25780 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
25783 * Get the number of items in the diskselector object.
25785 * @param obj The diskselector object.
25787 * @ingroup Diskselector
25789 EAPI int elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25792 * Set bouncing behaviour when the scrolled content reaches an edge.
25794 * Tell the internal scroller object whether it should bounce or not
25795 * when it reaches the respective edges for each axis.
25797 * @param obj The diskselector object.
25798 * @param h_bounce Whether to bounce or not in the horizontal axis.
25799 * @param v_bounce Whether to bounce or not in the vertical axis.
25801 * @see elm_scroller_bounce_set()
25803 * @ingroup Diskselector
25805 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
25808 * Get the bouncing behaviour of the internal scroller.
25810 * Get whether the internal scroller should bounce when the edge of each
25811 * axis is reached scrolling.
25813 * @param obj The diskselector object.
25814 * @param h_bounce Pointer where to store the bounce state of the horizontal
25816 * @param v_bounce Pointer where to store the bounce state of the vertical
25819 * @see elm_scroller_bounce_get()
25820 * @see elm_diskselector_bounce_set()
25822 * @ingroup Diskselector
25824 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
25827 * Get the scrollbar policy.
25829 * @see elm_diskselector_scroller_policy_get() for details.
25831 * @param obj The diskselector object.
25832 * @param policy_h Pointer where to store horizontal scrollbar policy.
25833 * @param policy_v Pointer where to store vertical scrollbar policy.
25835 * @ingroup Diskselector
25837 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);
25840 * Set the scrollbar policy.
25842 * @param obj The diskselector object.
25843 * @param policy_h Horizontal scrollbar policy.
25844 * @param policy_v Vertical scrollbar policy.
25846 * This sets the scrollbar visibility policy for the given scroller.
25847 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
25848 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
25849 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
25850 * This applies respectively for the horizontal and vertical scrollbars.
25852 * The both are disabled by default, i.e., are set to
25853 * #ELM_SCROLLER_POLICY_OFF.
25855 * @ingroup Diskselector
25857 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
25860 * Remove all diskselector's items.
25862 * @param obj The diskselector object.
25864 * @see elm_diskselector_item_del()
25865 * @see elm_diskselector_item_append()
25867 * @ingroup Diskselector
25869 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25872 * Get a list of all the diskselector items.
25874 * @param obj The diskselector object.
25875 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
25876 * or @c NULL on failure.
25878 * @see elm_diskselector_item_append()
25879 * @see elm_diskselector_item_del()
25880 * @see elm_diskselector_clear()
25882 * @ingroup Diskselector
25884 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25887 * Appends a new item to the diskselector object.
25889 * @param obj The diskselector object.
25890 * @param label The label of the diskselector item.
25891 * @param icon The icon object to use at left side of the item. An
25892 * icon can be any Evas object, but usually it is an icon created
25893 * with elm_icon_add().
25894 * @param func The function to call when the item is selected.
25895 * @param data The data to associate with the item for related callbacks.
25897 * @return The created item or @c NULL upon failure.
25899 * A new item will be created and appended to the diskselector, i.e., will
25900 * be set as last item. Also, if there is no selected item, it will
25901 * be selected. This will always happens for the first appended item.
25903 * If no icon is set, label will be centered on item position, otherwise
25904 * the icon will be placed at left of the label, that will be shifted
25907 * Items created with this method can be deleted with
25908 * elm_diskselector_item_del().
25910 * Associated @p data can be properly freed when item is deleted if a
25911 * callback function is set with elm_diskselector_item_del_cb_set().
25913 * If a function is passed as argument, it will be called everytime this item
25914 * is selected, i.e., the user stops the diskselector with this
25915 * item on center position. If such function isn't needed, just passing
25916 * @c NULL as @p func is enough. The same should be done for @p data.
25918 * Simple example (with no function callback or data associated):
25920 * disk = elm_diskselector_add(win);
25921 * ic = elm_icon_add(win);
25922 * elm_icon_file_set(ic, "path/to/image", NULL);
25923 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
25924 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
25927 * @see elm_diskselector_item_del()
25928 * @see elm_diskselector_item_del_cb_set()
25929 * @see elm_diskselector_clear()
25930 * @see elm_icon_add()
25932 * @ingroup Diskselector
25934 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);
25938 * Delete them item from the diskselector.
25940 * @param it The item of diskselector to be deleted.
25942 * If deleting all diskselector items is required, elm_diskselector_clear()
25943 * should be used instead of getting items list and deleting each one.
25945 * @see elm_diskselector_clear()
25946 * @see elm_diskselector_item_append()
25947 * @see elm_diskselector_item_del_cb_set()
25949 * @ingroup Diskselector
25951 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25954 * Set the function called when a diskselector item is freed.
25956 * @param it The item to set the callback on
25957 * @param func The function called
25959 * If there is a @p func, then it will be called prior item's memory release.
25960 * That will be called with the following arguments:
25962 * @li item's Evas object;
25965 * This way, a data associated to a diskselector item could be properly
25968 * @ingroup Diskselector
25970 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
25973 * Get the data associated to the item.
25975 * @param it The diskselector item
25976 * @return The data associated to @p it
25978 * The return value is a pointer to data associated to @p item when it was
25979 * created, with function elm_diskselector_item_append(). If no data
25980 * was passed as argument, it will return @c NULL.
25982 * @see elm_diskselector_item_append()
25984 * @ingroup Diskselector
25986 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25989 * Set the icon associated to the item.
25991 * @param it The diskselector item
25992 * @param icon The icon object to associate with @p it
25994 * The icon object to use at left side of the item. An
25995 * icon can be any Evas object, but usually it is an icon created
25996 * with elm_icon_add().
25998 * Once the icon object is set, a previously set one will be deleted.
25999 * @warning Setting the same icon for two items will cause the icon to
26000 * dissapear from the first item.
26002 * If an icon was passed as argument on item creation, with function
26003 * elm_diskselector_item_append(), it will be already
26004 * associated to the item.
26006 * @see elm_diskselector_item_append()
26007 * @see elm_diskselector_item_icon_get()
26009 * @ingroup Diskselector
26011 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
26014 * Get the icon associated to the item.
26016 * @param it The diskselector item
26017 * @return The icon associated to @p it
26019 * The return value is a pointer to the icon associated to @p item when it was
26020 * created, with function elm_diskselector_item_append(), or later
26021 * with function elm_diskselector_item_icon_set. If no icon
26022 * was passed as argument, it will return @c NULL.
26024 * @see elm_diskselector_item_append()
26025 * @see elm_diskselector_item_icon_set()
26027 * @ingroup Diskselector
26029 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26032 * Set the label of item.
26034 * @param it The item of diskselector.
26035 * @param label The label of item.
26037 * The label to be displayed by the item.
26039 * If no icon is set, label will be centered on item position, otherwise
26040 * the icon will be placed at left of the label, that will be shifted
26043 * An item with label "January" would be displayed on side position as
26044 * "Jan" if max length is set to 3 with function
26045 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
26048 * When this @p item is selected, the entire label will be displayed,
26049 * except for width restrictions.
26050 * In this case label will be cropped and "..." will be concatenated,
26051 * but only for display purposes. It will keep the entire string, so
26052 * if diskselector is resized the remaining characters will be displayed.
26054 * If a label was passed as argument on item creation, with function
26055 * elm_diskselector_item_append(), it will be already
26056 * displayed by the item.
26058 * @see elm_diskselector_side_label_lenght_set()
26059 * @see elm_diskselector_item_label_get()
26060 * @see elm_diskselector_item_append()
26062 * @ingroup Diskselector
26064 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
26067 * Get the label of item.
26069 * @param it The item of diskselector.
26070 * @return The label of item.
26072 * The return value is a pointer to the label associated to @p item when it was
26073 * created, with function elm_diskselector_item_append(), or later
26074 * with function elm_diskselector_item_label_set. If no label
26075 * was passed as argument, it will return @c NULL.
26077 * @see elm_diskselector_item_label_set() for more details.
26078 * @see elm_diskselector_item_append()
26080 * @ingroup Diskselector
26082 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26085 * Get the selected item.
26087 * @param obj The diskselector object.
26088 * @return The selected diskselector item.
26090 * The selected item can be unselected with function
26091 * elm_diskselector_item_selected_set(), and the first item of
26092 * diskselector will be selected.
26094 * The selected item always will be centered on diskselector, with
26095 * full label displayed, i.e., max lenght set to side labels won't
26096 * apply on the selected item. More details on
26097 * elm_diskselector_side_label_length_set().
26099 * @ingroup Diskselector
26101 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26104 * Set the selected state of an item.
26106 * @param it The diskselector item
26107 * @param selected The selected state
26109 * This sets the selected state of the given item @p it.
26110 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
26112 * If a new item is selected the previosly selected will be unselected.
26113 * Previoulsy selected item can be get with function
26114 * elm_diskselector_selected_item_get().
26116 * If the item @p it is unselected, the first item of diskselector will
26119 * Selected items will be visible on center position of diskselector.
26120 * So if it was on another position before selected, or was invisible,
26121 * diskselector will animate items until the selected item reaches center
26124 * @see elm_diskselector_item_selected_get()
26125 * @see elm_diskselector_selected_item_get()
26127 * @ingroup Diskselector
26129 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
26132 * Get whether the @p item is selected or not.
26134 * @param it The diskselector item.
26135 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
26136 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
26138 * @see elm_diskselector_selected_item_set() for details.
26139 * @see elm_diskselector_item_selected_get()
26141 * @ingroup Diskselector
26143 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26146 * Get the first item of the diskselector.
26148 * @param obj The diskselector object.
26149 * @return The first item, or @c NULL if none.
26151 * The list of items follows append order. So it will return the first
26152 * item appended to the widget that wasn't deleted.
26154 * @see elm_diskselector_item_append()
26155 * @see elm_diskselector_items_get()
26157 * @ingroup Diskselector
26159 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26162 * Get the last item of the diskselector.
26164 * @param obj The diskselector object.
26165 * @return The last item, or @c NULL if none.
26167 * The list of items follows append order. So it will return last first
26168 * item appended to the widget that wasn't deleted.
26170 * @see elm_diskselector_item_append()
26171 * @see elm_diskselector_items_get()
26173 * @ingroup Diskselector
26175 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26178 * Get the item before @p item in diskselector.
26180 * @param it The diskselector item.
26181 * @return The item before @p item, or @c NULL if none or on failure.
26183 * The list of items follows append order. So it will return item appended
26184 * just before @p item and that wasn't deleted.
26186 * If it is the first item, @c NULL will be returned.
26187 * First item can be get by elm_diskselector_first_item_get().
26189 * @see elm_diskselector_item_append()
26190 * @see elm_diskselector_items_get()
26192 * @ingroup Diskselector
26194 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26197 * Get the item after @p item in diskselector.
26199 * @param it The diskselector item.
26200 * @return The item after @p item, or @c NULL if none or on failure.
26202 * The list of items follows append order. So it will return item appended
26203 * just after @p item and that wasn't deleted.
26205 * If it is the last item, @c NULL will be returned.
26206 * Last item can be get by elm_diskselector_last_item_get().
26208 * @see elm_diskselector_item_append()
26209 * @see elm_diskselector_items_get()
26211 * @ingroup Diskselector
26213 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26216 * Set the text to be shown in the diskselector item.
26218 * @param item Target item
26219 * @param text The text to set in the content
26221 * Setup the text as tooltip to object. The item can have only one tooltip,
26222 * so any previous tooltip data is removed.
26224 * @see elm_object_tooltip_text_set() for more details.
26226 * @ingroup Diskselector
26228 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
26231 * Set the content to be shown in the tooltip item.
26233 * Setup the tooltip to item. The item can have only one tooltip,
26234 * so any previous tooltip data is removed. @p func(with @p data) will
26235 * be called every time that need show the tooltip and it should
26236 * return a valid Evas_Object. This object is then managed fully by
26237 * tooltip system and is deleted when the tooltip is gone.
26239 * @param item the diskselector item being attached a tooltip.
26240 * @param func the function used to create the tooltip contents.
26241 * @param data what to provide to @a func as callback data/context.
26242 * @param del_cb called when data is not needed anymore, either when
26243 * another callback replaces @p func, the tooltip is unset with
26244 * elm_diskselector_item_tooltip_unset() or the owner @a item
26245 * dies. This callback receives as the first parameter the
26246 * given @a data, and @c event_info is the item.
26248 * @see elm_object_tooltip_content_cb_set() for more details.
26250 * @ingroup Diskselector
26252 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);
26255 * Unset tooltip from item.
26257 * @param item diskselector item to remove previously set tooltip.
26259 * Remove tooltip from item. The callback provided as del_cb to
26260 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
26261 * it is not used anymore.
26263 * @see elm_object_tooltip_unset() for more details.
26264 * @see elm_diskselector_item_tooltip_content_cb_set()
26266 * @ingroup Diskselector
26268 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26272 * Sets a different style for this item tooltip.
26274 * @note before you set a style you should define a tooltip with
26275 * elm_diskselector_item_tooltip_content_cb_set() or
26276 * elm_diskselector_item_tooltip_text_set()
26278 * @param item diskselector item with tooltip already set.
26279 * @param style the theme style to use (default, transparent, ...)
26281 * @see elm_object_tooltip_style_set() for more details.
26283 * @ingroup Diskselector
26285 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26288 * Get the style for this item tooltip.
26290 * @param item diskselector item with tooltip already set.
26291 * @return style the theme style in use, defaults to "default". If the
26292 * object does not have a tooltip set, then NULL is returned.
26294 * @see elm_object_tooltip_style_get() for more details.
26295 * @see elm_diskselector_item_tooltip_style_set()
26297 * @ingroup Diskselector
26299 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26302 * Set the cursor to be shown when mouse is over the diskselector item
26304 * @param item Target item
26305 * @param cursor the cursor name to be used.
26307 * @see elm_object_cursor_set() for more details.
26309 * @ingroup Diskselector
26311 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
26314 * Get the cursor to be shown when mouse is over the diskselector item
26316 * @param item diskselector item with cursor already set.
26317 * @return the cursor name.
26319 * @see elm_object_cursor_get() for more details.
26320 * @see elm_diskselector_cursor_set()
26322 * @ingroup Diskselector
26324 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26328 * Unset the cursor to be shown when mouse is over the diskselector item
26330 * @param item Target item
26332 * @see elm_object_cursor_unset() for more details.
26333 * @see elm_diskselector_cursor_set()
26335 * @ingroup Diskselector
26337 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26340 * Sets a different style for this item cursor.
26342 * @note before you set a style you should define a cursor with
26343 * elm_diskselector_item_cursor_set()
26345 * @param item diskselector item with cursor already set.
26346 * @param style the theme style to use (default, transparent, ...)
26348 * @see elm_object_cursor_style_set() for more details.
26350 * @ingroup Diskselector
26352 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26356 * Get the style for this item cursor.
26358 * @param item diskselector item with cursor already set.
26359 * @return style the theme style in use, defaults to "default". If the
26360 * object does not have a cursor set, then @c NULL is returned.
26362 * @see elm_object_cursor_style_get() for more details.
26363 * @see elm_diskselector_item_cursor_style_set()
26365 * @ingroup Diskselector
26367 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26371 * Set if the cursor set should be searched on the theme or should use
26372 * the provided by the engine, only.
26374 * @note before you set if should look on theme you should define a cursor
26375 * with elm_diskselector_item_cursor_set().
26376 * By default it will only look for cursors provided by the engine.
26378 * @param item widget item with cursor already set.
26379 * @param engine_only boolean to define if cursors set with
26380 * elm_diskselector_item_cursor_set() should be searched only
26381 * between cursors provided by the engine or searched on widget's
26384 * @see elm_object_cursor_engine_only_set() for more details.
26386 * @ingroup Diskselector
26388 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
26391 * Get the cursor engine only usage for this item cursor.
26393 * @param item widget item with cursor already set.
26394 * @return engine_only boolean to define it cursors should be looked only
26395 * between the provided by the engine or searched on widget's theme as well.
26396 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
26398 * @see elm_object_cursor_engine_only_get() for more details.
26399 * @see elm_diskselector_item_cursor_engine_only_set()
26401 * @ingroup Diskselector
26403 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26410 * @defgroup Colorselector Colorselector
26414 * @image html img/widget/colorselector/preview-00.png
26415 * @image latex img/widget/colorselector/preview-00.eps
26417 * @brief Widget for user to select a color.
26419 * Signals that you can add callbacks for are:
26420 * "changed" - When the color value changes(event_info is NULL).
26422 * See @ref tutorial_colorselector.
26425 * @brief Add a new colorselector to the parent
26427 * @param parent The parent object
26428 * @return The new object or NULL if it cannot be created
26430 * @ingroup Colorselector
26432 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26434 * Set a color for the colorselector
26436 * @param obj Colorselector object
26437 * @param r r-value of color
26438 * @param g g-value of color
26439 * @param b b-value of color
26440 * @param a a-value of color
26442 * @ingroup Colorselector
26444 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
26446 * Get a color from the colorselector
26448 * @param obj Colorselector object
26449 * @param r integer pointer for r-value of color
26450 * @param g integer pointer for g-value of color
26451 * @param b integer pointer for b-value of color
26452 * @param a integer pointer for a-value of color
26454 * @ingroup Colorselector
26456 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
26462 * @defgroup Ctxpopup Ctxpopup
26464 * @image html img/widget/ctxpopup/preview-00.png
26465 * @image latex img/widget/ctxpopup/preview-00.eps
26467 * @brief Context popup widet.
26469 * A ctxpopup is a widget that, when shown, pops up a list of items.
26470 * It automatically chooses an area inside its parent object's view
26471 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
26472 * optimally fit into it. In the default theme, it will also point an
26473 * arrow to it's top left position at the time one shows it. Ctxpopup
26474 * items have a label and/or an icon. It is intended for a small
26475 * number of items (hence the use of list, not genlist).
26477 * @note Ctxpopup is a especialization of @ref Hover.
26479 * Signals that you can add callbacks for are:
26480 * "dismissed" - the ctxpopup was dismissed
26482 * Default contents parts of the ctxpopup widget that you can use for are:
26483 * @li "elm.swallow.content" - A content of the ctxpopup
26485 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
26488 typedef enum _Elm_Ctxpopup_Direction
26490 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
26492 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
26493 the clicked area */
26494 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
26495 the clicked area */
26496 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
26498 ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
26499 } Elm_Ctxpopup_Direction;
26502 * @brief Add a new Ctxpopup object to the parent.
26504 * @param parent Parent object
26505 * @return New object or @c NULL, if it cannot be created
26507 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26509 * @brief Set the Ctxpopup's parent
26511 * @param obj The ctxpopup object
26512 * @param area The parent to use
26514 * Set the parent object.
26516 * @note elm_ctxpopup_add() will automatically call this function
26517 * with its @c parent argument.
26519 * @see elm_ctxpopup_add()
26520 * @see elm_hover_parent_set()
26522 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
26524 * @brief Get the Ctxpopup's parent
26526 * @param obj The ctxpopup object
26528 * @see elm_ctxpopup_hover_parent_set() for more information
26530 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26532 * @brief Clear all items in the given ctxpopup object.
26534 * @param obj Ctxpopup object
26536 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26538 * @brief Change the ctxpopup's orientation to horizontal or vertical.
26540 * @param obj Ctxpopup object
26541 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
26543 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
26545 * @brief Get the value of current ctxpopup object's orientation.
26547 * @param obj Ctxpopup object
26548 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
26550 * @see elm_ctxpopup_horizontal_set()
26552 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26554 * @brief Add a new item to a ctxpopup object.
26556 * @param obj Ctxpopup object
26557 * @param icon Icon to be set on new item
26558 * @param label The Label of the new item
26559 * @param func Convenience function called when item selected
26560 * @param data Data passed to @p func
26561 * @return A handle to the item added or @c NULL, on errors
26563 * @warning Ctxpopup can't hold both an item list and a content at the same
26564 * time. When an item is added, any previous content will be removed.
26566 * @see elm_ctxpopup_content_set()
26568 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);
26570 * @brief Delete the given item in a ctxpopup object.
26572 * @param it Ctxpopup item to be deleted
26574 * @see elm_ctxpopup_item_append()
26576 EAPI void elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26578 * @brief Set the ctxpopup item's state as disabled or enabled.
26580 * @param it Ctxpopup item to be enabled/disabled
26581 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
26583 * When disabled the item is greyed out to indicate it's state.
26585 EAPI void elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
26587 * @brief Get the ctxpopup item's disabled/enabled state.
26589 * @param it Ctxpopup item to be enabled/disabled
26590 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
26592 * @see elm_ctxpopup_item_disabled_set()
26594 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26596 * @brief Get the icon object for the given ctxpopup item.
26598 * @param it Ctxpopup item
26599 * @return icon object or @c NULL, if the item does not have icon or an error
26602 * @see elm_ctxpopup_item_append()
26603 * @see elm_ctxpopup_item_icon_set()
26605 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26607 * @brief Sets the side icon associated with the ctxpopup item
26609 * @param it Ctxpopup item
26610 * @param icon Icon object to be set
26612 * Once the icon object is set, a previously set one will be deleted.
26613 * @warning Setting the same icon for two items will cause the icon to
26614 * dissapear from the first item.
26616 * @see elm_ctxpopup_item_append()
26618 EAPI void elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26620 * @brief Get the label for the given ctxpopup item.
26622 * @param it Ctxpopup item
26623 * @return label string or @c NULL, if the item does not have label or an
26626 * @see elm_ctxpopup_item_append()
26627 * @see elm_ctxpopup_item_label_set()
26629 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26631 * @brief (Re)set the label on the given ctxpopup item.
26633 * @param it Ctxpopup item
26634 * @param label String to set as label
26636 EAPI void elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26638 * @brief Set an elm widget as the content of the ctxpopup.
26640 * @param obj Ctxpopup object
26641 * @param content Content to be swallowed
26643 * If the content object is already set, a previous one will bedeleted. If
26644 * you want to keep that old content object, use the
26645 * elm_ctxpopup_content_unset() function.
26647 * @deprecated use elm_object_content_set()
26649 * @warning Ctxpopup can't hold both a item list and a content at the same
26650 * time. When a content is set, any previous items will be removed.
26652 EINA_DEPRECATED EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
26654 * @brief Unset the ctxpopup content
26656 * @param obj Ctxpopup object
26657 * @return The content that was being used
26659 * Unparent and return the content object which was set for this widget.
26661 * @deprecated use elm_object_content_unset()
26663 * @see elm_ctxpopup_content_set()
26665 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
26667 * @brief Set the direction priority of a ctxpopup.
26669 * @param obj Ctxpopup object
26670 * @param first 1st priority of direction
26671 * @param second 2nd priority of direction
26672 * @param third 3th priority of direction
26673 * @param fourth 4th priority of direction
26675 * This functions gives a chance to user to set the priority of ctxpopup
26676 * showing direction. This doesn't guarantee the ctxpopup will appear in the
26677 * requested direction.
26679 * @see Elm_Ctxpopup_Direction
26681 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);
26683 * @brief Get the direction priority of a ctxpopup.
26685 * @param obj Ctxpopup object
26686 * @param first 1st priority of direction to be returned
26687 * @param second 2nd priority of direction to be returned
26688 * @param third 3th priority of direction to be returned
26689 * @param fourth 4th priority of direction to be returned
26691 * @see elm_ctxpopup_direction_priority_set() for more information.
26693 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);
26696 * @brief Get the current direction of a ctxpopup.
26698 * @param obj Ctxpopup object
26699 * @return current direction of a ctxpopup
26701 * @warning Once the ctxpopup showed up, the direction would be determined
26703 EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26712 * @defgroup Transit Transit
26713 * @ingroup Elementary
26715 * Transit is designed to apply various animated transition effects to @c
26716 * Evas_Object, such like translation, rotation, etc. For using these
26717 * effects, create an @ref Elm_Transit and add the desired transition effects.
26719 * Once the effects are added into transit, they will be automatically
26720 * managed (their callback will be called until the duration is ended, and
26721 * they will be deleted on completion).
26725 * Elm_Transit *trans = elm_transit_add();
26726 * elm_transit_object_add(trans, obj);
26727 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
26728 * elm_transit_duration_set(transit, 1);
26729 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
26730 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
26731 * elm_transit_repeat_times_set(transit, 3);
26734 * Some transition effects are used to change the properties of objects. They
26736 * @li @ref elm_transit_effect_translation_add
26737 * @li @ref elm_transit_effect_color_add
26738 * @li @ref elm_transit_effect_rotation_add
26739 * @li @ref elm_transit_effect_wipe_add
26740 * @li @ref elm_transit_effect_zoom_add
26741 * @li @ref elm_transit_effect_resizing_add
26743 * Other transition effects are used to make one object disappear and another
26744 * object appear on its old place. These effects are:
26746 * @li @ref elm_transit_effect_flip_add
26747 * @li @ref elm_transit_effect_resizable_flip_add
26748 * @li @ref elm_transit_effect_fade_add
26749 * @li @ref elm_transit_effect_blend_add
26751 * It's also possible to make a transition chain with @ref
26752 * elm_transit_chain_transit_add.
26754 * @warning We strongly recommend to use elm_transit just when edje can not do
26755 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
26756 * animations can be manipulated inside the theme.
26758 * List of examples:
26759 * @li @ref transit_example_01_explained
26760 * @li @ref transit_example_02_explained
26761 * @li @ref transit_example_03_c
26762 * @li @ref transit_example_04_c
26768 * @enum Elm_Transit_Tween_Mode
26770 * The type of acceleration used in the transition.
26774 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
26775 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
26776 over time, then decrease again
26778 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
26780 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
26782 } Elm_Transit_Tween_Mode;
26785 * @enum Elm_Transit_Effect_Flip_Axis
26787 * The axis where flip effect should be applied.
26791 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
26792 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
26793 } Elm_Transit_Effect_Flip_Axis;
26795 * @enum Elm_Transit_Effect_Wipe_Dir
26797 * The direction where the wipe effect should occur.
26801 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
26802 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
26803 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
26804 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
26805 } Elm_Transit_Effect_Wipe_Dir;
26806 /** @enum Elm_Transit_Effect_Wipe_Type
26808 * Whether the wipe effect should show or hide the object.
26812 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
26814 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
26816 } Elm_Transit_Effect_Wipe_Type;
26819 * @typedef Elm_Transit
26821 * The Transit created with elm_transit_add(). This type has the information
26822 * about the objects which the transition will be applied, and the
26823 * transition effects that will be used. It also contains info about
26824 * duration, number of repetitions, auto-reverse, etc.
26826 typedef struct _Elm_Transit Elm_Transit;
26827 typedef void Elm_Transit_Effect;
26829 * @typedef Elm_Transit_Effect_Transition_Cb
26831 * Transition callback called for this effect on each transition iteration.
26833 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
26835 * Elm_Transit_Effect_End_Cb
26837 * Transition callback called for this effect when the transition is over.
26839 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
26842 * Elm_Transit_Del_Cb
26844 * A callback called when the transit is deleted.
26846 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
26851 * @note Is not necessary to delete the transit object, it will be deleted at
26852 * the end of its operation.
26853 * @note The transit will start playing when the program enter in the main loop, is not
26854 * necessary to give a start to the transit.
26856 * @return The transit object.
26860 EAPI Elm_Transit *elm_transit_add(void);
26863 * Stops the animation and delete the @p transit object.
26865 * Call this function if you wants to stop the animation before the duration
26866 * time. Make sure the @p transit object is still alive with
26867 * elm_transit_del_cb_set() function.
26868 * All added effects will be deleted, calling its repective data_free_cb
26869 * functions. The function setted by elm_transit_del_cb_set() will be called.
26871 * @see elm_transit_del_cb_set()
26873 * @param transit The transit object to be deleted.
26876 * @warning Just call this function if you are sure the transit is alive.
26878 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
26881 * Add a new effect to the transit.
26883 * @note The cb function and the data are the key to the effect. If you try to
26884 * add an already added effect, nothing is done.
26885 * @note After the first addition of an effect in @p transit, if its
26886 * effect list become empty again, the @p transit will be killed by
26887 * elm_transit_del(transit) function.
26891 * Elm_Transit *transit = elm_transit_add();
26892 * elm_transit_effect_add(transit,
26893 * elm_transit_effect_blend_op,
26894 * elm_transit_effect_blend_context_new(),
26895 * elm_transit_effect_blend_context_free);
26898 * @param transit The transit object.
26899 * @param transition_cb The operation function. It is called when the
26900 * animation begins, it is the function that actually performs the animation.
26901 * It is called with the @p data, @p transit and the time progression of the
26902 * animation (a double value between 0.0 and 1.0).
26903 * @param effect The context data of the effect.
26904 * @param end_cb The function to free the context data, it will be called
26905 * at the end of the effect, it must finalize the animation and free the
26909 * @warning The transit free the context data at the and of the transition with
26910 * the data_free_cb function, do not use the context data in another transit.
26912 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);
26915 * Delete an added effect.
26917 * This function will remove the effect from the @p transit, calling the
26918 * data_free_cb to free the @p data.
26920 * @see elm_transit_effect_add()
26922 * @note If the effect is not found, nothing is done.
26923 * @note If the effect list become empty, this function will call
26924 * elm_transit_del(transit), that is, it will kill the @p transit.
26926 * @param transit The transit object.
26927 * @param transition_cb The operation function.
26928 * @param effect The context data of the effect.
26932 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);
26935 * Add new object to apply the effects.
26937 * @note After the first addition of an object in @p transit, if its
26938 * object list become empty again, the @p transit will be killed by
26939 * elm_transit_del(transit) function.
26940 * @note If the @p obj belongs to another transit, the @p obj will be
26941 * removed from it and it will only belong to the @p transit. If the old
26942 * transit stays without objects, it will die.
26943 * @note When you add an object into the @p transit, its state from
26944 * evas_object_pass_events_get(obj) is saved, and it is applied when the
26945 * transit ends, if you change this state whith evas_object_pass_events_set()
26946 * after add the object, this state will change again when @p transit stops to
26949 * @param transit The transit object.
26950 * @param obj Object to be animated.
26953 * @warning It is not allowed to add a new object after transit begins to go.
26955 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
26958 * Removes an added object from the transit.
26960 * @note If the @p obj is not in the @p transit, nothing is done.
26961 * @note If the list become empty, this function will call
26962 * elm_transit_del(transit), that is, it will kill the @p transit.
26964 * @param transit The transit object.
26965 * @param obj Object to be removed from @p transit.
26968 * @warning It is not allowed to remove objects after transit begins to go.
26970 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
26973 * Get the objects of the transit.
26975 * @param transit The transit object.
26976 * @return a Eina_List with the objects from the transit.
26980 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26983 * Enable/disable keeping up the objects states.
26984 * If it is not kept, the objects states will be reset when transition ends.
26986 * @note @p transit can not be NULL.
26987 * @note One state includes geometry, color, map data.
26989 * @param transit The transit object.
26990 * @param state_keep Keeping or Non Keeping.
26994 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
26997 * Get a value whether the objects states will be reset or not.
26999 * @note @p transit can not be NULL
27001 * @see elm_transit_objects_final_state_keep_set()
27003 * @param transit The transit object.
27004 * @return EINA_TRUE means the states of the objects will be reset.
27005 * If @p transit is NULL, EINA_FALSE is returned
27009 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27012 * Set the event enabled when transit is operating.
27014 * If @p enabled is EINA_TRUE, the objects of the transit will receives
27015 * events from mouse and keyboard during the animation.
27016 * @note When you add an object with elm_transit_object_add(), its state from
27017 * evas_object_pass_events_get(obj) is saved, and it is applied when the
27018 * transit ends, if you change this state with evas_object_pass_events_set()
27019 * after adding the object, this state will change again when @p transit stops
27022 * @param transit The transit object.
27023 * @param enabled Events are received when enabled is @c EINA_TRUE, and
27024 * ignored otherwise.
27028 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
27031 * Get the value of event enabled status.
27033 * @see elm_transit_event_enabled_set()
27035 * @param transit The Transit object
27036 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
27037 * EINA_FALSE is returned
27041 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27044 * Set the user-callback function when the transit is deleted.
27046 * @note Using this function twice will overwrite the first function setted.
27047 * @note the @p transit object will be deleted after call @p cb function.
27049 * @param transit The transit object.
27050 * @param cb Callback function pointer. This function will be called before
27051 * the deletion of the transit.
27052 * @param data Callback funtion user data. It is the @p op parameter.
27056 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
27059 * Set reverse effect automatically.
27061 * If auto reverse is setted, after running the effects with the progress
27062 * parameter from 0 to 1, it will call the effecs again with the progress
27063 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
27064 * where the duration was setted with the function elm_transit_add and
27065 * the repeat with the function elm_transit_repeat_times_set().
27067 * @param transit The transit object.
27068 * @param reverse EINA_TRUE means the auto_reverse is on.
27072 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
27075 * Get if the auto reverse is on.
27077 * @see elm_transit_auto_reverse_set()
27079 * @param transit The transit object.
27080 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
27081 * EINA_FALSE is returned
27085 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27088 * Set the transit repeat count. Effect will be repeated by repeat count.
27090 * This function sets the number of repetition the transit will run after
27091 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
27092 * If the @p repeat is a negative number, it will repeat infinite times.
27094 * @note If this function is called during the transit execution, the transit
27095 * will run @p repeat times, ignoring the times it already performed.
27097 * @param transit The transit object
27098 * @param repeat Repeat count
27102 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
27105 * Get the transit repeat count.
27107 * @see elm_transit_repeat_times_set()
27109 * @param transit The Transit object.
27110 * @return The repeat count. If @p transit is NULL
27115 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27118 * Set the transit animation acceleration type.
27120 * This function sets the tween mode of the transit that can be:
27121 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
27122 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
27123 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
27124 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
27126 * @param transit The transit object.
27127 * @param tween_mode The tween type.
27131 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
27134 * Get the transit animation acceleration type.
27136 * @note @p transit can not be NULL
27138 * @param transit The transit object.
27139 * @return The tween type. If @p transit is NULL
27140 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
27144 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27147 * Set the transit animation time
27149 * @note @p transit can not be NULL
27151 * @param transit The transit object.
27152 * @param duration The animation time.
27156 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
27159 * Get the transit animation time
27161 * @note @p transit can not be NULL
27163 * @param transit The transit object.
27165 * @return The transit animation time.
27169 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27172 * Starts the transition.
27173 * Once this API is called, the transit begins to measure the time.
27175 * @note @p transit can not be NULL
27177 * @param transit The transit object.
27181 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27184 * Pause/Resume the transition.
27186 * If you call elm_transit_go again, the transit will be started from the
27187 * beginning, and will be unpaused.
27189 * @note @p transit can not be NULL
27191 * @param transit The transit object.
27192 * @param paused Whether the transition should be paused or not.
27196 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
27199 * Get the value of paused status.
27201 * @see elm_transit_paused_set()
27203 * @note @p transit can not be NULL
27205 * @param transit The transit object.
27206 * @return EINA_TRUE means transition is paused. If @p transit is NULL
27207 * EINA_FALSE is returned
27211 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27214 * Get the time progression of the animation (a double value between 0.0 and 1.0).
27216 * The value returned is a fraction (current time / total time). It
27217 * represents the progression position relative to the total.
27219 * @note @p transit can not be NULL
27221 * @param transit The transit object.
27223 * @return The time progression value. If @p transit is NULL
27228 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27231 * Makes the chain relationship between two transits.
27233 * @note @p transit can not be NULL. Transit would have multiple chain transits.
27234 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
27236 * @param transit The transit object.
27237 * @param chain_transit The chain transit object. This transit will be operated
27238 * after transit is done.
27240 * This function adds @p chain_transit transition to a chain after the @p
27241 * transit, and will be started as soon as @p transit ends. See @ref
27242 * transit_example_02_explained for a full example.
27246 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
27249 * Cut off the chain relationship between two transits.
27251 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
27252 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
27254 * @param transit The transit object.
27255 * @param chain_transit The chain transit object.
27257 * This function remove the @p chain_transit transition from the @p transit.
27261 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
27264 * Get the current chain transit list.
27266 * @note @p transit can not be NULL.
27268 * @param transit The transit object.
27269 * @return chain transit list.
27273 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
27276 * Add the Resizing Effect to Elm_Transit.
27278 * @note This API is one of the facades. It creates resizing effect context
27279 * and add it's required APIs to elm_transit_effect_add.
27281 * @see elm_transit_effect_add()
27283 * @param transit Transit object.
27284 * @param from_w Object width size when effect begins.
27285 * @param from_h Object height size when effect begins.
27286 * @param to_w Object width size when effect ends.
27287 * @param to_h Object height size when effect ends.
27288 * @return Resizing effect context data.
27292 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);
27295 * Add the Translation Effect to Elm_Transit.
27297 * @note This API is one of the facades. It creates translation effect context
27298 * and add it's required APIs to elm_transit_effect_add.
27300 * @see elm_transit_effect_add()
27302 * @param transit Transit object.
27303 * @param from_dx X Position variation when effect begins.
27304 * @param from_dy Y Position variation when effect begins.
27305 * @param to_dx X Position variation when effect ends.
27306 * @param to_dy Y Position variation when effect ends.
27307 * @return Translation effect context data.
27310 * @warning It is highly recommended just create a transit with this effect when
27311 * the window that the objects of the transit belongs has already been created.
27312 * This is because this effect needs the geometry information about the objects,
27313 * and if the window was not created yet, it can get a wrong information.
27315 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);
27318 * Add the Zoom Effect to Elm_Transit.
27320 * @note This API is one of the facades. It creates zoom effect context
27321 * and add it's required APIs to elm_transit_effect_add.
27323 * @see elm_transit_effect_add()
27325 * @param transit Transit object.
27326 * @param from_rate Scale rate when effect begins (1 is current rate).
27327 * @param to_rate Scale rate when effect ends.
27328 * @return Zoom effect context data.
27331 * @warning It is highly recommended just create a transit with this effect when
27332 * the window that the objects of the transit belongs has already been created.
27333 * This is because this effect needs the geometry information about the objects,
27334 * and if the window was not created yet, it can get a wrong information.
27336 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
27339 * Add the Flip Effect to Elm_Transit.
27341 * @note This API is one of the facades. It creates flip effect context
27342 * and add it's required APIs to elm_transit_effect_add.
27343 * @note This effect is applied to each pair of objects in the order they are listed
27344 * in the transit list of objects. The first object in the pair will be the
27345 * "front" object and the second will be the "back" object.
27347 * @see elm_transit_effect_add()
27349 * @param transit Transit object.
27350 * @param axis Flipping Axis(X or Y).
27351 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27352 * @return Flip effect context data.
27355 * @warning It is highly recommended just create a transit with this effect when
27356 * the window that the objects of the transit belongs has already been created.
27357 * This is because this effect needs the geometry information about the objects,
27358 * and if the window was not created yet, it can get a wrong information.
27360 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27363 * Add the Resizable Flip Effect to Elm_Transit.
27365 * @note This API is one of the facades. It creates resizable flip effect context
27366 * and add it's required APIs to elm_transit_effect_add.
27367 * @note This effect is applied to each pair of objects in the order they are listed
27368 * in the transit list of objects. The first object in the pair will be the
27369 * "front" object and the second will be the "back" object.
27371 * @see elm_transit_effect_add()
27373 * @param transit Transit object.
27374 * @param axis Flipping Axis(X or Y).
27375 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27376 * @return Resizable flip effect context data.
27379 * @warning It is highly recommended just create a transit with this effect when
27380 * the window that the objects of the transit belongs has already been created.
27381 * This is because this effect needs the geometry information about the objects,
27382 * and if the window was not created yet, it can get a wrong information.
27384 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27387 * Add the Wipe Effect to Elm_Transit.
27389 * @note This API is one of the facades. It creates wipe effect context
27390 * and add it's required APIs to elm_transit_effect_add.
27392 * @see elm_transit_effect_add()
27394 * @param transit Transit object.
27395 * @param type Wipe type. Hide or show.
27396 * @param dir Wipe Direction.
27397 * @return Wipe effect context data.
27400 * @warning It is highly recommended just create a transit with this effect when
27401 * the window that the objects of the transit belongs has already been created.
27402 * This is because this effect needs the geometry information about the objects,
27403 * and if the window was not created yet, it can get a wrong information.
27405 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
27408 * Add the Color Effect to Elm_Transit.
27410 * @note This API is one of the facades. It creates color effect context
27411 * and add it's required APIs to elm_transit_effect_add.
27413 * @see elm_transit_effect_add()
27415 * @param transit Transit object.
27416 * @param from_r RGB R when effect begins.
27417 * @param from_g RGB G when effect begins.
27418 * @param from_b RGB B when effect begins.
27419 * @param from_a RGB A when effect begins.
27420 * @param to_r RGB R when effect ends.
27421 * @param to_g RGB G when effect ends.
27422 * @param to_b RGB B when effect ends.
27423 * @param to_a RGB A when effect ends.
27424 * @return Color effect context data.
27428 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);
27431 * Add the Fade Effect to Elm_Transit.
27433 * @note This API is one of the facades. It creates fade effect context
27434 * and add it's required APIs to elm_transit_effect_add.
27435 * @note This effect is applied to each pair of objects in the order they are listed
27436 * in the transit list of objects. The first object in the pair will be the
27437 * "before" object and the second will be the "after" object.
27439 * @see elm_transit_effect_add()
27441 * @param transit Transit object.
27442 * @return Fade effect context data.
27445 * @warning It is highly recommended just create a transit with this effect when
27446 * the window that the objects of the transit belongs has already been created.
27447 * This is because this effect needs the color information about the objects,
27448 * and if the window was not created yet, it can get a wrong information.
27450 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
27453 * Add the Blend Effect to Elm_Transit.
27455 * @note This API is one of the facades. It creates blend effect context
27456 * and add it's required APIs to elm_transit_effect_add.
27457 * @note This effect is applied to each pair of objects in the order they are listed
27458 * in the transit list of objects. The first object in the pair will be the
27459 * "before" object and the second will be the "after" object.
27461 * @see elm_transit_effect_add()
27463 * @param transit Transit object.
27464 * @return Blend effect context data.
27467 * @warning It is highly recommended just create a transit with this effect when
27468 * the window that the objects of the transit belongs has already been created.
27469 * This is because this effect needs the color information about the objects,
27470 * and if the window was not created yet, it can get a wrong information.
27472 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
27475 * Add the Rotation Effect to Elm_Transit.
27477 * @note This API is one of the facades. It creates rotation effect context
27478 * and add it's required APIs to elm_transit_effect_add.
27480 * @see elm_transit_effect_add()
27482 * @param transit Transit object.
27483 * @param from_degree Degree when effect begins.
27484 * @param to_degree Degree when effect is ends.
27485 * @return Rotation effect context data.
27488 * @warning It is highly recommended just create a transit with this effect when
27489 * the window that the objects of the transit belongs has already been created.
27490 * This is because this effect needs the geometry information about the objects,
27491 * and if the window was not created yet, it can get a wrong information.
27493 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
27496 * Add the ImageAnimation Effect to Elm_Transit.
27498 * @note This API is one of the facades. It creates image animation effect context
27499 * and add it's required APIs to elm_transit_effect_add.
27500 * The @p images parameter is a list images paths. This list and
27501 * its contents will be deleted at the end of the effect by
27502 * elm_transit_effect_image_animation_context_free() function.
27506 * char buf[PATH_MAX];
27507 * Eina_List *images = NULL;
27508 * Elm_Transit *transi = elm_transit_add();
27510 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
27511 * images = eina_list_append(images, eina_stringshare_add(buf));
27513 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
27514 * images = eina_list_append(images, eina_stringshare_add(buf));
27515 * elm_transit_effect_image_animation_add(transi, images);
27519 * @see elm_transit_effect_add()
27521 * @param transit Transit object.
27522 * @param images Eina_List of images file paths. This list and
27523 * its contents will be deleted at the end of the effect by
27524 * elm_transit_effect_image_animation_context_free() function.
27525 * @return Image Animation effect context data.
27529 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
27534 typedef struct _Elm_Store Elm_Store;
27535 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
27536 typedef struct _Elm_Store_Item Elm_Store_Item;
27537 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
27538 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
27539 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
27540 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
27541 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
27542 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
27543 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
27544 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
27546 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
27547 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
27548 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
27549 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
27553 ELM_STORE_ITEM_MAPPING_NONE = 0,
27554 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
27555 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
27556 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
27557 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
27558 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
27559 // can add more here as needed by common apps
27560 ELM_STORE_ITEM_MAPPING_LAST
27561 } Elm_Store_Item_Mapping_Type;
27563 struct _Elm_Store_Item_Mapping_Icon
27565 // FIXME: allow edje file icons
27567 Elm_Icon_Lookup_Order lookup_order;
27568 Eina_Bool standard_name : 1;
27569 Eina_Bool no_scale : 1;
27570 Eina_Bool smooth : 1;
27571 Eina_Bool scale_up : 1;
27572 Eina_Bool scale_down : 1;
27575 struct _Elm_Store_Item_Mapping_Empty
27580 struct _Elm_Store_Item_Mapping_Photo
27585 struct _Elm_Store_Item_Mapping_Custom
27587 Elm_Store_Item_Mapping_Cb func;
27590 struct _Elm_Store_Item_Mapping
27592 Elm_Store_Item_Mapping_Type type;
27597 Elm_Store_Item_Mapping_Empty empty;
27598 Elm_Store_Item_Mapping_Icon icon;
27599 Elm_Store_Item_Mapping_Photo photo;
27600 Elm_Store_Item_Mapping_Custom custom;
27601 // add more types here
27605 struct _Elm_Store_Item_Info
27607 Elm_Genlist_Item_Class *item_class;
27608 const Elm_Store_Item_Mapping *mapping;
27613 struct _Elm_Store_Item_Info_Filesystem
27615 Elm_Store_Item_Info base;
27619 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
27620 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
27622 EAPI void elm_store_free(Elm_Store *st);
27624 EAPI Elm_Store *elm_store_filesystem_new(void);
27625 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
27626 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27627 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27629 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
27631 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
27632 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27633 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27634 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27635 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
27636 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27638 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27639 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
27640 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27641 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
27642 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27643 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27644 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27647 * @defgroup SegmentControl SegmentControl
27648 * @ingroup Elementary
27650 * @image html img/widget/segment_control/preview-00.png
27651 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
27653 * @image html img/segment_control.png
27654 * @image latex img/segment_control.eps width=\textwidth
27656 * Segment control widget is a horizontal control made of multiple segment
27657 * items, each segment item functioning similar to discrete two state button.
27658 * A segment control groups the items together and provides compact
27659 * single button with multiple equal size segments.
27661 * Segment item size is determined by base widget
27662 * size and the number of items added.
27663 * Only one segment item can be at selected state. A segment item can display
27664 * combination of Text and any Evas_Object like Images or other widget.
27666 * Smart callbacks one can listen to:
27667 * - "changed" - When the user clicks on a segment item which is not
27668 * previously selected and get selected. The event_info parameter is the
27669 * segment item pointer.
27671 * Available styles for it:
27674 * Here is an example on its usage:
27675 * @li @ref segment_control_example
27679 * @addtogroup SegmentControl
27683 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
27686 * Add a new segment control widget to the given parent Elementary
27687 * (container) object.
27689 * @param parent The parent object.
27690 * @return a new segment control widget handle or @c NULL, on errors.
27692 * This function inserts a new segment control widget on the canvas.
27694 * @ingroup SegmentControl
27696 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27699 * Append a new item to the segment control object.
27701 * @param obj The segment control object.
27702 * @param icon The icon object to use for the left side of the item. An
27703 * icon can be any Evas object, but usually it is an icon created
27704 * with elm_icon_add().
27705 * @param label The label of the item.
27706 * Note that, NULL is different from empty string "".
27707 * @return The created item or @c NULL upon failure.
27709 * A new item will be created and appended to the segment control, i.e., will
27710 * be set as @b last item.
27712 * If it should be inserted at another position,
27713 * elm_segment_control_item_insert_at() should be used instead.
27715 * Items created with this function can be deleted with function
27716 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27718 * @note @p label set to @c NULL is different from empty string "".
27720 * only has icon, it will be displayed bigger and centered. If it has
27721 * icon and label, even that an empty string, icon will be smaller and
27722 * positioned at left.
27726 * sc = elm_segment_control_add(win);
27727 * ic = elm_icon_add(win);
27728 * elm_icon_file_set(ic, "path/to/image", NULL);
27729 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
27730 * elm_segment_control_item_add(sc, ic, "label");
27731 * evas_object_show(sc);
27734 * @see elm_segment_control_item_insert_at()
27735 * @see elm_segment_control_item_del()
27737 * @ingroup SegmentControl
27739 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
27742 * Insert a new item to the segment control object at specified position.
27744 * @param obj The segment control object.
27745 * @param icon The icon object to use for the left side of the item. An
27746 * icon can be any Evas object, but usually it is an icon created
27747 * with elm_icon_add().
27748 * @param label The label of the item.
27749 * @param index Item position. Value should be between 0 and items count.
27750 * @return The created item or @c NULL upon failure.
27752 * Index values must be between @c 0, when item will be prepended to
27753 * segment control, and items count, that can be get with
27754 * elm_segment_control_item_count_get(), case when item will be appended
27755 * to segment control, just like elm_segment_control_item_add().
27757 * Items created with this function can be deleted with function
27758 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27760 * @note @p label set to @c NULL is different from empty string "".
27762 * only has icon, it will be displayed bigger and centered. If it has
27763 * icon and label, even that an empty string, icon will be smaller and
27764 * positioned at left.
27766 * @see elm_segment_control_item_add()
27767 * @see elm_segment_control_item_count_get()
27768 * @see elm_segment_control_item_del()
27770 * @ingroup SegmentControl
27772 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);
27775 * Remove a segment control item from its parent, deleting it.
27777 * @param it The item to be removed.
27779 * Items can be added with elm_segment_control_item_add() or
27780 * elm_segment_control_item_insert_at().
27782 * @ingroup SegmentControl
27784 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27787 * Remove a segment control item at given index from its parent,
27790 * @param obj The segment control object.
27791 * @param index The position of the segment control item to be deleted.
27793 * Items can be added with elm_segment_control_item_add() or
27794 * elm_segment_control_item_insert_at().
27796 * @ingroup SegmentControl
27798 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27801 * Get the Segment items count from segment control.
27803 * @param obj The segment control object.
27804 * @return Segment items count.
27806 * It will just return the number of items added to segment control @p obj.
27808 * @ingroup SegmentControl
27810 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27813 * Get the item placed at specified index.
27815 * @param obj The segment control object.
27816 * @param index The index of the segment item.
27817 * @return The segment control item or @c NULL on failure.
27819 * Index is the position of an item in segment control widget. Its
27820 * range is from @c 0 to <tt> count - 1 </tt>.
27821 * Count is the number of items, that can be get with
27822 * elm_segment_control_item_count_get().
27824 * @ingroup SegmentControl
27826 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27829 * Get the label of item.
27831 * @param obj The segment control object.
27832 * @param index The index of the segment item.
27833 * @return The label of the item at @p index.
27835 * The return value is a pointer to the label associated to the item when
27836 * it was created, with function elm_segment_control_item_add(), or later
27837 * with function elm_segment_control_item_label_set. If no label
27838 * was passed as argument, it will return @c NULL.
27840 * @see elm_segment_control_item_label_set() for more details.
27841 * @see elm_segment_control_item_add()
27843 * @ingroup SegmentControl
27845 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27848 * Set the label of item.
27850 * @param it The item of segment control.
27851 * @param text The label of item.
27853 * The label to be displayed by the item.
27854 * Label will be at right of the icon (if set).
27856 * If a label was passed as argument on item creation, with function
27857 * elm_control_segment_item_add(), it will be already
27858 * displayed by the item.
27860 * @see elm_segment_control_item_label_get()
27861 * @see elm_segment_control_item_add()
27863 * @ingroup SegmentControl
27865 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
27868 * Get the icon associated to the item.
27870 * @param obj The segment control object.
27871 * @param index The index of the segment item.
27872 * @return The left side icon associated to the item at @p index.
27874 * The return value is a pointer to the icon associated to the item when
27875 * it was created, with function elm_segment_control_item_add(), or later
27876 * with function elm_segment_control_item_icon_set(). If no icon
27877 * was passed as argument, it will return @c NULL.
27879 * @see elm_segment_control_item_add()
27880 * @see elm_segment_control_item_icon_set()
27882 * @ingroup SegmentControl
27884 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27887 * Set the icon associated to the item.
27889 * @param it The segment control item.
27890 * @param icon The icon object to associate with @p it.
27892 * The icon object to use at left side of the item. An
27893 * icon can be any Evas object, but usually it is an icon created
27894 * with elm_icon_add().
27896 * Once the icon object is set, a previously set one will be deleted.
27897 * @warning Setting the same icon for two items will cause the icon to
27898 * dissapear from the first item.
27900 * If an icon was passed as argument on item creation, with function
27901 * elm_segment_control_item_add(), it will be already
27902 * associated to the item.
27904 * @see elm_segment_control_item_add()
27905 * @see elm_segment_control_item_icon_get()
27907 * @ingroup SegmentControl
27909 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
27912 * Get the index of an item.
27914 * @param it The segment control item.
27915 * @return The position of item in segment control widget.
27917 * Index is the position of an item in segment control widget. Its
27918 * range is from @c 0 to <tt> count - 1 </tt>.
27919 * Count is the number of items, that can be get with
27920 * elm_segment_control_item_count_get().
27922 * @ingroup SegmentControl
27924 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27927 * Get the base object of the item.
27929 * @param it The segment control item.
27930 * @return The base object associated with @p it.
27932 * Base object is the @c Evas_Object that represents that item.
27934 * @ingroup SegmentControl
27936 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27939 * Get the selected item.
27941 * @param obj The segment control object.
27942 * @return The selected item or @c NULL if none of segment items is
27945 * The selected item can be unselected with function
27946 * elm_segment_control_item_selected_set().
27948 * The selected item always will be highlighted on segment control.
27950 * @ingroup SegmentControl
27952 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27955 * Set the selected state of an item.
27957 * @param it The segment control item
27958 * @param select The selected state
27960 * This sets the selected state of the given item @p it.
27961 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
27963 * If a new item is selected the previosly selected will be unselected.
27964 * Previoulsy selected item can be get with function
27965 * elm_segment_control_item_selected_get().
27967 * The selected item always will be highlighted on segment control.
27969 * @see elm_segment_control_item_selected_get()
27971 * @ingroup SegmentControl
27973 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
27980 * @defgroup Grid Grid
27982 * The grid is a grid layout widget that lays out a series of children as a
27983 * fixed "grid" of widgets using a given percentage of the grid width and
27984 * height each using the child object.
27986 * The Grid uses a "Virtual resolution" that is stretched to fill the grid
27987 * widgets size itself. The default is 100 x 100, so that means the
27988 * position and sizes of children will effectively be percentages (0 to 100)
27989 * of the width or height of the grid widget
27995 * Add a new grid to the parent
27997 * @param parent The parent object
27998 * @return The new object or NULL if it cannot be created
28002 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
28005 * Set the virtual size of the grid
28007 * @param obj The grid object
28008 * @param w The virtual width of the grid
28009 * @param h The virtual height of the grid
28013 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
28016 * Get the virtual size of the grid
28018 * @param obj The grid object
28019 * @param w Pointer to integer to store the virtual width of the grid
28020 * @param h Pointer to integer to store the virtual height of the grid
28024 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
28027 * Pack child at given position and size
28029 * @param obj The grid object
28030 * @param subobj The child to pack
28031 * @param x The virtual x coord at which to pack it
28032 * @param y The virtual y coord at which to pack it
28033 * @param w The virtual width at which to pack it
28034 * @param h The virtual height at which to pack it
28038 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
28041 * Unpack a child from a grid object
28043 * @param obj The grid object
28044 * @param subobj The child to unpack
28048 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
28051 * Faster way to remove all child objects from a grid object.
28053 * @param obj The grid object
28054 * @param clear If true, it will delete just removed children
28058 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
28061 * Set packing of an existing child at to position and size
28063 * @param subobj The child to set packing of
28064 * @param x The virtual x coord at which to pack it
28065 * @param y The virtual y coord at which to pack it
28066 * @param w The virtual width at which to pack it
28067 * @param h The virtual height at which to pack it
28071 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
28074 * get packing of a child
28076 * @param subobj The child to query
28077 * @param x Pointer to integer to store the virtual x coord
28078 * @param y Pointer to integer to store the virtual y coord
28079 * @param w Pointer to integer to store the virtual width
28080 * @param h Pointer to integer to store the virtual height
28084 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
28090 EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
28091 EINA_DEPRECATED EAPI void elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
28092 EINA_DEPRECATED EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
28093 EAPI void elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
28094 EAPI Eina_Bool elm_factory_maxmin_mode_get(const Evas_Object *obj);
28095 EAPI void elm_factory_maxmin_reset_set(Evas_Object *obj);
28098 * @defgroup Video Video
28100 * @addtogroup Video
28103 * Elementary comes with two object that help design application that need
28104 * to display video. The main one, Elm_Video, display a video by using Emotion.
28105 * It does embedded the video inside an Edje object, so you can do some
28106 * animation depending on the video state change. It does also implement a
28107 * ressource management policy to remove this burden from the application writer.
28109 * The second one, Elm_Player is a video player that need to be linked with and Elm_Video.
28110 * It take care of updating its content according to Emotion event and provide a
28111 * way to theme itself. It also does automatically raise the priority of the
28112 * linked Elm_Video so it will use the video decoder if available. It also does
28113 * activate the remember function on the linked Elm_Video object.
28115 * Signals that you can add callback for are :
28117 * "forward,clicked" - the user clicked the forward button.
28118 * "info,clicked" - the user clicked the info button.
28119 * "next,clicked" - the user clicked the next button.
28120 * "pause,clicked" - the user clicked the pause button.
28121 * "play,clicked" - the user clicked the play button.
28122 * "prev,clicked" - the user clicked the prev button.
28123 * "rewind,clicked" - the user clicked the rewind button.
28124 * "stop,clicked" - the user clicked the stop button.
28126 * To set the video of the player, you can use elm_object_content_set() API.
28131 * @brief Add a new Elm_Player object to the given parent Elementary (container) object.
28133 * @param parent The parent object
28134 * @return a new player widget handle or @c NULL, on errors.
28136 * This function inserts a new player widget on the canvas.
28138 * @see elm_object_content_set()
28142 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
28145 * @brief Link a Elm_Payer with an Elm_Video object.
28147 * @param player the Elm_Player object.
28148 * @param video The Elm_Video object.
28150 * This mean that action on the player widget will affect the
28151 * video object and the state of the video will be reflected in
28152 * the player itself.
28154 * @see elm_player_add()
28155 * @see elm_video_add()
28159 EINA_DEPRECATED EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
28162 * @brief Add a new Elm_Video object to the given parent Elementary (container) object.
28164 * @param parent The parent object
28165 * @return a new video widget handle or @c NULL, on errors.
28167 * This function inserts a new video widget on the canvas.
28169 * @seeelm_video_file_set()
28170 * @see elm_video_uri_set()
28174 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
28177 * @brief Define the file that will be the video source.
28179 * @param video The video object to define the file for.
28180 * @param filename The file to target.
28182 * This function will explicitly define a filename as a source
28183 * for the video of the Elm_Video object.
28185 * @see elm_video_uri_set()
28186 * @see elm_video_add()
28187 * @see elm_player_add()
28191 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
28194 * @brief Define the uri that will be the video source.
28196 * @param video The video object to define the file for.
28197 * @param uri The uri to target.
28199 * This function will define an uri as a source for the video of the
28200 * Elm_Video object. URI could be remote source of video, like http:// or local source
28201 * like for example WebCam who are most of the time v4l2:// (but that depend and
28202 * you should use Emotion API to request and list the available Webcam on your system).
28204 * @see elm_video_file_set()
28205 * @see elm_video_add()
28206 * @see elm_player_add()
28210 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
28213 * @brief Get the underlying Emotion object.
28215 * @param video The video object to proceed the request on.
28216 * @return the underlying Emotion object.
28220 EAPI Evas_Object *elm_video_emotion_get(const Evas_Object *video);
28223 * @brief Start to play the video
28225 * @param video The video object to proceed the request on.
28227 * Start to play the video and cancel all suspend state.
28231 EAPI void elm_video_play(Evas_Object *video);
28234 * @brief Pause the video
28236 * @param video The video object to proceed the request on.
28238 * Pause the video and start a timer to trigger suspend mode.
28242 EAPI void elm_video_pause(Evas_Object *video);
28245 * @brief Stop the video
28247 * @param video The video object to proceed the request on.
28249 * Stop the video and put the emotion in deep sleep mode.
28253 EAPI void elm_video_stop(Evas_Object *video);
28256 * @brief Is the video actually playing.
28258 * @param video The video object to proceed the request on.
28259 * @return EINA_TRUE if the video is actually playing.
28261 * You should consider watching event on the object instead of polling
28262 * the object state.
28266 EAPI Eina_Bool elm_video_is_playing(const Evas_Object *video);
28269 * @brief Is it possible to seek inside the video.
28271 * @param video The video object to proceed the request on.
28272 * @return EINA_TRUE if is possible to seek inside the video.
28276 EAPI Eina_Bool elm_video_is_seekable(const Evas_Object *video);
28279 * @brief Is the audio muted.
28281 * @param video The video object to proceed the request on.
28282 * @return EINA_TRUE if the audio is muted.
28286 EAPI Eina_Bool elm_video_audio_mute_get(const Evas_Object *video);
28289 * @brief Change the mute state of the Elm_Video object.
28291 * @param video The video object to proceed the request on.
28292 * @param mute The new mute state.
28296 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
28299 * @brief Get the audio level of the current video.
28301 * @param video The video object to proceed the request on.
28302 * @return the current audio level.
28306 EAPI double elm_video_audio_level_get(const Evas_Object *video);
28309 * @brief Set the audio level of anElm_Video object.
28311 * @param video The video object to proceed the request on.
28312 * @param volume The new audio volume.
28316 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
28318 EAPI double elm_video_play_position_get(const Evas_Object *video);
28319 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
28320 EAPI double elm_video_play_length_get(const Evas_Object *video);
28321 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
28322 EAPI Eina_Bool elm_video_remember_position_get(const Evas_Object *video);
28323 EAPI const char *elm_video_title_get(const Evas_Object *video);
28329 * @defgroup Naviframe Naviframe
28330 * @ingroup Elementary
28332 * @brief Naviframe is a kind of view manager for the applications.
28334 * Naviframe provides functions to switch different pages with stack
28335 * mechanism. It means if one page(item) needs to be changed to the new one,
28336 * then naviframe would push the new page to it's internal stack. Of course,
28337 * it can be back to the previous page by popping the top page. Naviframe
28338 * provides some transition effect while the pages are switching (same as
28341 * Since each item could keep the different styles, users could keep the
28342 * same look & feel for the pages or different styles for the items in it's
28345 * Signals that you can add callback for are:
28346 * @li "transition,finished" - When the transition is finished in changing
28348 * @li "title,clicked" - User clicked title area
28350 * Default contents parts of the naviframe items that you can use for are:
28351 * @li "elm.swallow.content" - A main content of the page
28352 * @li "elm.swallow.icon" - A icon in the title area
28353 * @li "elm.swallow.prev_btn" - A button to go to the previous page
28354 * @li "elm.swallow.next_btn" - A button to go to the next page
28356 * Default text parts of the naviframe items that you can use for are:
28357 * @li "elm.text.title" - Title label in the title area
28358 * @li "elm.text.subtitle" - Sub-title label in the title area
28360 * @ref tutorial_naviframe gives a good overview of the usage of the API.
28363 #define ELM_NAVIFRAME_ITEM_CONTENT_ICON "elm.swallow.icon"
28364 #define ELM_NAVIFRAME_ITEM_CONTENT_PREV_BTN "elm.swallow.prev_btn"
28365 #define ELM_NAVIFRAME_ITEM_CONTNET_NEXT_BTN "elm.swallow.next_btn"
28366 #define ELM_NAVIFRAME_ITEM_TEXT_SUBTITLE "elm.text.subtitle"
28369 * @addtogroup Naviframe
28374 * @brief Add a new Naviframe object to the parent.
28376 * @param parent Parent object
28377 * @return New object or @c NULL, if it cannot be created
28379 * @ingroup Naviframe
28381 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28383 * @brief Push a new item to the top of the naviframe stack (and show it).
28385 * @param obj The naviframe object
28386 * @param title_label The label in the title area. The name of the title
28387 * label part is "elm.text.title"
28388 * @param prev_btn The button to go to the previous item. If it is NULL,
28389 * then naviframe will create a back button automatically. The name of
28390 * the prev_btn part is "elm.swallow.prev_btn"
28391 * @param next_btn The button to go to the next item. Or It could be just an
28392 * extra function button. The name of the next_btn part is
28393 * "elm.swallow.next_btn"
28394 * @param content The main content object. The name of content part is
28395 * "elm.swallow.content"
28396 * @param item_style The current item style name. @c NULL would be default.
28397 * @return The created item or @c NULL upon failure.
28399 * The item pushed becomes one page of the naviframe, this item will be
28400 * deleted when it is popped.
28402 * @see also elm_naviframe_item_style_set()
28403 * @see also elm_naviframe_item_insert_before()
28404 * @see also elm_naviframe_item_insert_after()
28406 * The following styles are available for this item:
28409 * @ingroup Naviframe
28411 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);
28413 * @brief Insert a new item into the naviframe before item @p before.
28415 * @param before The naviframe item to insert before.
28416 * @param title_label The label in the title area. The name of the title
28417 * label part is "elm.text.title"
28418 * @param prev_btn The button to go to the previous item. If it is NULL,
28419 * then naviframe will create a back button automatically. The name of
28420 * the prev_btn part is "elm.swallow.prev_btn"
28421 * @param next_btn The button to go to the next item. Or It could be just an
28422 * extra function button. The name of the next_btn part is
28423 * "elm.swallow.next_btn"
28424 * @param content The main content object. The name of content part is
28425 * "elm.swallow.content"
28426 * @param item_style The current item style name. @c NULL would be default.
28427 * @return The created item or @c NULL upon failure.
28429 * The item is inserted into the naviframe straight away without any
28430 * transition operations. This item will be deleted when it is popped.
28432 * @see also elm_naviframe_item_style_set()
28433 * @see also elm_naviframe_item_push()
28434 * @see also elm_naviframe_item_insert_after()
28436 * The following styles are available for this item:
28439 * @ingroup Naviframe
28441 EAPI Elm_Object_Item *elm_naviframe_item_insert_before(Elm_Object_Item *before, const char *title_label, Evas_Object *prev_btn, Evas_Object *next_btn, Evas_Object *content, const char *item_style) EINA_ARG_NONNULL(1, 5);
28443 * @brief Insert a new item into the naviframe after item @p after.
28445 * @param after The naviframe item to insert after.
28446 * @param title_label The label in the title area. The name of the title
28447 * label part is "elm.text.title"
28448 * @param prev_btn The button to go to the previous item. If it is NULL,
28449 * then naviframe will create a back button automatically. The name of
28450 * the prev_btn part is "elm.swallow.prev_btn"
28451 * @param next_btn The button to go to the next item. Or It could be just an
28452 * extra function button. The name of the next_btn part is
28453 * "elm.swallow.next_btn"
28454 * @param content The main content object. The name of content part is
28455 * "elm.swallow.content"
28456 * @param item_style The current item style name. @c NULL would be default.
28457 * @return The created item or @c NULL upon failure.
28459 * The item is inserted into the naviframe straight away without any
28460 * transition operations. This item will be deleted when it is popped.
28462 * @see also elm_naviframe_item_style_set()
28463 * @see also elm_naviframe_item_push()
28464 * @see also elm_naviframe_item_insert_before()
28466 * The following styles are available for this item:
28469 * @ingroup Naviframe
28471 EAPI Elm_Object_Item *elm_naviframe_item_insert_after(Elm_Object_Item *after, const char *title_label, Evas_Object *prev_btn, Evas_Object *next_btn, Evas_Object *content, const char *item_style) EINA_ARG_NONNULL(1, 5);
28473 * @brief Pop an item that is on top of the stack
28475 * @param obj The naviframe object
28476 * @return @c NULL or the content object(if the
28477 * elm_naviframe_content_preserve_on_pop_get is true).
28479 * This pops an item that is on the top(visible) of the naviframe, makes it
28480 * disappear, then deletes the item. The item that was underneath it on the
28481 * stack will become visible.
28483 * @see also elm_naviframe_content_preserve_on_pop_get()
28485 * @ingroup Naviframe
28487 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
28489 * @brief Pop the items between the top and the above one on the given item.
28491 * @param it The naviframe item
28493 * @ingroup Naviframe
28495 EAPI void elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28497 * Promote an item already in the naviframe stack to the top of the stack
28499 * @param it The naviframe item
28501 * This will take the indicated item and promote it to the top of the stack
28502 * as if it had been pushed there. The item must already be inside the
28503 * naviframe stack to work.
28506 EAPI void elm_naviframe_item_promote(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28508 * @brief Delete the given item instantly.
28510 * @param it The naviframe item
28512 * This just deletes the given item from the naviframe item list instantly.
28513 * So this would not emit any signals for view transitions but just change
28514 * the current view if the given item is a top one.
28516 * @ingroup Naviframe
28518 EAPI void elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28520 * @brief preserve the content objects when items are popped.
28522 * @param obj The naviframe object
28523 * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
28525 * @see also elm_naviframe_content_preserve_on_pop_get()
28527 * @ingroup Naviframe
28529 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
28531 * @brief Get a value whether preserve mode is enabled or not.
28533 * @param obj The naviframe object
28534 * @return If @c EINA_TRUE, preserve mode is enabled
28536 * @see also elm_naviframe_content_preserve_on_pop_set()
28538 * @ingroup Naviframe
28540 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28542 * @brief Get a top item on the naviframe stack
28544 * @param obj The naviframe object
28545 * @return The top item on the naviframe stack or @c NULL, if the stack is
28548 * @ingroup Naviframe
28550 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28552 * @brief Get a bottom item on the naviframe stack
28554 * @param obj The naviframe object
28555 * @return The bottom item on the naviframe stack or @c NULL, if the stack is
28558 * @ingroup Naviframe
28560 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28562 * @brief Set an item style
28564 * @param obj The naviframe item
28565 * @param item_style The current item style name. @c NULL would be default
28567 * The following styles are available for this item:
28570 * @see also elm_naviframe_item_style_get()
28572 * @ingroup Naviframe
28574 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
28576 * @brief Get an item style
28578 * @param obj The naviframe item
28579 * @return The current item style name
28581 * @see also elm_naviframe_item_style_set()
28583 * @ingroup Naviframe
28585 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28587 * @brief Show/Hide the title area
28589 * @param it The naviframe item
28590 * @param visible If @c EINA_TRUE, title area will be visible, hidden
28593 * When the title area is invisible, then the controls would be hidden so as * to expand the content area to full-size.
28595 * @see also elm_naviframe_item_title_visible_get()
28597 * @ingroup Naviframe
28599 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
28601 * @brief Get a value whether title area is visible or not.
28603 * @param it The naviframe item
28604 * @return If @c EINA_TRUE, title area is visible
28606 * @see also elm_naviframe_item_title_visible_set()
28608 * @ingroup Naviframe
28610 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28613 * @brief Set creating prev button automatically or not
28615 * @param obj The naviframe object
28616 * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
28617 * be created internally when you pass the @c NULL to the prev_btn
28618 * parameter in elm_naviframe_item_push
28620 * @see also elm_naviframe_item_push()
28622 EAPI void elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
28624 * @brief Get a value whether prev button(back button) will be auto pushed or
28627 * @param obj The naviframe object
28628 * @return If @c EINA_TRUE, prev button will be auto pushed.
28630 * @see also elm_naviframe_item_push()
28631 * elm_naviframe_prev_btn_auto_pushed_set()
28633 EAPI Eina_Bool elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28635 * @brief Get a list of all the naviframe items.
28637 * @param obj The naviframe object
28638 * @return An Eina_Inlist* of naviframe items, #Elm_Object_Item,
28639 * or @c NULL on failure.
28641 EAPI Eina_Inlist *elm_naviframe_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);