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.
4637 * @deprecated use elm_object_content_set() instead
4642 EINA_DEPRECATED EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4645 * Get the overlay object used for the background object.
4647 * @param obj The bg object
4648 * @return The content that is being used
4650 * Return the content object which is set for this widget
4652 * @deprecated use elm_object_content_get() instead
4656 EINA_DEPRECATED EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4659 * Get the overlay object used for the background object.
4661 * @param obj The bg object
4662 * @return The content that was being used
4664 * Unparent and return the overlay object which was set for this widget
4666 * @deprecated use elm_object_content_unset() instead
4670 EINA_DEPRECATED EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4673 * Set the size of the pixmap representation of the image.
4675 * This option just makes sense if an image is going to be set in the bg.
4677 * @param obj The bg object
4678 * @param w The new width of the image pixmap representation.
4679 * @param h The new height of the image pixmap representation.
4681 * This function sets a new size for pixmap representation of the given bg
4682 * image. It allows the image to be loaded already in the specified size,
4683 * reducing the memory usage and load time when loading a big image with load
4684 * size set to a smaller size.
4686 * NOTE: this is just a hint, the real size of the pixmap may differ
4687 * depending on the type of image being loaded, being bigger than requested.
4691 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4692 /* smart callbacks called:
4696 * @defgroup Icon Icon
4698 * @image html img/widget/icon/preview-00.png
4699 * @image latex img/widget/icon/preview-00.eps
4701 * An object that provides standard icon images (delete, edit, arrows, etc.)
4702 * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4704 * The icon image requested can be in the elementary theme, or in the
4705 * freedesktop.org paths. It's possible to set the order of preference from
4706 * where the image will be used.
4708 * This API is very similar to @ref Image, but with ready to use images.
4710 * Default images provided by the theme are described below.
4712 * The first list contains icons that were first intended to be used in
4713 * toolbars, but can be used in many other places too:
4729 * Now some icons that were designed to be used in menus (but again, you can
4730 * use them anywhere else):
4735 * @li menu/arrow_down
4736 * @li menu/arrow_left
4737 * @li menu/arrow_right
4746 * And here we have some media player specific icons:
4747 * @li media_player/forward
4748 * @li media_player/info
4749 * @li media_player/next
4750 * @li media_player/pause
4751 * @li media_player/play
4752 * @li media_player/prev
4753 * @li media_player/rewind
4754 * @li media_player/stop
4756 * Signals that you can add callbacks for are:
4758 * "clicked" - This is called when a user has clicked the icon
4760 * An example of usage for this API follows:
4761 * @li @ref tutorial_icon
4769 typedef enum _Elm_Icon_Type
4776 * @enum _Elm_Icon_Lookup_Order
4777 * @typedef Elm_Icon_Lookup_Order
4779 * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4780 * theme, FDO paths, or both?
4784 typedef enum _Elm_Icon_Lookup_Order
4786 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4787 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4788 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
4789 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
4790 } Elm_Icon_Lookup_Order;
4793 * Add a new icon object to the parent.
4795 * @param parent The parent object
4796 * @return The new object or NULL if it cannot be created
4798 * @see elm_icon_file_set()
4802 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4804 * Set the file that will be used as icon.
4806 * @param obj The icon object
4807 * @param file The path to file that will be used as icon image
4808 * @param group The group that the icon belongs to an edje file
4810 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4812 * @note The icon image set by this function can be changed by
4813 * elm_icon_standard_set().
4815 * @see elm_icon_file_get()
4819 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4821 * Set a location in memory to be used as an icon
4823 * @param obj The icon object
4824 * @param img The binary data that will be used as an image
4825 * @param size The size of binary data @p img
4826 * @param format Optional format of @p img to pass to the image loader
4827 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
4829 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4831 * @note The icon image set by this function can be changed by
4832 * elm_icon_standard_set().
4836 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);
4838 * Get the file that will be used as icon.
4840 * @param obj The icon object
4841 * @param file The path to file that will be used as the icon image
4842 * @param group The group that the icon belongs to, in edje file
4844 * @see elm_icon_file_set()
4848 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4849 EAPI void elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4851 * Set the icon by icon standards names.
4853 * @param obj The icon object
4854 * @param name The icon name
4856 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4858 * For example, freedesktop.org defines standard icon names such as "home",
4859 * "network", etc. There can be different icon sets to match those icon
4860 * keys. The @p name given as parameter is one of these "keys", and will be
4861 * used to look in the freedesktop.org paths and elementary theme. One can
4862 * change the lookup order with elm_icon_order_lookup_set().
4864 * If name is not found in any of the expected locations and it is the
4865 * absolute path of an image file, this image will be used.
4867 * @note The icon image set by this function can be changed by
4868 * elm_icon_file_set().
4870 * @see elm_icon_standard_get()
4871 * @see elm_icon_file_set()
4875 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
4877 * Get the icon name set by icon standard names.
4879 * @param obj The icon object
4880 * @return The icon name
4882 * If the icon image was set using elm_icon_file_set() instead of
4883 * elm_icon_standard_set(), then this function will return @c NULL.
4885 * @see elm_icon_standard_set()
4889 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4891 * Set the smooth scaling for an icon object.
4893 * @param obj The icon object
4894 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4895 * otherwise. Default is @c EINA_TRUE.
4897 * Set the scaling algorithm to be used when scaling the icon image. Smooth
4898 * scaling provides a better resulting image, but is slower.
4900 * The smooth scaling should be disabled when making animations that change
4901 * the icon size, since they will be faster. Animations that don't require
4902 * resizing of the icon can keep the smooth scaling enabled (even if the icon
4903 * is already scaled, since the scaled icon image will be cached).
4905 * @see elm_icon_smooth_get()
4909 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4911 * Get whether smooth scaling is enabled for an icon object.
4913 * @param obj The icon object
4914 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4916 * @see elm_icon_smooth_set()
4920 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4922 * Disable scaling of this object.
4924 * @param obj The icon object.
4925 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4926 * otherwise. Default is @c EINA_FALSE.
4928 * This function disables scaling of the icon object through the function
4929 * elm_object_scale_set(). However, this does not affect the object
4930 * size/resize in any way. For that effect, take a look at
4931 * elm_icon_scale_set().
4933 * @see elm_icon_no_scale_get()
4934 * @see elm_icon_scale_set()
4935 * @see elm_object_scale_set()
4939 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
4941 * Get whether scaling is disabled on the object.
4943 * @param obj The icon object
4944 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
4946 * @see elm_icon_no_scale_set()
4950 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4952 * Set if the object is (up/down) resizable.
4954 * @param obj The icon object
4955 * @param scale_up A bool to set if the object is resizable up. Default is
4957 * @param scale_down A bool to set if the object is resizable down. Default
4960 * This function limits the icon object resize ability. If @p scale_up is set to
4961 * @c EINA_FALSE, the object can't have its height or width resized to a value
4962 * higher than the original icon size. Same is valid for @p scale_down.
4964 * @see elm_icon_scale_get()
4968 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
4970 * Get if the object is (up/down) resizable.
4972 * @param obj The icon object
4973 * @param scale_up A bool to set if the object is resizable up
4974 * @param scale_down A bool to set if the object is resizable down
4976 * @see elm_icon_scale_set()
4980 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
4982 * Get the object's image size
4984 * @param obj The icon object
4985 * @param w A pointer to store the width in
4986 * @param h A pointer to store the height in
4990 EAPI void elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4992 * Set if the icon fill the entire object area.
4994 * @param obj The icon object
4995 * @param fill_outside @c EINA_TRUE if the object is filled outside,
4996 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4998 * When the icon object is resized to a different aspect ratio from the
4999 * original icon image, the icon image will still keep its aspect. This flag
5000 * tells how the image should fill the object's area. They are: keep the
5001 * entire icon inside the limits of height and width of the object (@p
5002 * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
5003 * of the object, and the icon will fill the entire object (@p fill_outside
5006 * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
5007 * retain property to false. Thus, the icon image will always keep its
5008 * original aspect ratio.
5010 * @see elm_icon_fill_outside_get()
5011 * @see elm_image_fill_outside_set()
5015 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5017 * Get if the object is filled outside.
5019 * @param obj The icon object
5020 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5022 * @see elm_icon_fill_outside_set()
5026 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5028 * Set the prescale size for the icon.
5030 * @param obj The icon object
5031 * @param size The prescale size. This value is used for both width and
5034 * This function sets a new size for pixmap representation of the given
5035 * icon. It allows the icon to be loaded already in the specified size,
5036 * reducing the memory usage and load time when loading a big icon with load
5037 * size set to a smaller size.
5039 * It's equivalent to the elm_bg_load_size_set() function for bg.
5041 * @note this is just a hint, the real size of the pixmap may differ
5042 * depending on the type of icon being loaded, being bigger than requested.
5044 * @see elm_icon_prescale_get()
5045 * @see elm_bg_load_size_set()
5049 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5051 * Get the prescale size for the icon.
5053 * @param obj The icon object
5054 * @return The prescale size
5056 * @see elm_icon_prescale_set()
5060 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5062 * Gets the image object of the icon. DO NOT MODIFY THIS.
5064 * @param obj The icon object
5065 * @return The internal icon object
5069 EAPI Evas_Object *elm_icon_object_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5071 * Sets the icon lookup order used by elm_icon_standard_set().
5073 * @param obj The icon object
5074 * @param order The icon lookup order (can be one of
5075 * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
5076 * or ELM_ICON_LOOKUP_THEME)
5078 * @see elm_icon_order_lookup_get()
5079 * @see Elm_Icon_Lookup_Order
5083 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
5085 * Gets the icon lookup order.
5087 * @param obj The icon object
5088 * @return The icon lookup order
5090 * @see elm_icon_order_lookup_set()
5091 * @see Elm_Icon_Lookup_Order
5095 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5097 * Enable or disable preloading of the icon
5099 * @param obj The icon object
5100 * @param disable If EINA_TRUE, preloading will be disabled
5103 EAPI void elm_icon_preload_set(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
5105 * Get if the icon supports animation or not.
5107 * @param obj The icon object
5108 * @return @c EINA_TRUE if the icon supports animation,
5109 * @c EINA_FALSE otherwise.
5111 * Return if this elm icon's image can be animated. Currently Evas only
5112 * supports gif animation. If the return value is EINA_FALSE, other
5113 * elm_icon_animated_XXX APIs won't work.
5116 EAPI Eina_Bool elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5118 * Set animation mode of the icon.
5120 * @param obj The icon object
5121 * @param anim @c EINA_TRUE if the object do animation job,
5122 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5124 * Since the default animation mode is set to EINA_FALSE,
5125 * the icon is shown without animation.
5126 * This might be desirable when the application developer wants to show
5127 * a snapshot of the animated icon.
5128 * Set it to EINA_TRUE when the icon needs to be animated.
5131 EAPI void elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
5133 * Get animation mode of the icon.
5135 * @param obj The icon object
5136 * @return The animation mode of the icon object
5137 * @see elm_icon_animated_set
5140 EAPI Eina_Bool elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5142 * Set animation play mode of the icon.
5144 * @param obj The icon object
5145 * @param play @c EINA_TRUE the object play animation images,
5146 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5148 * To play elm icon's animation, set play to EINA_TURE.
5149 * For example, you make gif player using this set/get API and click event.
5151 * 1. Click event occurs
5152 * 2. Check play flag using elm_icon_animaged_play_get
5153 * 3. If elm icon was playing, set play to EINA_FALSE.
5154 * Then animation will be stopped and vice versa
5157 EAPI void elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
5159 * Get animation play mode of the icon.
5161 * @param obj The icon object
5162 * @return The play mode of the icon object
5164 * @see elm_icon_animated_play_get
5167 EAPI Eina_Bool elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5174 * @defgroup Image Image
5176 * @image html img/widget/image/preview-00.png
5177 * @image latex img/widget/image/preview-00.eps
5180 * An object that allows one to load an image file to it. It can be used
5181 * anywhere like any other elementary widget.
5183 * This widget provides most of the functionality provided from @ref Bg or @ref
5184 * Icon, but with a slightly different API (use the one that fits better your
5187 * The features not provided by those two other image widgets are:
5188 * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
5189 * @li change the object orientation with elm_image_orient_set();
5190 * @li and turning the image editable with elm_image_editable_set().
5192 * Signals that you can add callbacks for are:
5194 * @li @c "clicked" - This is called when a user has clicked the image
5196 * An example of usage for this API follows:
5197 * @li @ref tutorial_image
5206 * @enum _Elm_Image_Orient
5207 * @typedef Elm_Image_Orient
5209 * Possible orientation options for elm_image_orient_set().
5211 * @image html elm_image_orient_set.png
5212 * @image latex elm_image_orient_set.eps width=\textwidth
5216 typedef enum _Elm_Image_Orient
5218 ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
5219 ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
5220 ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
5221 ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5222 ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
5223 ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
5224 ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
5225 ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
5229 * Add a new image to the parent.
5231 * @param parent The parent object
5232 * @return The new object or NULL if it cannot be created
5234 * @see elm_image_file_set()
5238 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5240 * Set the file that will be used as image.
5242 * @param obj The image object
5243 * @param file The path to file that will be used as image
5244 * @param group The group that the image belongs in edje file (if it's an
5247 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5249 * @see elm_image_file_get()
5253 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5255 * Get the file that will be used as image.
5257 * @param obj The image object
5258 * @param file The path to file
5259 * @param group The group that the image belongs in edje file
5261 * @see elm_image_file_set()
5265 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5267 * Set the smooth effect for an image.
5269 * @param obj The image object
5270 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5271 * otherwise. Default is @c EINA_TRUE.
5273 * Set the scaling algorithm to be used when scaling the image. Smooth
5274 * scaling provides a better resulting image, but is slower.
5276 * The smooth scaling should be disabled when making animations that change
5277 * the image size, since it will be faster. Animations that don't require
5278 * resizing of the image can keep the smooth scaling enabled (even if the
5279 * image is already scaled, since the scaled image will be cached).
5281 * @see elm_image_smooth_get()
5285 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5287 * Get the smooth effect for an image.
5289 * @param obj The image object
5290 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5292 * @see elm_image_smooth_get()
5296 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5299 * Gets the current size of the image.
5301 * @param obj The image object.
5302 * @param w Pointer to store width, or NULL.
5303 * @param h Pointer to store height, or NULL.
5305 * This is the real size of the image, not the size of the object.
5307 * On error, neither w or h will be written.
5311 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5313 * Disable scaling of this object.
5315 * @param obj The image object.
5316 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5317 * otherwise. Default is @c EINA_FALSE.
5319 * This function disables scaling of the elm_image widget through the
5320 * function elm_object_scale_set(). However, this does not affect the widget
5321 * size/resize in any way. For that effect, take a look at
5322 * elm_image_scale_set().
5324 * @see elm_image_no_scale_get()
5325 * @see elm_image_scale_set()
5326 * @see elm_object_scale_set()
5330 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5332 * Get whether scaling is disabled on the object.
5334 * @param obj The image object
5335 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5337 * @see elm_image_no_scale_set()
5341 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5343 * Set if the object is (up/down) resizable.
5345 * @param obj The image object
5346 * @param scale_up A bool to set if the object is resizable up. Default is
5348 * @param scale_down A bool to set if the object is resizable down. Default
5351 * This function limits the image resize ability. If @p scale_up is set to
5352 * @c EINA_FALSE, the object can't have its height or width resized to a value
5353 * higher than the original image size. Same is valid for @p scale_down.
5355 * @see elm_image_scale_get()
5359 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5361 * Get if the object is (up/down) resizable.
5363 * @param obj The image object
5364 * @param scale_up A bool to set if the object is resizable up
5365 * @param scale_down A bool to set if the object is resizable down
5367 * @see elm_image_scale_set()
5371 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5373 * Set if the image fills the entire object area, when keeping the aspect ratio.
5375 * @param obj The image object
5376 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5377 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5379 * When the image should keep its aspect ratio even if resized to another
5380 * aspect ratio, there are two possibilities to resize it: keep the entire
5381 * image inside the limits of height and width of the object (@p fill_outside
5382 * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5383 * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5385 * @note This option will have no effect if
5386 * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5388 * @see elm_image_fill_outside_get()
5389 * @see elm_image_aspect_ratio_retained_set()
5393 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5395 * Get if the object is filled outside
5397 * @param obj The image object
5398 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5400 * @see elm_image_fill_outside_set()
5404 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5406 * Set the prescale size for the image
5408 * @param obj The image object
5409 * @param size The prescale size. This value is used for both width and
5412 * This function sets a new size for pixmap representation of the given
5413 * image. It allows the image to be loaded already in the specified size,
5414 * reducing the memory usage and load time when loading a big image with load
5415 * size set to a smaller size.
5417 * It's equivalent to the elm_bg_load_size_set() function for bg.
5419 * @note this is just a hint, the real size of the pixmap may differ
5420 * depending on the type of image being loaded, being bigger than requested.
5422 * @see elm_image_prescale_get()
5423 * @see elm_bg_load_size_set()
5427 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5429 * Get the prescale size for the image
5431 * @param obj The image object
5432 * @return The prescale size
5434 * @see elm_image_prescale_set()
5438 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5440 * Set the image orientation.
5442 * @param obj The image object
5443 * @param orient The image orientation @ref Elm_Image_Orient
5444 * Default is #ELM_IMAGE_ORIENT_NONE.
5446 * This function allows to rotate or flip the given image.
5448 * @see elm_image_orient_get()
5449 * @see @ref Elm_Image_Orient
5453 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5455 * Get the image orientation.
5457 * @param obj The image object
5458 * @return The image orientation @ref Elm_Image_Orient
5460 * @see elm_image_orient_set()
5461 * @see @ref Elm_Image_Orient
5465 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5467 * Make the image 'editable'.
5469 * @param obj Image object.
5470 * @param set Turn on or off editability. Default is @c EINA_FALSE.
5472 * This means the image is a valid drag target for drag and drop, and can be
5473 * cut or pasted too.
5477 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5479 * Check if the image 'editable'.
5481 * @param obj Image object.
5482 * @return Editability.
5484 * A return value of EINA_TRUE means the image is a valid drag target
5485 * for drag and drop, and can be cut or pasted too.
5489 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5491 * Get the basic Evas_Image object from this object (widget).
5493 * @param obj The image object to get the inlined image from
5494 * @return The inlined image object, or NULL if none exists
5496 * This function allows one to get the underlying @c Evas_Object of type
5497 * Image from this elementary widget. It can be useful to do things like get
5498 * the pixel data, save the image to a file, etc.
5500 * @note Be careful to not manipulate it, as it is under control of
5505 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5507 * Set whether the original aspect ratio of the image should be kept on resize.
5509 * @param obj The image object.
5510 * @param retained @c EINA_TRUE if the image should retain the aspect,
5511 * @c EINA_FALSE otherwise.
5513 * The original aspect ratio (width / height) of the image is usually
5514 * distorted to match the object's size. Enabling this option will retain
5515 * this original aspect, and the way that the image is fit into the object's
5516 * area depends on the option set by elm_image_fill_outside_set().
5518 * @see elm_image_aspect_ratio_retained_get()
5519 * @see elm_image_fill_outside_set()
5523 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5525 * Get if the object retains the original aspect ratio.
5527 * @param obj The image object.
5528 * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5533 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5540 typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5542 typedef enum _Elm_GLView_Mode
5544 ELM_GLVIEW_ALPHA = 1,
5545 ELM_GLVIEW_DEPTH = 2,
5546 ELM_GLVIEW_STENCIL = 4
5550 * Defines a policy for the glview resizing.
5552 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5554 typedef enum _Elm_GLView_Resize_Policy
5556 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
5557 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
5558 } Elm_GLView_Resize_Policy;
5560 typedef enum _Elm_GLView_Render_Policy
5562 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
5563 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
5564 } Elm_GLView_Render_Policy;
5569 * A simple GLView widget that allows GL rendering.
5571 * Signals that you can add callbacks for are:
5577 * Add a new glview to the parent
5579 * @param parent The parent object
5580 * @return The new object or NULL if it cannot be created
5584 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5587 * Sets the size of the glview
5589 * @param obj The glview object
5590 * @param width width of the glview object
5591 * @param height height of the glview object
5595 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5598 * Gets the size of the glview.
5600 * @param obj The glview object
5601 * @param width width of the glview object
5602 * @param height height of the glview object
5604 * Note that this function returns the actual image size of the
5605 * glview. This means that when the scale policy is set to
5606 * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5611 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5614 * Gets the gl api struct for gl rendering
5616 * @param obj The glview object
5617 * @return The api object or NULL if it cannot be created
5621 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5624 * Set the mode of the GLView. Supports Three simple modes.
5626 * @param obj The glview object
5627 * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5628 * @return True if set properly.
5632 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5635 * Set the resize policy for the glview object.
5637 * @param obj The glview object.
5638 * @param policy The scaling policy.
5640 * By default, the resize policy is set to
5641 * ELM_GLVIEW_RESIZE_POLICY_RECREATE. When resize is called it
5642 * destroys the previous surface and recreates the newly specified
5643 * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5644 * however, glview only scales the image object and not the underlying
5649 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5652 * Set the render policy for the glview object.
5654 * @param obj The glview object.
5655 * @param policy The render policy.
5657 * By default, the render policy is set to
5658 * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND. This policy is set such
5659 * that during the render loop, glview is only redrawn if it needs
5660 * to be redrawn. (i.e. When it is visible) If the policy is set to
5661 * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5662 * whether it is visible/need redrawing or not.
5666 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5669 * Set the init function that runs once in the main loop.
5671 * @param obj The glview object.
5672 * @param func The init function to be registered.
5674 * The registered init function gets called once during the render loop.
5678 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5681 * Set the render function that runs in the main loop.
5683 * @param obj The glview object.
5684 * @param func The delete function to be registered.
5686 * The registered del function gets called when GLView object is deleted.
5690 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5693 * Set the resize function that gets called when resize happens.
5695 * @param obj The glview object.
5696 * @param func The resize function to be registered.
5700 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5703 * Set the render function that runs in the main loop.
5705 * @param obj The glview object.
5706 * @param func The render function to be registered.
5710 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5713 * Notifies that there has been changes in the GLView.
5715 * @param obj The glview object.
5719 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5729 * @image html img/widget/box/preview-00.png
5730 * @image latex img/widget/box/preview-00.eps width=\textwidth
5732 * @image html img/box.png
5733 * @image latex img/box.eps width=\textwidth
5735 * A box arranges objects in a linear fashion, governed by a layout function
5736 * that defines the details of this arrangement.
5738 * By default, the box will use an internal function to set the layout to
5739 * a single row, either vertical or horizontal. This layout is affected
5740 * by a number of parameters, such as the homogeneous flag set by
5741 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5742 * elm_box_align_set() and the hints set to each object in the box.
5744 * For this default layout, it's possible to change the orientation with
5745 * elm_box_horizontal_set(). The box will start in the vertical orientation,
5746 * placing its elements ordered from top to bottom. When horizontal is set,
5747 * the order will go from left to right. If the box is set to be
5748 * homogeneous, every object in it will be assigned the same space, that
5749 * of the largest object. Padding can be used to set some spacing between
5750 * the cell given to each object. The alignment of the box, set with
5751 * elm_box_align_set(), determines how the bounding box of all the elements
5752 * will be placed within the space given to the box widget itself.
5754 * The size hints of each object also affect how they are placed and sized
5755 * within the box. evas_object_size_hint_min_set() will give the minimum
5756 * size the object can have, and the box will use it as the basis for all
5757 * latter calculations. Elementary widgets set their own minimum size as
5758 * needed, so there's rarely any need to use it manually.
5760 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5761 * used to tell whether the object will be allocated the minimum size it
5762 * needs or if the space given to it should be expanded. It's important
5763 * to realize that expanding the size given to the object is not the same
5764 * thing as resizing the object. It could very well end being a small
5765 * widget floating in a much larger empty space. If not set, the weight
5766 * for objects will normally be 0.0 for both axis, meaning the widget will
5767 * not be expanded. To take as much space possible, set the weight to
5768 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5770 * Besides how much space each object is allocated, it's possible to control
5771 * how the widget will be placed within that space using
5772 * evas_object_size_hint_align_set(). By default, this value will be 0.5
5773 * for both axis, meaning the object will be centered, but any value from
5774 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5775 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5776 * is -1.0, means the object will be resized to fill the entire space it
5779 * In addition, customized functions to define the layout can be set, which
5780 * allow the application developer to organize the objects within the box
5781 * in any number of ways.
5783 * The special elm_box_layout_transition() function can be used
5784 * to switch from one layout to another, animating the motion of the
5785 * children of the box.
5787 * @note Objects should not be added to box objects using _add() calls.
5789 * Some examples on how to use boxes follow:
5790 * @li @ref box_example_01
5791 * @li @ref box_example_02
5796 * @typedef Elm_Box_Transition
5798 * Opaque handler containing the parameters to perform an animated
5799 * transition of the layout the box uses.
5801 * @see elm_box_transition_new()
5802 * @see elm_box_layout_set()
5803 * @see elm_box_layout_transition()
5805 typedef struct _Elm_Box_Transition Elm_Box_Transition;
5808 * Add a new box to the parent
5810 * By default, the box will be in vertical mode and non-homogeneous.
5812 * @param parent The parent object
5813 * @return The new object or NULL if it cannot be created
5815 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5817 * Set the horizontal orientation
5819 * By default, box object arranges their contents vertically from top to
5821 * By calling this function with @p horizontal as EINA_TRUE, the box will
5822 * become horizontal, arranging contents from left to right.
5824 * @note This flag is ignored if a custom layout function is set.
5826 * @param obj The box object
5827 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5828 * EINA_FALSE = vertical)
5830 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5832 * Get the horizontal orientation
5834 * @param obj The box object
5835 * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
5837 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5839 * Set the box to arrange its children homogeneously
5841 * If enabled, homogeneous layout makes all items the same size, according
5842 * to the size of the largest of its children.
5844 * @note This flag is ignored if a custom layout function is set.
5846 * @param obj The box object
5847 * @param homogeneous The homogeneous flag
5849 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5851 * Get whether the box is using homogeneous mode or not
5853 * @param obj The box object
5854 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5856 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5857 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5858 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5860 * Add an object to the beginning of the pack list
5862 * Pack @p subobj into the box @p obj, placing it first in the list of
5863 * children objects. The actual position the object will get on screen
5864 * depends on the layout used. If no custom layout is set, it will be at
5865 * the top or left, depending if the box is vertical or horizontal,
5868 * @param obj The box object
5869 * @param subobj The object to add to the box
5871 * @see elm_box_pack_end()
5872 * @see elm_box_pack_before()
5873 * @see elm_box_pack_after()
5874 * @see elm_box_unpack()
5875 * @see elm_box_unpack_all()
5876 * @see elm_box_clear()
5878 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5880 * Add an object at the end of the pack list
5882 * Pack @p subobj into the box @p obj, placing it last in the list of
5883 * children objects. The actual position the object will get on screen
5884 * depends on the layout used. If no custom layout is set, it will be at
5885 * the bottom or right, depending if the box is vertical or horizontal,
5888 * @param obj The box object
5889 * @param subobj The object to add to the box
5891 * @see elm_box_pack_start()
5892 * @see elm_box_pack_before()
5893 * @see elm_box_pack_after()
5894 * @see elm_box_unpack()
5895 * @see elm_box_unpack_all()
5896 * @see elm_box_clear()
5898 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5900 * Adds an object to the box before the indicated object
5902 * This will add the @p subobj to the box indicated before the object
5903 * indicated with @p before. If @p before is not already in the box, results
5904 * are undefined. Before means either to the left of the indicated object or
5905 * above it depending on orientation.
5907 * @param obj The box object
5908 * @param subobj The object to add to the box
5909 * @param before The object before which to add it
5911 * @see elm_box_pack_start()
5912 * @see elm_box_pack_end()
5913 * @see elm_box_pack_after()
5914 * @see elm_box_unpack()
5915 * @see elm_box_unpack_all()
5916 * @see elm_box_clear()
5918 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
5920 * Adds an object to the box after the indicated object
5922 * This will add the @p subobj to the box indicated after the object
5923 * indicated with @p after. If @p after is not already in the box, results
5924 * are undefined. After means either to the right of the indicated object or
5925 * below it depending on orientation.
5927 * @param obj The box object
5928 * @param subobj The object to add to the box
5929 * @param after The object after which to add it
5931 * @see elm_box_pack_start()
5932 * @see elm_box_pack_end()
5933 * @see elm_box_pack_before()
5934 * @see elm_box_unpack()
5935 * @see elm_box_unpack_all()
5936 * @see elm_box_clear()
5938 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
5940 * Clear the box of all children
5942 * Remove all the elements contained by the box, deleting the respective
5945 * @param obj The box object
5947 * @see elm_box_unpack()
5948 * @see elm_box_unpack_all()
5950 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5954 * Remove the object given by @p subobj from the box @p obj without
5957 * @param obj The box object
5959 * @see elm_box_unpack_all()
5960 * @see elm_box_clear()
5962 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5964 * Remove all items from the box, without deleting them
5966 * Clear the box from all children, but don't delete the respective objects.
5967 * If no other references of the box children exist, the objects will never
5968 * be deleted, and thus the application will leak the memory. Make sure
5969 * when using this function that you hold a reference to all the objects
5970 * in the box @p obj.
5972 * @param obj The box object
5974 * @see elm_box_clear()
5975 * @see elm_box_unpack()
5977 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5979 * Retrieve a list of the objects packed into the box
5981 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
5982 * The order of the list corresponds to the packing order the box uses.
5984 * You must free this list with eina_list_free() once you are done with it.
5986 * @param obj The box object
5988 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5990 * Set the space (padding) between the box's elements.
5992 * Extra space in pixels that will be added between a box child and its
5993 * neighbors after its containing cell has been calculated. This padding
5994 * is set for all elements in the box, besides any possible padding that
5995 * individual elements may have through their size hints.
5997 * @param obj The box object
5998 * @param horizontal The horizontal space between elements
5999 * @param vertical The vertical space between elements
6001 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
6003 * Get the space (padding) between the box's elements.
6005 * @param obj The box object
6006 * @param horizontal The horizontal space between elements
6007 * @param vertical The vertical space between elements
6009 * @see elm_box_padding_set()
6011 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
6013 * Set the alignment of the whole bouding box of contents.
6015 * Sets how the bounding box containing all the elements of the box, after
6016 * their sizes and position has been calculated, will be aligned within
6017 * the space given for the whole box widget.
6019 * @param obj The box object
6020 * @param horizontal The horizontal alignment of elements
6021 * @param vertical The vertical alignment of elements
6023 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
6025 * Get the alignment of the whole bouding box of contents.
6027 * @param obj The box object
6028 * @param horizontal The horizontal alignment of elements
6029 * @param vertical The vertical alignment of elements
6031 * @see elm_box_align_set()
6033 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
6036 * Force the box to recalculate its children packing.
6038 * If any children was added or removed, box will not calculate the
6039 * values immediately rather leaving it to the next main loop
6040 * iteration. While this is great as it would save lots of
6041 * recalculation, whenever you need to get the position of a just
6042 * added item you must force recalculate before doing so.
6044 * @param obj The box object.
6046 EAPI void elm_box_recalculate(Evas_Object *obj);
6049 * Set the layout defining function to be used by the box
6051 * Whenever anything changes that requires the box in @p obj to recalculate
6052 * the size and position of its elements, the function @p cb will be called
6053 * to determine what the layout of the children will be.
6055 * Once a custom function is set, everything about the children layout
6056 * is defined by it. The flags set by elm_box_horizontal_set() and
6057 * elm_box_homogeneous_set() no longer have any meaning, and the values
6058 * given by elm_box_padding_set() and elm_box_align_set() are up to this
6059 * layout function to decide if they are used and how. These last two
6060 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
6061 * passed to @p cb. The @c Evas_Object the function receives is not the
6062 * Elementary widget, but the internal Evas Box it uses, so none of the
6063 * functions described here can be used on it.
6065 * Any of the layout functions in @c Evas can be used here, as well as the
6066 * special elm_box_layout_transition().
6068 * The final @p data argument received by @p cb is the same @p data passed
6069 * here, and the @p free_data function will be called to free it
6070 * whenever the box is destroyed or another layout function is set.
6072 * Setting @p cb to NULL will revert back to the default layout function.
6074 * @param obj The box object
6075 * @param cb The callback function used for layout
6076 * @param data Data that will be passed to layout function
6077 * @param free_data Function called to free @p data
6079 * @see elm_box_layout_transition()
6081 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);
6083 * Special layout function that animates the transition from one layout to another
6085 * Normally, when switching the layout function for a box, this will be
6086 * reflected immediately on screen on the next render, but it's also
6087 * possible to do this through an animated transition.
6089 * This is done by creating an ::Elm_Box_Transition and setting the box
6090 * layout to this function.
6094 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
6095 * evas_object_box_layout_vertical, // start
6096 * NULL, // data for initial layout
6097 * NULL, // free function for initial data
6098 * evas_object_box_layout_horizontal, // end
6099 * NULL, // data for final layout
6100 * NULL, // free function for final data
6101 * anim_end, // will be called when animation ends
6102 * NULL); // data for anim_end function\
6103 * elm_box_layout_set(box, elm_box_layout_transition, t,
6104 * elm_box_transition_free);
6107 * @note This function can only be used with elm_box_layout_set(). Calling
6108 * it directly will not have the expected results.
6110 * @see elm_box_transition_new
6111 * @see elm_box_transition_free
6112 * @see elm_box_layout_set
6114 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
6116 * Create a new ::Elm_Box_Transition to animate the switch of layouts
6118 * If you want to animate the change from one layout to another, you need
6119 * to set the layout function of the box to elm_box_layout_transition(),
6120 * passing as user data to it an instance of ::Elm_Box_Transition with the
6121 * necessary information to perform this animation. The free function to
6122 * set for the layout is elm_box_transition_free().
6124 * The parameters to create an ::Elm_Box_Transition sum up to how long
6125 * will it be, in seconds, a layout function to describe the initial point,
6126 * another for the final position of the children and one function to be
6127 * called when the whole animation ends. This last function is useful to
6128 * set the definitive layout for the box, usually the same as the end
6129 * layout for the animation, but could be used to start another transition.
6131 * @param start_layout The layout function that will be used to start the animation
6132 * @param start_layout_data The data to be passed the @p start_layout function
6133 * @param start_layout_free_data Function to free @p start_layout_data
6134 * @param end_layout The layout function that will be used to end the animation
6135 * @param end_layout_free_data The data to be passed the @p end_layout function
6136 * @param end_layout_free_data Function to free @p end_layout_data
6137 * @param transition_end_cb Callback function called when animation ends
6138 * @param transition_end_data Data to be passed to @p transition_end_cb
6139 * @return An instance of ::Elm_Box_Transition
6141 * @see elm_box_transition_new
6142 * @see elm_box_layout_transition
6144 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);
6146 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
6148 * This function is mostly useful as the @c free_data parameter in
6149 * elm_box_layout_set() when elm_box_layout_transition().
6151 * @param data The Elm_Box_Transition instance to be freed.
6153 * @see elm_box_transition_new
6154 * @see elm_box_layout_transition
6156 EAPI void elm_box_transition_free(void *data);
6163 * @defgroup Button Button
6165 * @image html img/widget/button/preview-00.png
6166 * @image latex img/widget/button/preview-00.eps
6167 * @image html img/widget/button/preview-01.png
6168 * @image latex img/widget/button/preview-01.eps
6169 * @image html img/widget/button/preview-02.png
6170 * @image latex img/widget/button/preview-02.eps
6172 * This is a push-button. Press it and run some function. It can contain
6173 * a simple label and icon object and it also has an autorepeat feature.
6175 * This widgets emits the following signals:
6176 * @li "clicked": the user clicked the button (press/release).
6177 * @li "repeated": the user pressed the button without releasing it.
6178 * @li "pressed": button was pressed.
6179 * @li "unpressed": button was released after being pressed.
6180 * In all three cases, the @c event parameter of the callback will be
6183 * Also, defined in the default theme, the button has the following styles
6185 * @li default: a normal button.
6186 * @li anchor: Like default, but the button fades away when the mouse is not
6187 * over it, leaving only the text or icon.
6188 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
6189 * continuous look across its options.
6190 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
6192 * Default contents parts of the button widget that you can use for are:
6193 * @li "elm.swallow.content" - A icon of the button
6195 * Default text parts of the button widget that you can use for are:
6196 * @li "elm.text" - Label of the button
6198 * Follow through a complete example @ref button_example_01 "here".
6202 * Add a new button to the parent's canvas
6204 * @param parent The parent object
6205 * @return The new object or NULL if it cannot be created
6207 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6209 * Set the label used in the button
6211 * The passed @p label can be NULL to clean any existing text in it and
6212 * leave the button as an icon only object.
6214 * @param obj The button object
6215 * @param label The text will be written on the button
6216 * @deprecated use elm_object_text_set() instead.
6218 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6220 * Get the label set for the button
6222 * The string returned is an internal pointer and should not be freed or
6223 * altered. It will also become invalid when the button is destroyed.
6224 * The string returned, if not NULL, is a stringshare, so if you need to
6225 * keep it around even after the button is destroyed, you can use
6226 * eina_stringshare_ref().
6228 * @param obj The button object
6229 * @return The text set to the label, or NULL if nothing is set
6230 * @deprecated use elm_object_text_set() instead.
6232 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6234 * Set the icon used for the button
6236 * Setting a new icon will delete any other that was previously set, making
6237 * any reference to them invalid. If you need to maintain the previous
6238 * object alive, unset it first with elm_button_icon_unset().
6240 * @param obj The button object
6241 * @param icon The icon object for the button
6242 * @deprecated use elm_object_content_set() instead.
6244 EINA_DEPRECATED EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6246 * Get the icon used for the button
6248 * Return the icon object which is set for this widget. If the button is
6249 * destroyed or another icon is set, the returned object will be deleted
6250 * and any reference to it will be invalid.
6252 * @param obj The button object
6253 * @return The icon object that is being used
6255 * @deprecated use elm_button_icon_unset() instead
6257 EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6259 * Remove the icon set without deleting it and return the object
6261 * This function drops the reference the button holds of the icon object
6262 * and returns this last object. It is used in case you want to remove any
6263 * icon, or set another one, without deleting the actual object. The button
6264 * will be left without an icon set.
6266 * @param obj The button object
6267 * @return The icon object that was being used
6268 * @deprecated use elm_object_content_unset() instead.
6270 EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6272 * Turn on/off the autorepeat event generated when the button is kept pressed
6274 * When off, no autorepeat is performed and buttons emit a normal @c clicked
6275 * signal when they are clicked.
6277 * When on, keeping a button pressed will continuously emit a @c repeated
6278 * signal until the button is released. The time it takes until it starts
6279 * emitting the signal is given by
6280 * elm_button_autorepeat_initial_timeout_set(), and the time between each
6281 * new emission by elm_button_autorepeat_gap_timeout_set().
6283 * @param obj The button object
6284 * @param on A bool to turn on/off the event
6286 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6288 * Get whether the autorepeat feature is enabled
6290 * @param obj The button object
6291 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6293 * @see elm_button_autorepeat_set()
6295 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6297 * Set the initial timeout before the autorepeat event is generated
6299 * Sets the timeout, in seconds, since the button is pressed until the
6300 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6301 * won't be any delay and the even will be fired the moment the button is
6304 * @param obj The button object
6305 * @param t Timeout in seconds
6307 * @see elm_button_autorepeat_set()
6308 * @see elm_button_autorepeat_gap_timeout_set()
6310 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6312 * Get the initial timeout before the autorepeat event is generated
6314 * @param obj The button object
6315 * @return Timeout in seconds
6317 * @see elm_button_autorepeat_initial_timeout_set()
6319 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6321 * Set the interval between each generated autorepeat event
6323 * After the first @c repeated event is fired, all subsequent ones will
6324 * follow after a delay of @p t seconds for each.
6326 * @param obj The button object
6327 * @param t Interval in seconds
6329 * @see elm_button_autorepeat_initial_timeout_set()
6331 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6333 * Get the interval between each generated autorepeat event
6335 * @param obj The button object
6336 * @return Interval in seconds
6338 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6344 * @defgroup File_Selector_Button File Selector Button
6346 * @image html img/widget/fileselector_button/preview-00.png
6347 * @image latex img/widget/fileselector_button/preview-00.eps
6348 * @image html img/widget/fileselector_button/preview-01.png
6349 * @image latex img/widget/fileselector_button/preview-01.eps
6350 * @image html img/widget/fileselector_button/preview-02.png
6351 * @image latex img/widget/fileselector_button/preview-02.eps
6353 * This is a button that, when clicked, creates an Elementary
6354 * window (or inner window) <b> with a @ref Fileselector "file
6355 * selector widget" within</b>. When a file is chosen, the (inner)
6356 * window is closed and the button emits a signal having the
6357 * selected file as it's @c event_info.
6359 * This widget encapsulates operations on its internal file
6360 * selector on its own API. There is less control over its file
6361 * selector than that one would have instatiating one directly.
6363 * The following styles are available for this button:
6366 * @li @c "hoversel_vertical"
6367 * @li @c "hoversel_vertical_entry"
6369 * Smart callbacks one can register to:
6370 * - @c "file,chosen" - the user has selected a path, whose string
6371 * pointer comes as the @c event_info data (a stringshared
6374 * Here is an example on its usage:
6375 * @li @ref fileselector_button_example
6377 * @see @ref File_Selector_Entry for a similar widget.
6382 * Add a new file selector button widget to the given parent
6383 * Elementary (container) object
6385 * @param parent The parent object
6386 * @return a new file selector button widget handle or @c NULL, on
6389 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6392 * Set the label for a given file selector button widget
6394 * @param obj The file selector button widget
6395 * @param label The text label to be displayed on @p obj
6397 * @deprecated use elm_object_text_set() instead.
6399 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6402 * Get the label set for a given file selector button widget
6404 * @param obj The file selector button widget
6405 * @return The button label
6407 * @deprecated use elm_object_text_set() instead.
6409 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6412 * Set the icon on a given file selector button widget
6414 * @param obj The file selector button widget
6415 * @param icon The icon object for the button
6417 * Once the icon object is set, a previously set one will be
6418 * deleted. If you want to keep the latter, use the
6419 * elm_fileselector_button_icon_unset() function.
6421 * @see elm_fileselector_button_icon_get()
6423 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6426 * Get the icon set for a given file selector button widget
6428 * @param obj The file selector button widget
6429 * @return The icon object currently set on @p obj or @c NULL, if
6432 * @see elm_fileselector_button_icon_set()
6434 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6437 * Unset the icon used in a given file selector button widget
6439 * @param obj The file selector button widget
6440 * @return The icon object that was being used on @p obj or @c
6443 * Unparent and return the icon object which was set for this
6446 * @see elm_fileselector_button_icon_set()
6448 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6451 * Set the title for a given file selector button widget's window
6453 * @param obj The file selector button widget
6454 * @param title The title string
6456 * This will change the window's title, when the file selector pops
6457 * out after a click on the button. Those windows have the default
6458 * (unlocalized) value of @c "Select a file" as titles.
6460 * @note It will only take any effect if the file selector
6461 * button widget is @b not under "inwin mode".
6463 * @see elm_fileselector_button_window_title_get()
6465 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6468 * Get the title set for a given file selector button widget's
6471 * @param obj The file selector button widget
6472 * @return Title of the file selector button's window
6474 * @see elm_fileselector_button_window_title_get() for more details
6476 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6479 * Set the size of a given file selector button widget's window,
6480 * holding the file selector itself.
6482 * @param obj The file selector button widget
6483 * @param width The window's width
6484 * @param height The window's height
6486 * @note it will only take any effect if the file selector button
6487 * widget is @b not under "inwin mode". The default size for the
6488 * window (when applicable) is 400x400 pixels.
6490 * @see elm_fileselector_button_window_size_get()
6492 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6495 * Get the size of a given file selector button widget's window,
6496 * holding the file selector itself.
6498 * @param obj The file selector button widget
6499 * @param width Pointer into which to store the width value
6500 * @param height Pointer into which to store the height value
6502 * @note Use @c NULL pointers on the size values you're not
6503 * interested in: they'll be ignored by the function.
6505 * @see elm_fileselector_button_window_size_set(), for more details
6507 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6510 * Set the initial file system path for a given file selector
6513 * @param obj The file selector button widget
6514 * @param path The path string
6516 * It must be a <b>directory</b> path, which will have the contents
6517 * displayed initially in the file selector's view, when invoked
6518 * from @p obj. The default initial path is the @c "HOME"
6519 * environment variable's value.
6521 * @see elm_fileselector_button_path_get()
6523 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6526 * Get the initial file system path set for a given file selector
6529 * @param obj The file selector button widget
6530 * @return path The path string
6532 * @see elm_fileselector_button_path_set() for more details
6534 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6537 * Enable/disable a tree view in the given file selector button
6538 * widget's internal file selector
6540 * @param obj The file selector button widget
6541 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6544 * This has the same effect as elm_fileselector_expandable_set(),
6545 * but now applied to a file selector button's internal file
6548 * @note There's no way to put a file selector button's internal
6549 * file selector in "grid mode", as one may do with "pure" file
6552 * @see elm_fileselector_expandable_get()
6554 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6557 * Get whether tree view is enabled for the given file selector
6558 * button widget's internal file selector
6560 * @param obj The file selector button widget
6561 * @return @c EINA_TRUE if @p obj widget's internal file selector
6562 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6564 * @see elm_fileselector_expandable_set() for more details
6566 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6569 * Set whether a given file selector button widget's internal file
6570 * selector is to display folders only or the directory contents,
6573 * @param obj The file selector button widget
6574 * @param only @c EINA_TRUE to make @p obj widget's internal file
6575 * selector only display directories, @c EINA_FALSE to make files
6576 * to be displayed in it too
6578 * This has the same effect as elm_fileselector_folder_only_set(),
6579 * but now applied to a file selector button's internal file
6582 * @see elm_fileselector_folder_only_get()
6584 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6587 * Get whether a given file selector button widget's internal file
6588 * selector is displaying folders only or the directory contents,
6591 * @param obj The file selector button widget
6592 * @return @c EINA_TRUE if @p obj widget's internal file
6593 * selector is only displaying directories, @c EINA_FALSE if files
6594 * are being displayed in it too (and on errors)
6596 * @see elm_fileselector_button_folder_only_set() for more details
6598 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6601 * Enable/disable the file name entry box where the user can type
6602 * in a name for a file, in a given file selector button widget's
6603 * internal file selector.
6605 * @param obj The file selector button widget
6606 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6607 * file selector a "saving dialog", @c EINA_FALSE otherwise
6609 * This has the same effect as elm_fileselector_is_save_set(),
6610 * but now applied to a file selector button's internal file
6613 * @see elm_fileselector_is_save_get()
6615 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6618 * Get whether the given file selector button widget's internal
6619 * file selector is in "saving dialog" mode
6621 * @param obj The file selector button widget
6622 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6623 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6626 * @see elm_fileselector_button_is_save_set() for more details
6628 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6631 * Set 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. By default, it won't.
6635 * @param obj The file selector button widget
6636 * @param value @c EINA_TRUE to make it use an inner window, @c
6637 * EINA_TRUE to make it use a dedicated window
6639 * @see elm_win_inwin_add() for more information on inner windows
6640 * @see elm_fileselector_button_inwin_mode_get()
6642 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6645 * Get whether a given file selector button widget's internal file
6646 * selector will raise an Elementary "inner window", instead of a
6647 * dedicated Elementary window.
6649 * @param obj The file selector button widget
6650 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6651 * if it will use a dedicated window
6653 * @see elm_fileselector_button_inwin_mode_set() for more details
6655 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6662 * @defgroup File_Selector_Entry File Selector Entry
6664 * @image html img/widget/fileselector_entry/preview-00.png
6665 * @image latex img/widget/fileselector_entry/preview-00.eps
6667 * This is an entry made to be filled with or display a <b>file
6668 * system path string</b>. Besides the entry itself, the widget has
6669 * a @ref File_Selector_Button "file selector button" on its side,
6670 * which will raise an internal @ref Fileselector "file selector widget",
6671 * when clicked, for path selection aided by file system
6674 * This file selector may appear in an Elementary window or in an
6675 * inner window. When a file is chosen from it, the (inner) window
6676 * is closed and the selected file's path string is exposed both as
6677 * an smart event and as the new text on the entry.
6679 * This widget encapsulates operations on its internal file
6680 * selector on its own API. There is less control over its file
6681 * selector than that one would have instatiating one directly.
6683 * Smart callbacks one can register to:
6684 * - @c "changed" - The text within the entry was changed
6685 * - @c "activated" - The entry has had editing finished and
6686 * changes are to be "committed"
6687 * - @c "press" - The entry has been clicked
6688 * - @c "longpressed" - The entry has been clicked (and held) for a
6690 * - @c "clicked" - The entry has been clicked
6691 * - @c "clicked,double" - The entry has been double clicked
6692 * - @c "focused" - The entry has received focus
6693 * - @c "unfocused" - The entry has lost focus
6694 * - @c "selection,paste" - A paste action has occurred on the
6696 * - @c "selection,copy" - A copy action has occurred on the entry
6697 * - @c "selection,cut" - A cut action has occurred on the entry
6698 * - @c "unpressed" - The file selector entry's button was released
6699 * after being pressed.
6700 * - @c "file,chosen" - The user has selected a path via the file
6701 * selector entry's internal file selector, whose string pointer
6702 * comes as the @c event_info data (a stringshared string)
6704 * Here is an example on its usage:
6705 * @li @ref fileselector_entry_example
6707 * @see @ref File_Selector_Button for a similar widget.
6712 * Add a new file selector entry widget to the given parent
6713 * Elementary (container) object
6715 * @param parent The parent object
6716 * @return a new file selector entry widget handle or @c NULL, on
6719 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6722 * Set the label for a given file selector entry widget's button
6724 * @param obj The file selector entry widget
6725 * @param label The text label to be displayed on @p obj widget's
6728 * @deprecated use elm_object_text_set() instead.
6730 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6733 * Get the label set for a given file selector entry widget's button
6735 * @param obj The file selector entry widget
6736 * @return The widget button's label
6738 * @deprecated use elm_object_text_set() instead.
6740 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6743 * Set the icon on a given file selector entry widget's button
6745 * @param obj The file selector entry widget
6746 * @param icon The icon object for the entry's button
6748 * Once the icon object is set, a previously set one will be
6749 * deleted. If you want to keep the latter, use the
6750 * elm_fileselector_entry_button_icon_unset() function.
6752 * @see elm_fileselector_entry_button_icon_get()
6754 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6757 * Get the icon set for a given file selector entry widget's button
6759 * @param obj The file selector entry widget
6760 * @return The icon object currently set on @p obj widget's button
6761 * or @c NULL, if none is
6763 * @see elm_fileselector_entry_button_icon_set()
6765 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6768 * Unset the icon used in a given file selector entry widget's
6771 * @param obj The file selector entry widget
6772 * @return The icon object that was being used on @p obj widget's
6773 * button or @c NULL, on errors
6775 * Unparent and return the icon object which was set for this
6778 * @see elm_fileselector_entry_button_icon_set()
6780 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6783 * Set the title for a given file selector entry widget's window
6785 * @param obj The file selector entry widget
6786 * @param title The title string
6788 * This will change the window's title, when the file selector pops
6789 * out after a click on the entry's button. Those windows have the
6790 * default (unlocalized) value of @c "Select a file" as titles.
6792 * @note It will only take any effect if the file selector
6793 * entry widget is @b not under "inwin mode".
6795 * @see elm_fileselector_entry_window_title_get()
6797 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6800 * Get the title set for a given file selector entry widget's
6803 * @param obj The file selector entry widget
6804 * @return Title of the file selector entry's window
6806 * @see elm_fileselector_entry_window_title_get() for more details
6808 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6811 * Set the size of a given file selector entry widget's window,
6812 * holding the file selector itself.
6814 * @param obj The file selector entry widget
6815 * @param width The window's width
6816 * @param height The window's height
6818 * @note it will only take any effect if the file selector entry
6819 * widget is @b not under "inwin mode". The default size for the
6820 * window (when applicable) is 400x400 pixels.
6822 * @see elm_fileselector_entry_window_size_get()
6824 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6827 * Get the size of a given file selector entry widget's window,
6828 * holding the file selector itself.
6830 * @param obj The file selector entry widget
6831 * @param width Pointer into which to store the width value
6832 * @param height Pointer into which to store the height value
6834 * @note Use @c NULL pointers on the size values you're not
6835 * interested in: they'll be ignored by the function.
6837 * @see elm_fileselector_entry_window_size_set(), for more details
6839 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6842 * Set the initial file system path and the entry's path string for
6843 * a given file selector entry widget
6845 * @param obj The file selector entry widget
6846 * @param path The path string
6848 * It must be a <b>directory</b> path, which will have the contents
6849 * displayed initially in the file selector's view, when invoked
6850 * from @p obj. The default initial path is the @c "HOME"
6851 * environment variable's value.
6853 * @see elm_fileselector_entry_path_get()
6855 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6858 * Get the entry's path string for a given file selector entry
6861 * @param obj The file selector entry widget
6862 * @return path The path string
6864 * @see elm_fileselector_entry_path_set() for more details
6866 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6869 * Enable/disable a tree view in the given file selector entry
6870 * widget's internal file selector
6872 * @param obj The file selector entry widget
6873 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6876 * This has the same effect as elm_fileselector_expandable_set(),
6877 * but now applied to a file selector entry's internal file
6880 * @note There's no way to put a file selector entry's internal
6881 * file selector in "grid mode", as one may do with "pure" file
6884 * @see elm_fileselector_expandable_get()
6886 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6889 * Get whether tree view is enabled for the given file selector
6890 * entry widget's internal file selector
6892 * @param obj The file selector entry widget
6893 * @return @c EINA_TRUE if @p obj widget's internal file selector
6894 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6896 * @see elm_fileselector_expandable_set() for more details
6898 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6901 * Set whether a given file selector entry widget's internal file
6902 * selector is to display folders only or the directory contents,
6905 * @param obj The file selector entry widget
6906 * @param only @c EINA_TRUE to make @p obj widget's internal file
6907 * selector only display directories, @c EINA_FALSE to make files
6908 * to be displayed in it too
6910 * This has the same effect as elm_fileselector_folder_only_set(),
6911 * but now applied to a file selector entry's internal file
6914 * @see elm_fileselector_folder_only_get()
6916 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6919 * Get whether a given file selector entry widget's internal file
6920 * selector is displaying folders only or the directory contents,
6923 * @param obj The file selector entry widget
6924 * @return @c EINA_TRUE if @p obj widget's internal file
6925 * selector is only displaying directories, @c EINA_FALSE if files
6926 * are being displayed in it too (and on errors)
6928 * @see elm_fileselector_entry_folder_only_set() for more details
6930 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6933 * Enable/disable the file name entry box where the user can type
6934 * in a name for a file, in a given file selector entry widget's
6935 * internal file selector.
6937 * @param obj The file selector entry widget
6938 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6939 * file selector a "saving dialog", @c EINA_FALSE otherwise
6941 * This has the same effect as elm_fileselector_is_save_set(),
6942 * but now applied to a file selector entry's internal file
6945 * @see elm_fileselector_is_save_get()
6947 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6950 * Get whether the given file selector entry widget's internal
6951 * file selector is in "saving dialog" mode
6953 * @param obj The file selector entry widget
6954 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6955 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6958 * @see elm_fileselector_entry_is_save_set() for more details
6960 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6963 * Set 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. By default, it won't.
6967 * @param obj The file selector entry widget
6968 * @param value @c EINA_TRUE to make it use an inner window, @c
6969 * EINA_TRUE to make it use a dedicated window
6971 * @see elm_win_inwin_add() for more information on inner windows
6972 * @see elm_fileselector_entry_inwin_mode_get()
6974 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6977 * Get whether a given file selector entry widget's internal file
6978 * selector will raise an Elementary "inner window", instead of a
6979 * dedicated Elementary window.
6981 * @param obj The file selector entry widget
6982 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6983 * if it will use a dedicated window
6985 * @see elm_fileselector_entry_inwin_mode_set() for more details
6987 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6990 * Set the initial file system path for a given file selector entry
6993 * @param obj The file selector entry widget
6994 * @param path The path string
6996 * It must be a <b>directory</b> path, which will have the contents
6997 * displayed initially in the file selector's view, when invoked
6998 * from @p obj. The default initial path is the @c "HOME"
6999 * environment variable's value.
7001 * @see elm_fileselector_entry_path_get()
7003 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
7006 * Get the parent directory's path to the latest file selection on
7007 * a given filer selector entry widget
7009 * @param obj The file selector object
7010 * @return The (full) path of the directory of the last selection
7011 * on @p obj widget, a @b stringshared string
7013 * @see elm_fileselector_entry_path_set()
7015 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7022 * @defgroup Scroller Scroller
7024 * A scroller holds a single object and "scrolls it around". This means that
7025 * it allows the user to use a scrollbar (or a finger) to drag the viewable
7026 * region around, allowing to move through a much larger object that is
7027 * contained in the scroller. The scroller will always have a small minimum
7028 * size by default as it won't be limited by the contents of the scroller.
7030 * Signals that you can add callbacks for are:
7031 * @li "edge,left" - the left edge of the content has been reached
7032 * @li "edge,right" - the right edge of the content has been reached
7033 * @li "edge,top" - the top edge of the content has been reached
7034 * @li "edge,bottom" - the bottom edge of the content has been reached
7035 * @li "scroll" - the content has been scrolled (moved)
7036 * @li "scroll,anim,start" - scrolling animation has started
7037 * @li "scroll,anim,stop" - scrolling animation has stopped
7038 * @li "scroll,drag,start" - dragging the contents around has started
7039 * @li "scroll,drag,stop" - dragging the contents around has stopped
7040 * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
7043 * @note When Elemementary is in embedded mode the scrollbars will not be
7044 * dragable, they appear merely as indicators of how much has been scrolled.
7045 * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
7046 * fingerscroll) won't work.
7048 * To set/get/unset the content of the panel, you can use
7049 * elm_object_content_set/get/unset APIs.
7050 * Once the content object is set, a previously set one will be deleted.
7051 * If you want to keep that old content object, use the
7052 * elm_object_content_unset() function
7054 * In @ref tutorial_scroller you'll find an example of how to use most of
7059 * @brief Type that controls when scrollbars should appear.
7061 * @see elm_scroller_policy_set()
7063 typedef enum _Elm_Scroller_Policy
7065 ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
7066 ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
7067 ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
7068 ELM_SCROLLER_POLICY_LAST
7069 } Elm_Scroller_Policy;
7071 * @brief Add a new scroller to the parent
7073 * @param parent The parent object
7074 * @return The new object or NULL if it cannot be created
7076 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7078 * @brief Set the content of the scroller widget (the object to be scrolled around).
7080 * @param obj The scroller object
7081 * @param content The new content object
7083 * Once the content object is set, a previously set one will be deleted.
7084 * If you want to keep that old content object, use the
7085 * elm_scroller_content_unset() function.
7086 * @deprecated use elm_object_content_set() instead
7088 EINA_DEPRECATED EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
7090 * @brief Get the content of the scroller widget
7092 * @param obj The slider object
7093 * @return The content that is being used
7095 * Return the content object which is set for this widget
7097 * @see elm_scroller_content_set()
7098 * @deprecated use elm_object_content_get() instead.
7100 EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7102 * @brief Unset the content of the scroller widget
7104 * @param obj The slider object
7105 * @return The content that was being used
7107 * Unparent and return the content object which was set for this widget
7109 * @see elm_scroller_content_set()
7110 * @deprecated use elm_object_content_unset() instead.
7112 EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7114 * @brief Set custom theme elements for the scroller
7116 * @param obj The scroller object
7117 * @param widget The widget name to use (default is "scroller")
7118 * @param base The base name to use (default is "base")
7120 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
7122 * @brief Make the scroller minimum size limited to the minimum size of the content
7124 * @param obj The scroller object
7125 * @param w Enable limiting minimum size horizontally
7126 * @param h Enable limiting minimum size vertically
7128 * By default the scroller will be as small as its design allows,
7129 * irrespective of its content. This will make the scroller minimum size the
7130 * right size horizontally and/or vertically to perfectly fit its content in
7133 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
7135 * @brief Show a specific virtual region within the scroller content object
7137 * @param obj The scroller object
7138 * @param x X coordinate of the region
7139 * @param y Y coordinate of the region
7140 * @param w Width of the region
7141 * @param h Height of the region
7143 * This will ensure all (or part if it does not fit) of the designated
7144 * region in the virtual content object (0, 0 starting at the top-left of the
7145 * virtual content object) is shown within the scroller.
7147 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);
7149 * @brief Set the scrollbar visibility policy
7151 * @param obj The scroller object
7152 * @param policy_h Horizontal scrollbar policy
7153 * @param policy_v Vertical scrollbar policy
7155 * This sets the scrollbar visibility policy for the given scroller.
7156 * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
7157 * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
7158 * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
7159 * respectively for the horizontal and vertical scrollbars.
7161 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
7163 * @brief Gets scrollbar visibility policy
7165 * @param obj The scroller object
7166 * @param policy_h Horizontal scrollbar policy
7167 * @param policy_v Vertical scrollbar policy
7169 * @see elm_scroller_policy_set()
7171 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
7173 * @brief Get the currently visible content region
7175 * @param obj The scroller object
7176 * @param x X coordinate of the region
7177 * @param y Y coordinate of the region
7178 * @param w Width of the region
7179 * @param h Height of the region
7181 * This gets the current region in the content object that is visible through
7182 * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
7183 * w, @p h values pointed to.
7185 * @note All coordinates are relative to the content.
7187 * @see elm_scroller_region_show()
7189 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);
7191 * @brief Get the size of the content object
7193 * @param obj The scroller object
7194 * @param w Width of the content object.
7195 * @param h Height of the content object.
7197 * This gets the size of the content object of the scroller.
7199 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7201 * @brief Set bouncing behavior
7203 * @param obj The scroller object
7204 * @param h_bounce Allow bounce horizontally
7205 * @param v_bounce Allow bounce vertically
7207 * When scrolling, the scroller may "bounce" when reaching an edge of the
7208 * content object. This is a visual way to indicate the end has been reached.
7209 * This is enabled by default for both axis. This API will set if it is enabled
7210 * for the given axis with the boolean parameters for each axis.
7212 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7214 * @brief Get the bounce behaviour
7216 * @param obj The Scroller object
7217 * @param h_bounce Will the scroller bounce horizontally or not
7218 * @param v_bounce Will the scroller bounce vertically or not
7220 * @see elm_scroller_bounce_set()
7222 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7224 * @brief Set scroll page size relative to viewport size.
7226 * @param obj The scroller object
7227 * @param h_pagerel The horizontal page relative size
7228 * @param v_pagerel The vertical page relative size
7230 * The scroller is capable of limiting scrolling by the user to "pages". That
7231 * is to jump by and only show a "whole page" at a time as if the continuous
7232 * area of the scroller content is split into page sized pieces. This sets
7233 * the size of a page relative to the viewport of the scroller. 1.0 is "1
7234 * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7235 * axis. This is mutually exclusive with page size
7236 * (see elm_scroller_page_size_set() for more information). Likewise 0.5
7237 * is "half a viewport". Sane usable values are normally between 0.0 and 1.0
7238 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7241 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7243 * @brief Set scroll page size.
7245 * @param obj The scroller object
7246 * @param h_pagesize The horizontal page size
7247 * @param v_pagesize The vertical page size
7249 * This sets the page size to an absolute fixed value, with 0 turning it off
7252 * @see elm_scroller_page_relative_set()
7254 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7256 * @brief Get scroll current page number.
7258 * @param obj The scroller object
7259 * @param h_pagenumber The horizontal page number
7260 * @param v_pagenumber The vertical page number
7262 * The page number starts from 0. 0 is the first page.
7263 * Current page means the page which meets the top-left of the viewport.
7264 * If there are two or more pages in the viewport, it returns the number of the page
7265 * which meets the top-left of the viewport.
7267 * @see elm_scroller_last_page_get()
7268 * @see elm_scroller_page_show()
7269 * @see elm_scroller_page_brint_in()
7271 EAPI void elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7273 * @brief Get scroll last page number.
7275 * @param obj The scroller object
7276 * @param h_pagenumber The horizontal page number
7277 * @param v_pagenumber The vertical page number
7279 * The page number starts from 0. 0 is the first page.
7280 * This returns the last page number among the pages.
7282 * @see elm_scroller_current_page_get()
7283 * @see elm_scroller_page_show()
7284 * @see elm_scroller_page_brint_in()
7286 EAPI void elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7288 * Show a specific virtual region within the scroller content object by page number.
7290 * @param obj The scroller object
7291 * @param h_pagenumber The horizontal page number
7292 * @param v_pagenumber The vertical page number
7294 * 0, 0 of the indicated page is located at the top-left of the viewport.
7295 * This will jump to the page directly without animation.
7300 * sc = elm_scroller_add(win);
7301 * elm_scroller_content_set(sc, content);
7302 * elm_scroller_page_relative_set(sc, 1, 0);
7303 * elm_scroller_current_page_get(sc, &h_page, &v_page);
7304 * elm_scroller_page_show(sc, h_page + 1, v_page);
7307 * @see elm_scroller_page_bring_in()
7309 EAPI void elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7311 * Show a specific virtual region within the scroller content object by page number.
7313 * @param obj The scroller object
7314 * @param h_pagenumber The horizontal page number
7315 * @param v_pagenumber The vertical page number
7317 * 0, 0 of the indicated page is located at the top-left of the viewport.
7318 * This will slide to the page with animation.
7323 * sc = elm_scroller_add(win);
7324 * elm_scroller_content_set(sc, content);
7325 * elm_scroller_page_relative_set(sc, 1, 0);
7326 * elm_scroller_last_page_get(sc, &h_page, &v_page);
7327 * elm_scroller_page_bring_in(sc, h_page, v_page);
7330 * @see elm_scroller_page_show()
7332 EAPI void elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7334 * @brief Show a specific virtual region within the scroller content object.
7336 * @param obj The scroller object
7337 * @param x X coordinate of the region
7338 * @param y Y coordinate of the region
7339 * @param w Width of the region
7340 * @param h Height of the region
7342 * This will ensure all (or part if it does not fit) of the designated
7343 * region in the virtual content object (0, 0 starting at the top-left of the
7344 * virtual content object) is shown within the scroller. Unlike
7345 * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7346 * to this location (if configuration in general calls for transitions). It
7347 * may not jump immediately to the new location and make take a while and
7348 * show other content along the way.
7350 * @see elm_scroller_region_show()
7352 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);
7354 * @brief Set event propagation on a scroller
7356 * @param obj The scroller object
7357 * @param propagation If propagation is enabled or not
7359 * This enables or disabled event propagation from the scroller content to
7360 * the scroller and its parent. By default event propagation is disabled.
7362 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation) EINA_ARG_NONNULL(1);
7364 * @brief Get event propagation for a scroller
7366 * @param obj The scroller object
7367 * @return The propagation state
7369 * This gets the event propagation for a scroller.
7371 * @see elm_scroller_propagate_events_set()
7373 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7375 * @brief Set scrolling gravity on a scroller
7377 * @param obj The scroller object
7378 * @param x The scrolling horizontal gravity
7379 * @param y The scrolling vertical gravity
7381 * The gravity, defines how the scroller will adjust its view
7382 * when the size of the scroller contents increase.
7384 * The scroller will adjust the view to glue itself as follows.
7386 * x=0.0, for showing the left most region of the content.
7387 * x=1.0, for showing the right most region of the content.
7388 * y=0.0, for showing the bottom most region of the content.
7389 * y=1.0, for showing the top most region of the content.
7391 * Default values for x and y are 0.0
7393 EAPI void elm_scroller_gravity_set(Evas_Object *obj, double x, double y) EINA_ARG_NONNULL(1);
7395 * @brief Get scrolling gravity values for a scroller
7397 * @param obj The scroller object
7398 * @param x The scrolling horizontal gravity
7399 * @param y The scrolling vertical gravity
7401 * This gets gravity values for a scroller.
7403 * @see elm_scroller_gravity_set()
7406 EAPI void elm_scroller_gravity_get(const Evas_Object *obj, double *x, double *y) EINA_ARG_NONNULL(1);
7412 * @defgroup Label Label
7414 * @image html img/widget/label/preview-00.png
7415 * @image latex img/widget/label/preview-00.eps
7417 * @brief Widget to display text, with simple html-like markup.
7419 * The Label widget @b doesn't allow text to overflow its boundaries, if the
7420 * text doesn't fit the geometry of the label it will be ellipsized or be
7421 * cut. Elementary provides several themes for this widget:
7422 * @li default - No animation
7423 * @li marker - Centers the text in the label and make it bold by default
7424 * @li slide_long - The entire text appears from the right of the screen and
7425 * slides until it disappears in the left of the screen(reappering on the
7427 * @li slide_short - The text appears in the left of the label and slides to
7428 * the right to show the overflow. When all of the text has been shown the
7429 * position is reset.
7430 * @li slide_bounce - The text appears in the left of the label and slides to
7431 * the right to show the overflow. When all of the text has been shown the
7432 * animation reverses, moving the text to the left.
7434 * Custom themes can of course invent new markup tags and style them any way
7437 * The following signals may be emitted by the label widget:
7438 * @li "language,changed": The program's language changed.
7440 * See @ref tutorial_label for a demonstration of how to use a label widget.
7444 * @brief Add a new label to the parent
7446 * @param parent The parent object
7447 * @return The new object or NULL if it cannot be created
7449 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7451 * @brief Set the label on the label object
7453 * @param obj The label object
7454 * @param label The label will be used on the label object
7455 * @deprecated See elm_object_text_set()
7457 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 */
7459 * @brief Get the label used on the label object
7461 * @param obj The label object
7462 * @return The string inside the label
7463 * @deprecated See elm_object_text_get()
7465 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7467 * @brief Set the wrapping behavior of the label
7469 * @param obj The label object
7470 * @param wrap To wrap text or not
7472 * By default no wrapping is done. Possible values for @p wrap are:
7473 * @li ELM_WRAP_NONE - No wrapping
7474 * @li ELM_WRAP_CHAR - wrap between characters
7475 * @li ELM_WRAP_WORD - wrap between words
7476 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7478 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7480 * @brief Get the wrapping behavior of the label
7482 * @param obj The label object
7485 * @see elm_label_line_wrap_set()
7487 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7489 * @brief Set wrap width of the label
7491 * @param obj The label object
7492 * @param w The wrap width in pixels at a minimum where words need to wrap
7494 * This function sets the maximum width size hint of the label.
7496 * @warning This is only relevant if the label is inside a container.
7498 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7500 * @brief Get wrap width of the label
7502 * @param obj The label object
7503 * @return The wrap width in pixels at a minimum where words need to wrap
7505 * @see elm_label_wrap_width_set()
7507 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7509 * @brief Set wrap height of the label
7511 * @param obj The label object
7512 * @param h The wrap height in pixels at a minimum where words need to wrap
7514 * This function sets the maximum height size hint of the label.
7516 * @warning This is only relevant if the label is inside a container.
7518 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7520 * @brief get wrap width of the label
7522 * @param obj The label object
7523 * @return The wrap height in pixels at a minimum where words need to wrap
7525 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7527 * @brief Set the font size on the label object.
7529 * @param obj The label object
7530 * @param size font size
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_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7538 * @brief Set the text color on the label object
7540 * @param obj The label object
7541 * @param r Red property background color of The label object
7542 * @param g Green property background color of The label object
7543 * @param b Blue property background color of The label object
7544 * @param a Alpha property background color of The label object
7546 * @warning NEVER use this. It is for hyper-special cases only. use styles
7547 * instead. e.g. "big", "medium", "small" - or better name them by use:
7548 * "title", "footnote", "quote" etc.
7550 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);
7552 * @brief Set the text align on the label object
7554 * @param obj The label object
7555 * @param align align mode ("left", "center", "right")
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_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7563 * @brief Set background color of the label
7565 * @param obj The label object
7566 * @param r Red property background color of The label object
7567 * @param g Green property background color of The label object
7568 * @param b Blue property background color of The label object
7569 * @param a Alpha property background alpha of The label object
7571 * @warning NEVER use this. It is for hyper-special cases only. use styles
7572 * instead. e.g. "big", "medium", "small" - or better name them by use:
7573 * "title", "footnote", "quote" etc.
7575 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);
7577 * @brief Set the ellipsis behavior of the label
7579 * @param obj The label object
7580 * @param ellipsis To ellipsis text or not
7582 * If set to true and the text doesn't fit in the label an ellipsis("...")
7583 * will be shown at the end of the widget.
7585 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7586 * choosen wrap method was ELM_WRAP_WORD.
7588 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7590 * @brief Set the text slide of the label
7592 * @param obj The label object
7593 * @param slide To start slide or stop
7595 * If set to true, the text of the label will slide/scroll through the length of
7598 * @warning This only works with the themes "slide_short", "slide_long" and
7601 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7603 * @brief Get the text slide mode of the label
7605 * @param obj The label object
7606 * @return slide slide mode value
7608 * @see elm_label_slide_set()
7610 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7612 * @brief Set the slide duration(speed) of the label
7614 * @param obj The label object
7615 * @return The duration in seconds in moving text from slide begin position
7616 * to slide end position
7618 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7620 * @brief Get the slide duration(speed) of the label
7622 * @param obj The label object
7623 * @return The duration time in moving text from slide begin position to slide end position
7625 * @see elm_label_slide_duration_set()
7627 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7633 * @defgroup Toggle Toggle
7635 * @image html img/widget/toggle/preview-00.png
7636 * @image latex img/widget/toggle/preview-00.eps
7638 * @brief A toggle is a slider which can be used to toggle between
7639 * two values. It has two states: on and off.
7641 * This widget is deprecated. Please use elm_check_add() instead using the
7642 * toggle style like:
7645 * obj = elm_check_add(parent);
7646 * elm_object_style_set(obj, "toggle");
7647 * elm_object_text_part_set(obj, "on", "ON");
7648 * elm_object_text_part_set(obj, "off", "OFF");
7651 * Signals that you can add callbacks for are:
7652 * @li "changed" - Whenever the toggle value has been changed. Is not called
7653 * until the toggle is released by the cursor (assuming it
7654 * has been triggered by the cursor in the first place).
7656 * @ref tutorial_toggle show how to use a toggle.
7660 * @brief Add a toggle to @p parent.
7662 * @param parent The parent object
7664 * @return The toggle object
7666 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7668 * @brief Sets the label to be displayed with the toggle.
7670 * @param obj The toggle object
7671 * @param label The label to be displayed
7673 * @deprecated use elm_object_text_set() instead.
7675 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7677 * @brief Gets the label of the toggle
7679 * @param obj toggle object
7680 * @return The label of the toggle
7682 * @deprecated use elm_object_text_get() instead.
7684 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7686 * @brief Set the icon used for the toggle
7688 * @param obj The toggle object
7689 * @param icon The icon object for the button
7691 * Once the icon object is set, a previously set one will be deleted
7692 * If you want to keep that old content object, use the
7693 * elm_toggle_icon_unset() function.
7695 * @deprecated use elm_object_content_set() instead.
7697 EINA_DEPRECATED EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7699 * @brief Get the icon used for the toggle
7701 * @param obj The toggle object
7702 * @return The icon object that is being used
7704 * Return the icon object which is set for this widget.
7706 * @see elm_toggle_icon_set()
7708 * @deprecated use elm_object_content_get() instead.
7710 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7712 * @brief Unset the icon used for the toggle
7714 * @param obj The toggle object
7715 * @return The icon object that was being used
7717 * Unparent and return the icon object which was set for this widget.
7719 * @see elm_toggle_icon_set()
7721 * @deprecated use elm_object_content_unset() instead.
7723 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7725 * @brief Sets the labels to be associated with the on and off states of the toggle.
7727 * @param obj The toggle object
7728 * @param onlabel The label displayed when the toggle is in the "on" state
7729 * @param offlabel The label displayed when the toggle is in the "off" state
7731 * @deprecated use elm_object_text_part_set() for "on" and "off" parts
7734 EINA_DEPRECATED EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7736 * @brief Gets the labels associated with the on and off states of the
7739 * @param obj The toggle object
7740 * @param onlabel A char** to place the onlabel of @p obj into
7741 * @param offlabel A char** to place the offlabel of @p obj into
7743 * @deprecated use elm_object_text_part_get() for "on" and "off" parts
7746 EINA_DEPRECATED EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7748 * @brief Sets the state of the toggle to @p state.
7750 * @param obj The toggle object
7751 * @param state The state of @p obj
7753 * @deprecated use elm_check_state_set() instead.
7755 EINA_DEPRECATED EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7757 * @brief Gets the state of the toggle to @p state.
7759 * @param obj The toggle object
7760 * @return The state of @p obj
7762 * @deprecated use elm_check_state_get() instead.
7764 EINA_DEPRECATED EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7766 * @brief Sets the state pointer of the toggle to @p statep.
7768 * @param obj The toggle object
7769 * @param statep The state pointer of @p obj
7771 * @deprecated use elm_check_state_pointer_set() instead.
7773 EINA_DEPRECATED EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7779 * @defgroup Frame Frame
7781 * @image html img/widget/frame/preview-00.png
7782 * @image latex img/widget/frame/preview-00.eps
7784 * @brief Frame is a widget that holds some content and has a title.
7786 * The default look is a frame with a title, but Frame supports multple
7794 * @li outdent_bottom
7796 * Of all this styles only default shows the title. Frame emits no signals.
7798 * Default contents parts of the frame widget that you can use for are:
7799 * @li "elm.swallow.content" - A content of the frame
7801 * Default text parts of the frame widget that you can use for are:
7802 * @li "elm.text" - Label of the frame
7804 * For a detailed example see the @ref tutorial_frame.
7809 * @brief Add a new frame to the parent
7811 * @param parent The parent object
7812 * @return The new object or NULL if it cannot be created
7814 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7816 * @brief Set the frame label
7818 * @param obj The frame object
7819 * @param label The label of this frame object
7821 * @deprecated use elm_object_text_set() instead.
7823 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7825 * @brief Get the frame label
7827 * @param obj The frame object
7829 * @return The label of this frame objet or NULL if unable to get frame
7831 * @deprecated use elm_object_text_get() instead.
7833 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7835 * @brief Set the content of the frame widget
7837 * Once the content object is set, a previously set one will be deleted.
7838 * If you want to keep that old content object, use the
7839 * elm_frame_content_unset() function.
7841 * @param obj The frame object
7842 * @param content The content will be filled in this frame object
7844 * @deprecated use elm_object_content_set() instead.
7846 EINA_DEPRECATED EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7848 * @brief Get the content of the frame widget
7850 * Return the content object which is set for this widget
7852 * @param obj The frame object
7853 * @return The content that is being used
7855 * @deprecated use elm_object_content_get() instead.
7857 EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7859 * @brief Unset the content of the frame widget
7861 * Unparent and return the content object which was set for this widget
7863 * @param obj The frame object
7864 * @return The content that was being used
7866 * @deprecated use elm_object_content_unset() instead.
7868 EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7874 * @defgroup Table Table
7876 * A container widget to arrange other widgets in a table where items can
7877 * also span multiple columns or rows - even overlap (and then be raised or
7878 * lowered accordingly to adjust stacking if they do overlap).
7880 * For a Table widget the row/column count is not fixed.
7881 * The table widget adjusts itself when subobjects are added to it dynamically.
7883 * The followin are examples of how to use a table:
7884 * @li @ref tutorial_table_01
7885 * @li @ref tutorial_table_02
7890 * @brief Add a new table to the parent
7892 * @param parent The parent object
7893 * @return The new object or NULL if it cannot be created
7895 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7897 * @brief Set the homogeneous layout in the table
7899 * @param obj The layout object
7900 * @param homogeneous A boolean to set if the layout is homogeneous in the
7901 * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7903 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7905 * @brief Get the current table homogeneous mode.
7907 * @param obj The table object
7908 * @return A boolean to indicating if the layout is homogeneous in the table
7909 * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7911 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7913 * @warning <b>Use elm_table_homogeneous_set() instead</b>
7915 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7917 * @warning <b>Use elm_table_homogeneous_get() instead</b>
7919 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7921 * @brief Set padding between cells.
7923 * @param obj The layout object.
7924 * @param horizontal set the horizontal padding.
7925 * @param vertical set the vertical padding.
7927 * Default value is 0.
7929 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7931 * @brief Get padding between cells.
7933 * @param obj The layout object.
7934 * @param horizontal set the horizontal padding.
7935 * @param vertical set the vertical padding.
7937 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7939 * @brief Add a subobject on the table with the coordinates passed
7941 * @param obj The table object
7942 * @param subobj The subobject to be added to the table
7943 * @param x Row number
7944 * @param y Column number
7948 * @note All positioning inside the table is relative to rows and columns, so
7949 * a value of 0 for x and y, means the top left cell of the table, and a
7950 * value of 1 for w and h means @p subobj only takes that 1 cell.
7952 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7954 * @brief Remove child from table.
7956 * @param obj The table object
7957 * @param subobj The subobject
7959 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
7961 * @brief Faster way to remove all child objects from a table object.
7963 * @param obj The table object
7964 * @param clear If true, will delete children, else just remove from table.
7966 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
7968 * @brief Set the packing location of an existing child of the table
7970 * @param subobj The subobject to be modified in the table
7971 * @param x Row number
7972 * @param y Column number
7976 * Modifies the position of an object already in the table.
7978 * @note All positioning inside the table is relative to rows and columns, so
7979 * a value of 0 for x and y, means the top left cell of the table, and a
7980 * value of 1 for w and h means @p subobj only takes that 1 cell.
7982 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7984 * @brief Get the packing location of an existing child of the table
7986 * @param subobj The subobject to be modified in the table
7987 * @param x Row number
7988 * @param y Column number
7992 * @see elm_table_pack_set()
7994 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
7999 /* TEMPORARY: DOCS WILL BE FILLED IN WITH CNP/SED */
8000 typedef struct Elm_Gen_Item Elm_Gen_Item;
8001 typedef struct _Elm_Gen_Item_Class Elm_Gen_Item_Class;
8002 typedef struct _Elm_Gen_Item_Class_Func Elm_Gen_Item_Class_Func; /**< Class functions for gen item classes. */
8003 typedef char *(*Elm_Gen_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gen item classes. */
8004 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. */
8005 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. */
8006 typedef void (*Elm_Gen_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for gen item classes. */
8007 struct _Elm_Gen_Item_Class
8009 const char *item_style;
8010 struct _Elm_Gen_Item_Class_Func
8012 Elm_Gen_Item_Label_Get_Cb label_get;
8013 Elm_Gen_Item_Content_Get_Cb content_get;
8014 Elm_Gen_Item_State_Get_Cb state_get;
8015 Elm_Gen_Item_Del_Cb del;
8018 EAPI void elm_gen_clear(Evas_Object *obj);
8019 EAPI void elm_gen_item_selected_set(Elm_Gen_Item *it, Eina_Bool selected);
8020 EAPI Eina_Bool elm_gen_item_selected_get(const Elm_Gen_Item *it);
8021 EAPI void elm_gen_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select);
8022 EAPI Eina_Bool elm_gen_always_select_mode_get(const Evas_Object *obj);
8023 EAPI void elm_gen_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select);
8024 EAPI Eina_Bool elm_gen_no_select_mode_get(const Evas_Object *obj);
8025 EAPI void elm_gen_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
8026 EAPI void elm_gen_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
8027 EAPI void elm_gen_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel);
8028 EAPI void elm_gen_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel);
8029 EAPI void elm_gen_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize);
8030 EAPI void elm_gen_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
8031 EAPI void elm_gen_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
8032 EAPI void elm_gen_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
8033 EAPI void elm_gen_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
8034 EAPI Elm_Gen_Item *elm_gen_first_item_get(const Evas_Object *obj);
8035 EAPI Elm_Gen_Item *elm_gen_last_item_get(const Evas_Object *obj);
8036 EAPI Elm_Gen_Item *elm_gen_item_next_get(const Elm_Gen_Item *it);
8037 EAPI Elm_Gen_Item *elm_gen_item_prev_get(const Elm_Gen_Item *it);
8038 EAPI Evas_Object *elm_gen_item_widget_get(const Elm_Gen_Item *it);
8041 * @defgroup Gengrid Gengrid (Generic grid)
8043 * This widget aims to position objects in a grid layout while
8044 * actually creating and rendering only the visible ones, using the
8045 * same idea as the @ref Genlist "genlist": the user defines a @b
8046 * class for each item, specifying functions that will be called at
8047 * object creation, deletion, etc. When those items are selected by
8048 * the user, a callback function is issued. Users may interact with
8049 * a gengrid via the mouse (by clicking on items to select them and
8050 * clicking on the grid's viewport and swiping to pan the whole
8051 * view) or via the keyboard, navigating through item with the
8054 * @section Gengrid_Layouts Gengrid layouts
8056 * Gengrid may layout its items in one of two possible layouts:
8060 * When in "horizontal mode", items will be placed in @b columns,
8061 * from top to bottom and, when the space for a column is filled,
8062 * another one is started on the right, thus expanding the grid
8063 * horizontally, making for horizontal scrolling. When in "vertical
8064 * mode" , though, items will be placed in @b rows, from left to
8065 * right and, when the space for a row is filled, another one is
8066 * started below, thus expanding the grid vertically (and making
8067 * for vertical scrolling).
8069 * @section Gengrid_Items Gengrid items
8071 * An item in a gengrid can have 0 or more text labels (they can be
8072 * regular text or textblock Evas objects - that's up to the style
8073 * to determine), 0 or more icons (which are simply objects
8074 * swallowed into the gengrid item's theming Edje object) and 0 or
8075 * more <b>boolean states</b>, which have the behavior left to the
8076 * user to define. The Edje part names for each of these properties
8077 * will be looked up, in the theme file for the gengrid, under the
8078 * Edje (string) data items named @c "labels", @c "icons" and @c
8079 * "states", respectively. For each of those properties, if more
8080 * than one part is provided, they must have names listed separated
8081 * by spaces in the data fields. For the default gengrid item
8082 * theme, we have @b one label part (@c "elm.text"), @b two icon
8083 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
8086 * A gengrid item may be at one of several styles. Elementary
8087 * provides one by default - "default", but this can be extended by
8088 * system or application custom themes/overlays/extensions (see
8089 * @ref Theme "themes" for more details).
8091 * @section Gengrid_Item_Class Gengrid item classes
8093 * In order to have the ability to add and delete items on the fly,
8094 * gengrid implements a class (callback) system where the
8095 * application provides a structure with information about that
8096 * type of item (gengrid may contain multiple different items with
8097 * different classes, states and styles). Gengrid will call the
8098 * functions in this struct (methods) when an item is "realized"
8099 * (i.e., created dynamically, while the user is scrolling the
8100 * grid). All objects will simply be deleted when no longer needed
8101 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
8102 * contains the following members:
8103 * - @c item_style - This is a constant string and simply defines
8104 * the name of the item style. It @b must be specified and the
8105 * default should be @c "default".
8106 * - @c func.label_get - This function is called when an item
8107 * object is actually created. The @c data parameter will point to
8108 * the same data passed to elm_gengrid_item_append() and related
8109 * item creation functions. The @c obj parameter is the gengrid
8110 * object itself, while the @c part one is the name string of one
8111 * of the existing text parts in the Edje group implementing the
8112 * item's theme. This function @b must return a strdup'()ed string,
8113 * as the caller will free() it when done. See
8114 * #Elm_Gengrid_Item_Label_Get_Cb.
8115 * - @c func.content_get - This function is called when an item object
8116 * is actually created. The @c data parameter will point to the
8117 * same data passed to elm_gengrid_item_append() and related item
8118 * creation functions. The @c obj parameter is the gengrid object
8119 * itself, while the @c part one is the name string of one of the
8120 * existing (content) swallow parts in the Edje group implementing the
8121 * item's theme. It must return @c NULL, when no content is desired,
8122 * or a valid object handle, otherwise. The object will be deleted
8123 * by the gengrid on its deletion or when the item is "unrealized".
8124 * See #Elm_Gengrid_Item_Content_Get_Cb.
8125 * - @c func.state_get - This function is called when an item
8126 * object is actually created. The @c data parameter will point to
8127 * the same data passed to elm_gengrid_item_append() and related
8128 * item creation functions. The @c obj parameter is the gengrid
8129 * object itself, while the @c part one is the name string of one
8130 * of the state parts in the Edje group implementing the item's
8131 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
8132 * true/on. Gengrids will emit a signal to its theming Edje object
8133 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
8134 * "source" arguments, respectively, when the state is true (the
8135 * default is false), where @c XXX is the name of the (state) part.
8136 * See #Elm_Gengrid_Item_State_Get_Cb.
8137 * - @c func.del - This is called when elm_gengrid_item_del() is
8138 * called on an item or elm_gengrid_clear() is called on the
8139 * gengrid. This is intended for use when gengrid items are
8140 * deleted, so any data attached to the item (e.g. its data
8141 * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
8143 * @section Gengrid_Usage_Hints Usage hints
8145 * If the user wants to have multiple items selected at the same
8146 * time, elm_gengrid_multi_select_set() will permit it. If the
8147 * gengrid is single-selection only (the default), then
8148 * elm_gengrid_select_item_get() will return the selected item or
8149 * @c NULL, if none is selected. If the gengrid is under
8150 * multi-selection, then elm_gengrid_selected_items_get() will
8151 * return a list (that is only valid as long as no items are
8152 * modified (added, deleted, selected or unselected) of child items
8155 * If an item changes (internal (boolean) state, label or content
8156 * changes), then use elm_gengrid_item_update() to have gengrid
8157 * update the item with the new state. A gengrid will re-"realize"
8158 * the item, thus calling the functions in the
8159 * #Elm_Gengrid_Item_Class set for that item.
8161 * To programmatically (un)select an item, use
8162 * elm_gengrid_item_selected_set(). To get its selected state use
8163 * elm_gengrid_item_selected_get(). To make an item disabled
8164 * (unable to be selected and appear differently) use
8165 * elm_gengrid_item_disabled_set() to set this and
8166 * elm_gengrid_item_disabled_get() to get the disabled state.
8168 * Grid cells will only have their selection smart callbacks called
8169 * when firstly getting selected. Any further clicks will do
8170 * nothing, unless you enable the "always select mode", with
8171 * elm_gengrid_always_select_mode_set(), thus making every click to
8172 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
8173 * turn off the ability to select items entirely in the widget and
8174 * they will neither appear selected nor call the selection smart
8177 * Remember that you can create new styles and add your own theme
8178 * augmentation per application with elm_theme_extension_add(). If
8179 * you absolutely must have a specific style that overrides any
8180 * theme the user or system sets up you can use
8181 * elm_theme_overlay_add() to add such a file.
8183 * @section Gengrid_Smart_Events Gengrid smart events
8185 * Smart events that you can add callbacks for are:
8186 * - @c "activated" - The user has double-clicked or pressed
8187 * (enter|return|spacebar) on an item. The @c event_info parameter
8188 * is the gengrid item that was activated.
8189 * - @c "clicked,double" - The user has double-clicked an item.
8190 * The @c event_info parameter is the gengrid item that was double-clicked.
8191 * - @c "longpressed" - This is called when the item is pressed for a certain
8192 * amount of time. By default it's 1 second.
8193 * - @c "selected" - The user has made an item selected. The
8194 * @c event_info parameter is the gengrid item that was selected.
8195 * - @c "unselected" - The user has made an item unselected. The
8196 * @c event_info parameter is the gengrid item that was unselected.
8197 * - @c "realized" - This is called when the item in the gengrid
8198 * has its implementing Evas object instantiated, de facto. @c
8199 * event_info is the gengrid item that was created. The object
8200 * may be deleted at any time, so it is highly advised to the
8201 * caller @b not to use the object pointer returned from
8202 * elm_gengrid_item_object_get(), because it may point to freed
8204 * - @c "unrealized" - This is called when the implementing Evas
8205 * object for this item is deleted. @c event_info is the gengrid
8206 * item that was deleted.
8207 * - @c "changed" - Called when an item is added, removed, resized
8208 * or moved and when the gengrid is resized or gets "horizontal"
8210 * - @c "scroll,anim,start" - This is called when scrolling animation has
8212 * - @c "scroll,anim,stop" - This is called when scrolling animation has
8214 * - @c "drag,start,up" - Called when the item in the gengrid has
8215 * been dragged (not scrolled) up.
8216 * - @c "drag,start,down" - Called when the item in the gengrid has
8217 * been dragged (not scrolled) down.
8218 * - @c "drag,start,left" - Called when the item in the gengrid has
8219 * been dragged (not scrolled) left.
8220 * - @c "drag,start,right" - Called when the item in the gengrid has
8221 * been dragged (not scrolled) right.
8222 * - @c "drag,stop" - Called when the item in the gengrid has
8223 * stopped being dragged.
8224 * - @c "drag" - Called when the item in the gengrid is being
8226 * - @c "scroll" - called when the content has been scrolled
8228 * - @c "scroll,drag,start" - called when dragging the content has
8230 * - @c "scroll,drag,stop" - called when dragging the content has
8232 * - @c "edge,top" - This is called when the gengrid is scrolled until
8234 * - @c "edge,bottom" - This is called when the gengrid is scrolled
8235 * until the bottom edge.
8236 * - @c "edge,left" - This is called when the gengrid is scrolled
8237 * until the left edge.
8238 * - @c "edge,right" - This is called when the gengrid is scrolled
8239 * until the right edge.
8241 * List of gengrid examples:
8242 * @li @ref gengrid_example
8246 * @addtogroup Gengrid
8250 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
8251 #define Elm_Gengrid_Item_Class Elm_Gen_Item_Class
8252 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
8253 #define Elm_Gengrid_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
8254 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
8255 typedef char *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
8256 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. */
8257 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. */
8258 typedef void (*Elm_Gengrid_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
8261 * @struct _Elm_Gengrid_Item_Class
8263 * Gengrid item class definition. See @ref Gengrid_Item_Class for
8266 struct _Elm_Gengrid_Item_Class
8268 const char *item_style;
8269 struct _Elm_Gengrid_Item_Class_Func
8271 Elm_Gengrid_Item_Label_Get_Cb label_get;
8272 Elm_Gengrid_Item_Content_Get_Cb content_get;
8273 Elm_Gengrid_Item_State_Get_Cb state_get;
8274 Elm_Gengrid_Item_Del_Cb del;
8276 }; /**< #Elm_Gengrid_Item_Class member definitions */
8277 #define Elm_Gengrid_Item_Class_Func Elm_Gen_Item_Class_Func
8279 * Add a new gengrid widget to the given parent Elementary
8280 * (container) object
8282 * @param parent The parent object
8283 * @return a new gengrid widget handle or @c NULL, on errors
8285 * This function inserts a new gengrid widget on the canvas.
8287 * @see elm_gengrid_item_size_set()
8288 * @see elm_gengrid_group_item_size_set()
8289 * @see elm_gengrid_horizontal_set()
8290 * @see elm_gengrid_item_append()
8291 * @see elm_gengrid_item_del()
8292 * @see elm_gengrid_clear()
8296 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8299 * Set the size for the items of a given gengrid widget
8301 * @param obj The gengrid object.
8302 * @param w The items' width.
8303 * @param h The items' height;
8305 * A gengrid, after creation, has still no information on the size
8306 * to give to each of its cells. So, you most probably will end up
8307 * with squares one @ref Fingers "finger" wide, the default
8308 * size. Use this function to force a custom size for you items,
8309 * making them as big as you wish.
8311 * @see elm_gengrid_item_size_get()
8315 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8318 * Get the size set for the items of a given gengrid widget
8320 * @param obj The gengrid object.
8321 * @param w Pointer to a variable where to store the items' width.
8322 * @param h Pointer to a variable where to store the items' height.
8324 * @note Use @c NULL pointers on the size values you're not
8325 * interested in: they'll be ignored by the function.
8327 * @see elm_gengrid_item_size_get() for more details
8331 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8334 * Set the size for the group items of a given gengrid widget
8336 * @param obj The gengrid object.
8337 * @param w The group items' width.
8338 * @param h The group items' height;
8340 * A gengrid, after creation, has still no information on the size
8341 * to give to each of its cells. So, you most probably will end up
8342 * with squares one @ref Fingers "finger" wide, the default
8343 * size. Use this function to force a custom size for you group items,
8344 * making them as big as you wish.
8346 * @see elm_gengrid_group_item_size_get()
8350 EAPI void elm_gengrid_group_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8353 * Get the size set for the group items of a given gengrid widget
8355 * @param obj The gengrid object.
8356 * @param w Pointer to a variable where to store the group items' width.
8357 * @param h Pointer to a variable where to store the group items' height.
8359 * @note Use @c NULL pointers on the size values you're not
8360 * interested in: they'll be ignored by the function.
8362 * @see elm_gengrid_group_item_size_get() for more details
8366 EAPI void elm_gengrid_group_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8369 * Set the items grid's alignment within a given gengrid widget
8371 * @param obj The gengrid object.
8372 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8373 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8375 * This sets the alignment of the whole grid of items of a gengrid
8376 * within its given viewport. By default, those values are both
8377 * 0.5, meaning that the gengrid will have its items grid placed
8378 * exactly in the middle of its viewport.
8380 * @note If given alignment values are out of the cited ranges,
8381 * they'll be changed to the nearest boundary values on the valid
8384 * @see elm_gengrid_align_get()
8388 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8391 * Get the items grid's alignment values within a given gengrid
8394 * @param obj The gengrid object.
8395 * @param align_x Pointer to a variable where to store the
8396 * horizontal alignment.
8397 * @param align_y Pointer to a variable where to store the vertical
8400 * @note Use @c NULL pointers on the alignment values you're not
8401 * interested in: they'll be ignored by the function.
8403 * @see elm_gengrid_align_set() for more details
8407 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8410 * Set whether a given gengrid widget is or not able have items
8413 * @param obj The gengrid object
8414 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8415 * @c EINA_FALSE to turn it off
8417 * If a gengrid is set to allow reordering, a click held for more
8418 * than 0.5 over a given item will highlight it specially,
8419 * signalling the gengrid has entered the reordering state. From
8420 * that time on, the user will be able to, while still holding the
8421 * mouse button down, move the item freely in the gengrid's
8422 * viewport, replacing to said item to the locations it goes to.
8423 * The replacements will be animated and, whenever the user
8424 * releases the mouse button, the item being replaced gets a new
8425 * definitive place in the grid.
8427 * @see elm_gengrid_reorder_mode_get()
8431 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8434 * Get whether a given gengrid widget is or not able have items
8437 * @param obj The gengrid object
8438 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8441 * @see elm_gengrid_reorder_mode_set() for more details
8445 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8448 * Append a new item in a given gengrid widget.
8450 * @param obj The gengrid object.
8451 * @param gic The item class for the item.
8452 * @param data The item data.
8453 * @param func Convenience function called when the item is
8455 * @param func_data Data to be passed to @p func.
8456 * @return A handle to the item added or @c NULL, on errors.
8458 * This adds an item to the beginning of the gengrid.
8460 * @see elm_gengrid_item_prepend()
8461 * @see elm_gengrid_item_insert_before()
8462 * @see elm_gengrid_item_insert_after()
8463 * @see elm_gengrid_item_del()
8467 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);
8470 * Prepend a new item in a given gengrid widget.
8472 * @param obj The gengrid object.
8473 * @param gic The item class for the item.
8474 * @param data The item data.
8475 * @param func Convenience function called when the item is
8477 * @param func_data Data to be passed to @p func.
8478 * @return A handle to the item added or @c NULL, on errors.
8480 * This adds an item to the end of the gengrid.
8482 * @see elm_gengrid_item_append()
8483 * @see elm_gengrid_item_insert_before()
8484 * @see elm_gengrid_item_insert_after()
8485 * @see elm_gengrid_item_del()
8489 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);
8492 * Insert an item before another in a gengrid widget
8494 * @param obj The gengrid object.
8495 * @param gic The item class for the item.
8496 * @param data The item data.
8497 * @param relative The item to place this new one before.
8498 * @param func Convenience function called when the item is
8500 * @param func_data Data to be passed to @p func.
8501 * @return A handle to the item added or @c NULL, on errors.
8503 * This inserts an item before another in the gengrid.
8505 * @see elm_gengrid_item_append()
8506 * @see elm_gengrid_item_prepend()
8507 * @see elm_gengrid_item_insert_after()
8508 * @see elm_gengrid_item_del()
8512 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);
8515 * Insert an item after another in a gengrid widget
8517 * @param obj The gengrid object.
8518 * @param gic The item class for the item.
8519 * @param data The item data.
8520 * @param relative The item to place this new one after.
8521 * @param func Convenience function called when the item is
8523 * @param func_data Data to be passed to @p func.
8524 * @return A handle to the item added or @c NULL, on errors.
8526 * This inserts an item after another in the gengrid.
8528 * @see elm_gengrid_item_append()
8529 * @see elm_gengrid_item_prepend()
8530 * @see elm_gengrid_item_insert_after()
8531 * @see elm_gengrid_item_del()
8535 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);
8538 * Insert an item in a gengrid widget using a user-defined sort function.
8540 * @param obj The gengrid object.
8541 * @param gic The item class for the item.
8542 * @param data The item data.
8543 * @param comp User defined comparison function that defines the sort order based on
8544 * Elm_Gen_Item and its data param.
8545 * @param func Convenience function called when the item is selected.
8546 * @param func_data Data to be passed to @p func.
8547 * @return A handle to the item added or @c NULL, on errors.
8549 * This inserts an item in the gengrid based on user defined comparison function.
8551 * @see elm_gengrid_item_append()
8552 * @see elm_gengrid_item_prepend()
8553 * @see elm_gengrid_item_insert_after()
8554 * @see elm_gengrid_item_del()
8555 * @see elm_gengrid_item_direct_sorted_insert()
8559 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);
8562 * Insert an item in a gengrid widget using a user-defined sort function.
8564 * @param obj The gengrid object.
8565 * @param gic The item class for the item.
8566 * @param data The item data.
8567 * @param comp User defined comparison function that defines the sort order based on
8569 * @param func Convenience function called when the item is selected.
8570 * @param func_data Data to be passed to @p func.
8571 * @return A handle to the item added or @c NULL, on errors.
8573 * This inserts an item in the gengrid based on user defined comparison function.
8575 * @see elm_gengrid_item_append()
8576 * @see elm_gengrid_item_prepend()
8577 * @see elm_gengrid_item_insert_after()
8578 * @see elm_gengrid_item_del()
8579 * @see elm_gengrid_item_sorted_insert()
8583 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);
8586 * Set whether items on a given gengrid widget are to get their
8587 * selection callbacks issued for @b every subsequent selection
8588 * click on them or just for the first click.
8590 * @param obj The gengrid object
8591 * @param always_select @c EINA_TRUE to make items "always
8592 * selected", @c EINA_FALSE, otherwise
8594 * By default, grid items will only call their selection callback
8595 * function when firstly getting selected, any subsequent further
8596 * clicks will do nothing. With this call, you make those
8597 * subsequent clicks also to issue the selection callbacks.
8599 * @note <b>Double clicks</b> will @b always be reported on items.
8601 * @see elm_gengrid_always_select_mode_get()
8605 EINA_DEPRECATED EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8608 * Get whether items on a given gengrid widget have their selection
8609 * callbacks issued for @b every subsequent selection click on them
8610 * or just for the first click.
8612 * @param obj The gengrid object.
8613 * @return @c EINA_TRUE if the gengrid items are "always selected",
8614 * @c EINA_FALSE, otherwise
8616 * @see elm_gengrid_always_select_mode_set() for more details
8620 EINA_DEPRECATED EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8623 * Set whether items on a given gengrid widget can be selected or not.
8625 * @param obj The gengrid object
8626 * @param no_select @c EINA_TRUE to make items selectable,
8627 * @c EINA_FALSE otherwise
8629 * This will make items in @p obj selectable or not. In the latter
8630 * case, any user interaction on the gengrid items will neither make
8631 * them appear selected nor them call their selection callback
8634 * @see elm_gengrid_no_select_mode_get()
8638 EINA_DEPRECATED EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8641 * Get whether items on a given gengrid widget can be selected or
8644 * @param obj The gengrid object
8645 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8648 * @see elm_gengrid_no_select_mode_set() for more details
8652 EINA_DEPRECATED EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8655 * Enable or disable multi-selection in a given gengrid widget
8657 * @param obj The gengrid object.
8658 * @param multi @c EINA_TRUE, to enable multi-selection,
8659 * @c EINA_FALSE to disable it.
8661 * Multi-selection is the ability to have @b more than one
8662 * item selected, on a given gengrid, simultaneously. When it is
8663 * enabled, a sequence of clicks on different items will make them
8664 * all selected, progressively. A click on an already selected item
8665 * will unselect it. If interacting via the keyboard,
8666 * multi-selection is enabled while holding the "Shift" key.
8668 * @note By default, multi-selection is @b disabled on gengrids
8670 * @see elm_gengrid_multi_select_get()
8674 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8677 * Get whether multi-selection is enabled or disabled for a given
8680 * @param obj The gengrid object.
8681 * @return @c EINA_TRUE, if multi-selection is enabled, @c
8682 * EINA_FALSE otherwise
8684 * @see elm_gengrid_multi_select_set() for more details
8688 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8691 * Enable or disable bouncing effect for a given gengrid widget
8693 * @param obj The gengrid object
8694 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8695 * @c EINA_FALSE to disable it
8696 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8697 * @c EINA_FALSE to disable it
8699 * The bouncing effect occurs whenever one reaches the gengrid's
8700 * edge's while panning it -- it will scroll past its limits a
8701 * little bit and return to the edge again, in a animated for,
8704 * @note By default, gengrids have bouncing enabled on both axis
8706 * @see elm_gengrid_bounce_get()
8710 EINA_DEPRECATED EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8713 * Get whether bouncing effects are enabled or disabled, for a
8714 * given gengrid widget, on each axis
8716 * @param obj The gengrid object
8717 * @param h_bounce Pointer to a variable where to store the
8718 * horizontal bouncing flag.
8719 * @param v_bounce Pointer to a variable where to store the
8720 * vertical bouncing flag.
8722 * @see elm_gengrid_bounce_set() for more details
8726 EINA_DEPRECATED EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8729 * Set a given gengrid widget's scrolling page size, relative to
8730 * its viewport size.
8732 * @param obj The gengrid object
8733 * @param h_pagerel The horizontal page (relative) size
8734 * @param v_pagerel The vertical page (relative) size
8736 * The gengrid's scroller is capable of binding scrolling by the
8737 * user to "pages". It means that, while scrolling and, specially
8738 * after releasing the mouse button, the grid will @b snap to the
8739 * nearest displaying page's area. When page sizes are set, the
8740 * grid's continuous content area is split into (equal) page sized
8743 * This function sets the size of a page <b>relatively to the
8744 * viewport dimensions</b> of the gengrid, for each axis. A value
8745 * @c 1.0 means "the exact viewport's size", in that axis, while @c
8746 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8747 * a viewport". Sane usable values are, than, between @c 0.0 and @c
8748 * 1.0. Values beyond those will make it behave behave
8749 * inconsistently. If you only want one axis to snap to pages, use
8750 * the value @c 0.0 for the other one.
8752 * There is a function setting page size values in @b absolute
8753 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8754 * is mutually exclusive to this one.
8756 * @see elm_gengrid_page_relative_get()
8760 EINA_DEPRECATED EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8763 * Get a given gengrid widget's scrolling page size, relative to
8764 * its viewport size.
8766 * @param obj The gengrid object
8767 * @param h_pagerel Pointer to a variable where to store the
8768 * horizontal page (relative) size
8769 * @param v_pagerel Pointer to a variable where to store the
8770 * vertical page (relative) size
8772 * @see elm_gengrid_page_relative_set() for more details
8776 EINA_DEPRECATED EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8779 * Set a given gengrid widget's scrolling page size
8781 * @param obj The gengrid object
8782 * @param h_pagerel The horizontal page size, in pixels
8783 * @param v_pagerel The vertical page size, in pixels
8785 * The gengrid's scroller is capable of binding scrolling by the
8786 * user to "pages". It means that, while scrolling and, specially
8787 * after releasing the mouse button, the grid will @b snap to the
8788 * nearest displaying page's area. When page sizes are set, the
8789 * grid's continuous content area is split into (equal) page sized
8792 * This function sets the size of a page of the gengrid, in pixels,
8793 * for each axis. Sane usable values are, between @c 0 and the
8794 * dimensions of @p obj, for each axis. Values beyond those will
8795 * make it behave behave inconsistently. If you only want one axis
8796 * to snap to pages, use the value @c 0 for the other one.
8798 * There is a function setting page size values in @b relative
8799 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8800 * use is mutually exclusive to this one.
8804 EINA_DEPRECATED EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8807 * @brief Get gengrid current page number.
8809 * @param obj The gengrid object
8810 * @param h_pagenumber The horizontal page number
8811 * @param v_pagenumber The vertical page number
8813 * The page number starts from 0. 0 is the first page.
8814 * Current page means the page which meet the top-left of the viewport.
8815 * If there are two or more pages in the viewport, it returns the number of page
8816 * which meet the top-left of the viewport.
8818 * @see elm_gengrid_last_page_get()
8819 * @see elm_gengrid_page_show()
8820 * @see elm_gengrid_page_brint_in()
8822 EINA_DEPRECATED EAPI void elm_gengrid_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8825 * @brief Get scroll last page number.
8827 * @param obj The gengrid object
8828 * @param h_pagenumber The horizontal page number
8829 * @param v_pagenumber The vertical page number
8831 * The page number starts from 0. 0 is the first page.
8832 * This returns the last page number among the pages.
8834 * @see elm_gengrid_current_page_get()
8835 * @see elm_gengrid_page_show()
8836 * @see elm_gengrid_page_brint_in()
8838 EINA_DEPRECATED EAPI void elm_gengrid_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8841 * Show a specific virtual region within the gengrid content object by page number.
8843 * @param obj The gengrid object
8844 * @param h_pagenumber The horizontal page number
8845 * @param v_pagenumber The vertical page number
8847 * 0, 0 of the indicated page is located at the top-left of the viewport.
8848 * This will jump to the page directly without animation.
8853 * sc = elm_gengrid_add(win);
8854 * elm_gengrid_content_set(sc, content);
8855 * elm_gengrid_page_relative_set(sc, 1, 0);
8856 * elm_gengrid_current_page_get(sc, &h_page, &v_page);
8857 * elm_gengrid_page_show(sc, h_page + 1, v_page);
8860 * @see elm_gengrid_page_bring_in()
8862 EINA_DEPRECATED EAPI void elm_gengrid_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8865 * Show a specific virtual region within the gengrid content object by page number.
8867 * @param obj The gengrid object
8868 * @param h_pagenumber The horizontal page number
8869 * @param v_pagenumber The vertical page number
8871 * 0, 0 of the indicated page is located at the top-left of the viewport.
8872 * This will slide to the page with animation.
8877 * sc = elm_gengrid_add(win);
8878 * elm_gengrid_content_set(sc, content);
8879 * elm_gengrid_page_relative_set(sc, 1, 0);
8880 * elm_gengrid_last_page_get(sc, &h_page, &v_page);
8881 * elm_gengrid_page_bring_in(sc, h_page, v_page);
8884 * @see elm_gengrid_page_show()
8886 EINA_DEPRECATED EAPI void elm_gengrid_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8889 * Set the direction in which a given gengrid widget will expand while
8890 * placing its items.
8892 * @param obj The gengrid object.
8893 * @param setting @c EINA_TRUE to make the gengrid expand
8894 * horizontally, @c EINA_FALSE to expand vertically.
8896 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8897 * in @b columns, from top to bottom and, when the space for a
8898 * column is filled, another one is started on the right, thus
8899 * expanding the grid horizontally. When in "vertical mode"
8900 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8901 * to right and, when the space for a row is filled, another one is
8902 * started below, thus expanding the grid vertically.
8904 * @see elm_gengrid_horizontal_get()
8908 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8911 * Get for what direction a given gengrid widget will expand while
8912 * placing its items.
8914 * @param obj The gengrid object.
8915 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8916 * @c EINA_FALSE if it's set to expand vertically.
8918 * @see elm_gengrid_horizontal_set() for more detais
8922 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8925 * Get the first item in a given gengrid widget
8927 * @param obj The gengrid object
8928 * @return The first item's handle or @c NULL, if there are no
8929 * items in @p obj (and on errors)
8931 * This returns the first item in the @p obj's internal list of
8934 * @see elm_gengrid_last_item_get()
8938 EINA_DEPRECATED EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8941 * Get the last item in a given gengrid widget
8943 * @param obj The gengrid object
8944 * @return The last item's handle or @c NULL, if there are no
8945 * items in @p obj (and on errors)
8947 * This returns the last item in the @p obj's internal list of
8950 * @see elm_gengrid_first_item_get()
8954 EINA_DEPRECATED EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8957 * Get the @b next item in a gengrid widget's internal list of items,
8958 * given a handle to one of those items.
8960 * @param item The gengrid item to fetch next from
8961 * @return The item after @p item, or @c NULL if there's none (and
8964 * This returns the item placed after the @p item, on the container
8967 * @see elm_gengrid_item_prev_get()
8971 EINA_DEPRECATED EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8974 * Get the @b previous item in a gengrid widget's internal list of items,
8975 * given a handle to one of those items.
8977 * @param item The gengrid item to fetch previous from
8978 * @return The item before @p item, or @c NULL if there's none (and
8981 * This returns the item placed before the @p item, on the container
8984 * @see elm_gengrid_item_next_get()
8988 EINA_DEPRECATED EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8991 * Get the gengrid object's handle which contains a given gengrid
8994 * @param item The item to fetch the container from
8995 * @return The gengrid (parent) object
8997 * This returns the gengrid object itself that an item belongs to.
9001 EINA_DEPRECATED EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9004 * Remove a gengrid item from its parent, deleting it.
9006 * @param item The item to be removed.
9007 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
9009 * @see elm_gengrid_clear(), to remove all items in a gengrid at
9014 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9017 * Update the contents of a given gengrid item
9019 * @param item The gengrid item
9021 * This updates an item by calling all the item class functions
9022 * again to get the contents, labels and states. Use this when the
9023 * original item data has changed and you want the changes to be
9028 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9031 * Get the Gengrid Item class for the given Gengrid Item.
9033 * @param item The gengrid item
9035 * This returns the Gengrid_Item_Class for the given item. It can be used to examine
9036 * the function pointers and item_style.
9040 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9043 * Get the Gengrid Item class for the given Gengrid Item.
9045 * This sets the Gengrid_Item_Class for the given item. It can be used to examine
9046 * the function pointers and item_style.
9048 * @param item The gengrid item
9049 * @param gic The gengrid item class describing the function pointers and the item style.
9053 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
9056 * Return the data associated to a given gengrid item
9058 * @param item The gengrid item.
9059 * @return the data associated with this item.
9061 * This returns the @c data value passed on the
9062 * elm_gengrid_item_append() and related item addition calls.
9064 * @see elm_gengrid_item_append()
9065 * @see elm_gengrid_item_data_set()
9069 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9072 * Set the data associated with a given gengrid item
9074 * @param item The gengrid item
9075 * @param data The data pointer to set on it
9077 * This @b overrides the @c data value passed on the
9078 * elm_gengrid_item_append() and related item addition calls. This
9079 * function @b won't call elm_gengrid_item_update() automatically,
9080 * so you'd issue it afterwards if you want to have the item
9081 * updated to reflect the new data.
9083 * @see elm_gengrid_item_data_get()
9084 * @see elm_gengrid_item_update()
9088 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
9091 * Get a given gengrid item's position, relative to the whole
9092 * gengrid's grid area.
9094 * @param item The Gengrid item.
9095 * @param x Pointer to variable to store the item's <b>row number</b>.
9096 * @param y Pointer to variable to store the item's <b>column number</b>.
9098 * This returns the "logical" position of the item within the
9099 * gengrid. For example, @c (0, 1) would stand for first row,
9104 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
9107 * Set whether a given gengrid item is selected or not
9109 * @param item The gengrid item
9110 * @param selected Use @c EINA_TRUE, to make it selected, @c
9111 * EINA_FALSE to make it unselected
9113 * This sets the selected state of an item. If multi-selection is
9114 * not enabled on the containing gengrid and @p selected is @c
9115 * EINA_TRUE, any other previously selected items will get
9116 * unselected in favor of this new one.
9118 * @see elm_gengrid_item_selected_get()
9122 EINA_DEPRECATED EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
9125 * Get whether a given gengrid item is selected or not
9127 * @param item The gengrid item
9128 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
9130 * This API returns EINA_TRUE for all the items selected in multi-select mode as well.
9132 * @see elm_gengrid_item_selected_set() for more details
9136 EINA_DEPRECATED EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9139 * Get the real Evas object created to implement the view of a
9140 * given gengrid item
9142 * @param item The gengrid item.
9143 * @return the Evas object implementing this item's view.
9145 * This returns the actual Evas object used to implement the
9146 * specified gengrid item's view. This may be @c NULL, as it may
9147 * not have been created or may have been deleted, at any time, by
9148 * the gengrid. <b>Do not modify this object</b> (move, resize,
9149 * show, hide, etc.), as the gengrid is controlling it. This
9150 * function is for querying, emitting custom signals or hooking
9151 * lower level callbacks for events on that object. Do not delete
9152 * this object under any circumstances.
9154 * @see elm_gengrid_item_data_get()
9158 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9161 * Show the portion of a gengrid's internal grid containing a given
9162 * item, @b immediately.
9164 * @param item The item to display
9166 * This causes gengrid to @b redraw its viewport's contents to the
9167 * region contining the given @p item item, if it is not fully
9170 * @see elm_gengrid_item_bring_in()
9174 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9177 * Animatedly bring in, to the visible area of a gengrid, a given
9180 * @param item The gengrid item to display
9182 * This causes gengrid to jump to the given @p item and show
9183 * it (by scrolling), if it is not fully visible. This will use
9184 * animation to do so and take a period of time to complete.
9186 * @see elm_gengrid_item_show()
9190 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9193 * Set whether a given gengrid item is disabled or not.
9195 * @param item The gengrid item
9196 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
9197 * to enable it back.
9199 * A disabled item cannot be selected or unselected. It will also
9200 * change its appearance, to signal the user it's disabled.
9202 * @see elm_gengrid_item_disabled_get()
9206 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
9209 * Get whether a given gengrid item is disabled or not.
9211 * @param item The gengrid item
9212 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
9215 * @see elm_gengrid_item_disabled_set() for more details
9219 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9222 * Set the text to be shown in a given gengrid item's tooltips.
9224 * @param item The gengrid item
9225 * @param text The text to set in the content
9227 * This call will setup the text to be used as tooltip to that item
9228 * (analogous to elm_object_tooltip_text_set(), but being item
9229 * tooltips with higher precedence than object tooltips). It can
9230 * have only one tooltip at a time, so any previous tooltip data
9235 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
9238 * Set the content to be shown in a given gengrid item's tooltip
9240 * @param item The gengrid item.
9241 * @param func The function returning the tooltip contents.
9242 * @param data What to provide to @a func as callback data/context.
9243 * @param del_cb Called when data is not needed anymore, either when
9244 * another callback replaces @p func, the tooltip is unset with
9245 * elm_gengrid_item_tooltip_unset() or the owner @p item
9246 * dies. This callback receives as its first parameter the
9247 * given @p data, being @c event_info the item handle.
9249 * This call will setup the tooltip's contents to @p item
9250 * (analogous to elm_object_tooltip_content_cb_set(), but being
9251 * item tooltips with higher precedence than object tooltips). It
9252 * can have only one tooltip at a time, so any previous tooltip
9253 * content will get removed. @p func (with @p data) will be called
9254 * every time Elementary needs to show the tooltip and it should
9255 * return a valid Evas object, which will be fully managed by the
9256 * tooltip system, getting deleted when the tooltip is gone.
9260 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);
9263 * Unset a tooltip from a given gengrid item
9265 * @param item gengrid item to remove a previously set tooltip from.
9267 * This call removes any tooltip set on @p item. The callback
9268 * provided as @c del_cb to
9269 * elm_gengrid_item_tooltip_content_cb_set() will be called to
9270 * notify it is not used anymore (and have resources cleaned, if
9273 * @see elm_gengrid_item_tooltip_content_cb_set()
9277 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9280 * Set a different @b style for a given gengrid item's tooltip.
9282 * @param item gengrid item with tooltip set
9283 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
9284 * "default", @c "transparent", etc)
9286 * Tooltips can have <b>alternate styles</b> to be displayed on,
9287 * which are defined by the theme set on Elementary. This function
9288 * works analogously as elm_object_tooltip_style_set(), but here
9289 * applied only to gengrid item objects. The default style for
9290 * tooltips is @c "default".
9292 * @note before you set a style you should define a tooltip with
9293 * elm_gengrid_item_tooltip_content_cb_set() or
9294 * elm_gengrid_item_tooltip_text_set()
9296 * @see elm_gengrid_item_tooltip_style_get()
9300 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9303 * Get the style set a given gengrid item's tooltip.
9305 * @param item gengrid item with tooltip already set on.
9306 * @return style the theme style in use, which defaults to
9307 * "default". If the object does not have a tooltip set,
9308 * then @c NULL is returned.
9310 * @see elm_gengrid_item_tooltip_style_set() for more details
9314 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9316 * @brief Disable size restrictions on an object's tooltip
9317 * @param item The tooltip's anchor object
9318 * @param disable If EINA_TRUE, size restrictions are disabled
9319 * @return EINA_FALSE on failure, EINA_TRUE on success
9321 * This function allows a tooltip to expand beyond its parant window's canvas.
9322 * It will instead be limited only by the size of the display.
9324 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
9326 * @brief Retrieve size restriction state of an object's tooltip
9327 * @param item The tooltip's anchor object
9328 * @return If EINA_TRUE, size restrictions are disabled
9330 * This function returns whether a tooltip is allowed to expand beyond
9331 * its parant window's canvas.
9332 * It will instead be limited only by the size of the display.
9334 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
9336 * Set the type of mouse pointer/cursor decoration to be shown,
9337 * when the mouse pointer is over the given gengrid widget item
9339 * @param item gengrid item to customize cursor on
9340 * @param cursor the cursor type's name
9342 * This function works analogously as elm_object_cursor_set(), but
9343 * here the cursor's changing area is restricted to the item's
9344 * area, and not the whole widget's. Note that that item cursors
9345 * have precedence over widget cursors, so that a mouse over @p
9346 * item will always show cursor @p type.
9348 * If this function is called twice for an object, a previously set
9349 * cursor will be unset on the second call.
9351 * @see elm_object_cursor_set()
9352 * @see elm_gengrid_item_cursor_get()
9353 * @see elm_gengrid_item_cursor_unset()
9357 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
9360 * Get the type of mouse pointer/cursor decoration set to be shown,
9361 * when the mouse pointer is over the given gengrid widget item
9363 * @param item gengrid item with custom cursor set
9364 * @return the cursor type's name or @c NULL, if no custom cursors
9365 * were set to @p item (and on errors)
9367 * @see elm_object_cursor_get()
9368 * @see elm_gengrid_item_cursor_set() for more details
9369 * @see elm_gengrid_item_cursor_unset()
9373 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9376 * Unset any custom mouse pointer/cursor decoration set to be
9377 * shown, when the mouse pointer is over the given gengrid widget
9378 * item, thus making it show the @b default cursor again.
9380 * @param item a gengrid item
9382 * Use this call to undo any custom settings on this item's cursor
9383 * decoration, bringing it back to defaults (no custom style set).
9385 * @see elm_object_cursor_unset()
9386 * @see elm_gengrid_item_cursor_set() for more details
9390 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9393 * Set a different @b style for a given custom cursor set for a
9396 * @param item gengrid item with custom cursor set
9397 * @param style the <b>theme style</b> to use (e.g. @c "default",
9398 * @c "transparent", etc)
9400 * This function only makes sense when one is using custom mouse
9401 * cursor decorations <b>defined in a theme file</b> , which can
9402 * have, given a cursor name/type, <b>alternate styles</b> on
9403 * it. It works analogously as elm_object_cursor_style_set(), but
9404 * here applied only to gengrid item objects.
9406 * @warning Before you set a cursor style you should have defined a
9407 * custom cursor previously on the item, with
9408 * elm_gengrid_item_cursor_set()
9410 * @see elm_gengrid_item_cursor_engine_only_set()
9411 * @see elm_gengrid_item_cursor_style_get()
9415 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9418 * Get the current @b style set for a given gengrid item's custom
9421 * @param item gengrid item with custom cursor set.
9422 * @return style the cursor style in use. If the object does not
9423 * have a cursor set, then @c NULL is returned.
9425 * @see elm_gengrid_item_cursor_style_set() for more details
9429 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9432 * Set if the (custom) cursor for a given gengrid item should be
9433 * searched in its theme, also, or should only rely on the
9436 * @param item item with custom (custom) cursor already set on
9437 * @param engine_only Use @c EINA_TRUE to have cursors looked for
9438 * only on those provided by the rendering engine, @c EINA_FALSE to
9439 * have them searched on the widget's theme, as well.
9441 * @note This call is of use only if you've set a custom cursor
9442 * for gengrid items, with elm_gengrid_item_cursor_set().
9444 * @note By default, cursors will only be looked for between those
9445 * provided by the rendering engine.
9449 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9452 * Get if the (custom) cursor for a given gengrid item is being
9453 * searched in its theme, also, or is only relying on the rendering
9456 * @param item a gengrid item
9457 * @return @c EINA_TRUE, if cursors are being looked for only on
9458 * those provided by the rendering engine, @c EINA_FALSE if they
9459 * are being searched on the widget's theme, as well.
9461 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
9465 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9468 * Remove all items from a given gengrid widget
9470 * @param obj The gengrid object.
9472 * This removes (and deletes) all items in @p obj, leaving it
9475 * @see elm_gengrid_item_del(), to remove just one item.
9479 EINA_DEPRECATED EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9482 * Get the selected item in a given gengrid widget
9484 * @param obj The gengrid object.
9485 * @return The selected item's handleor @c NULL, if none is
9486 * selected at the moment (and on errors)
9488 * This returns the selected item in @p obj. If multi selection is
9489 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
9490 * the first item in the list is selected, which might not be very
9491 * useful. For that case, see elm_gengrid_selected_items_get().
9495 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9498 * Get <b>a list</b> of selected items in a given gengrid
9500 * @param obj The gengrid object.
9501 * @return The list of selected items or @c NULL, if none is
9502 * selected at the moment (and on errors)
9504 * This returns a list of the selected items, in the order that
9505 * they appear in the grid. This list is only valid as long as no
9506 * more items are selected or unselected (or unselected implictly
9507 * by deletion). The list contains #Elm_Gengrid_Item pointers as
9510 * @see elm_gengrid_selected_item_get()
9514 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9521 * @defgroup Clock Clock
9523 * @image html img/widget/clock/preview-00.png
9524 * @image latex img/widget/clock/preview-00.eps
9526 * This is a @b digital clock widget. In its default theme, it has a
9527 * vintage "flipping numbers clock" appearance, which will animate
9528 * sheets of individual algarisms individually as time goes by.
9530 * A newly created clock will fetch system's time (already
9531 * considering local time adjustments) to start with, and will tick
9532 * accondingly. It may or may not show seconds.
9534 * Clocks have an @b edition mode. When in it, the sheets will
9535 * display extra arrow indications on the top and bottom and the
9536 * user may click on them to raise or lower the time values. After
9537 * it's told to exit edition mode, it will keep ticking with that
9538 * new time set (it keeps the difference from local time).
9540 * Also, when under edition mode, user clicks on the cited arrows
9541 * which are @b held for some time will make the clock to flip the
9542 * sheet, thus editing the time, continuosly and automatically for
9543 * the user. The interval between sheet flips will keep growing in
9544 * time, so that it helps the user to reach a time which is distant
9547 * The time display is, by default, in military mode (24h), but an
9548 * am/pm indicator may be optionally shown, too, when it will
9551 * Smart callbacks one can register to:
9552 * - "changed" - the clock's user changed the time
9554 * Here is an example on its usage:
9555 * @li @ref clock_example
9564 * Identifiers for which clock digits should be editable, when a
9565 * clock widget is in edition mode. Values may be ORed together to
9566 * make a mask, naturally.
9568 * @see elm_clock_edit_set()
9569 * @see elm_clock_digit_edit_set()
9571 typedef enum _Elm_Clock_Digedit
9573 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9574 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9575 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
9576 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9577 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
9578 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9579 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
9580 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
9581 } Elm_Clock_Digedit;
9584 * Add a new clock widget to the given parent Elementary
9585 * (container) object
9587 * @param parent The parent object
9588 * @return a new clock widget handle or @c NULL, on errors
9590 * This function inserts a new clock widget on the canvas.
9594 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9597 * Set a clock widget's time, programmatically
9599 * @param obj The clock widget object
9600 * @param hrs The hours to set
9601 * @param min The minutes to set
9602 * @param sec The secondes to set
9604 * This function updates the time that is showed by the clock
9607 * Values @b must be set within the following ranges:
9608 * - 0 - 23, for hours
9609 * - 0 - 59, for minutes
9610 * - 0 - 59, for seconds,
9612 * even if the clock is not in "military" mode.
9614 * @warning The behavior for values set out of those ranges is @b
9619 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9622 * Get a clock widget's time values
9624 * @param obj The clock object
9625 * @param[out] hrs Pointer to the variable to get the hours value
9626 * @param[out] min Pointer to the variable to get the minutes value
9627 * @param[out] sec Pointer to the variable to get the seconds value
9629 * This function gets the time set for @p obj, returning
9630 * it on the variables passed as the arguments to function
9632 * @note Use @c NULL pointers on the time values you're not
9633 * interested in: they'll be ignored by the function.
9637 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9640 * Set whether a given clock widget is under <b>edition mode</b> or
9641 * under (default) displaying-only mode.
9643 * @param obj The clock object
9644 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9645 * put it back to "displaying only" mode
9647 * This function makes a clock's time to be editable or not <b>by
9648 * user interaction</b>. When in edition mode, clocks @b stop
9649 * ticking, until one brings them back to canonical mode. The
9650 * elm_clock_digit_edit_set() function will influence which digits
9651 * of the clock will be editable. By default, all of them will be
9652 * (#ELM_CLOCK_NONE).
9654 * @note am/pm sheets, if being shown, will @b always be editable
9655 * under edition mode.
9657 * @see elm_clock_edit_get()
9661 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9664 * Retrieve whether a given clock widget is under <b>edition
9665 * mode</b> or under (default) displaying-only mode.
9667 * @param obj The clock object
9668 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9671 * This function retrieves whether the clock's time can be edited
9672 * or not by user interaction.
9674 * @see elm_clock_edit_set() for more details
9678 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9681 * Set what digits of the given clock widget should be editable
9682 * when in edition mode.
9684 * @param obj The clock object
9685 * @param digedit Bit mask indicating the digits to be editable
9686 * (values in #Elm_Clock_Digedit).
9688 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9689 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9692 * @see elm_clock_digit_edit_get()
9696 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9699 * Retrieve what digits of the given clock widget should be
9700 * editable when in edition mode.
9702 * @param obj The clock object
9703 * @return Bit mask indicating the digits to be editable
9704 * (values in #Elm_Clock_Digedit).
9706 * @see elm_clock_digit_edit_set() for more details
9710 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9713 * Set if the given clock widget must show hours in military or
9716 * @param obj The clock object
9717 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9720 * This function sets if the clock must show hours in military or
9721 * am/pm mode. In some countries like Brazil the military mode
9722 * (00-24h-format) is used, in opposition to the USA, where the
9723 * am/pm mode is more commonly used.
9725 * @see elm_clock_show_am_pm_get()
9729 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9732 * Get if the given clock widget shows hours in military or am/pm
9735 * @param obj The clock object
9736 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9739 * This function gets if the clock shows hours in military or am/pm
9742 * @see elm_clock_show_am_pm_set() for more details
9746 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9749 * Set if the given clock widget must show time with seconds or not
9751 * @param obj The clock object
9752 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9754 * This function sets if the given clock must show or not elapsed
9755 * seconds. By default, they are @b not shown.
9757 * @see elm_clock_show_seconds_get()
9761 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9764 * Get whether the given clock widget is showing time with seconds
9767 * @param obj The clock object
9768 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9770 * This function gets whether @p obj is showing or not the elapsed
9773 * @see elm_clock_show_seconds_set()
9777 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9780 * Set the interval on time updates for an user mouse button hold
9781 * on clock widgets' time edition.
9783 * @param obj The clock object
9784 * @param interval The (first) interval value in seconds
9786 * This interval value is @b decreased while the user holds the
9787 * mouse pointer either incrementing or decrementing a given the
9788 * clock digit's value.
9790 * This helps the user to get to a given time distant from the
9791 * current one easier/faster, as it will start to flip quicker and
9792 * quicker on mouse button holds.
9794 * The calculation for the next flip interval value, starting from
9795 * the one set with this call, is the previous interval divided by
9796 * 1.05, so it decreases a little bit.
9798 * The default starting interval value for automatic flips is
9801 * @see elm_clock_interval_get()
9805 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9808 * Get the interval on time updates for an user mouse button hold
9809 * on clock widgets' time edition.
9811 * @param obj The clock object
9812 * @return The (first) interval value, in seconds, set on it
9814 * @see elm_clock_interval_set() for more details
9818 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9825 * @defgroup Layout Layout
9827 * @image html img/widget/layout/preview-00.png
9828 * @image latex img/widget/layout/preview-00.eps width=\textwidth
9830 * @image html img/layout-predefined.png
9831 * @image latex img/layout-predefined.eps width=\textwidth
9833 * This is a container widget that takes a standard Edje design file and
9834 * wraps it very thinly in a widget.
9836 * An Edje design (theme) file has a very wide range of possibilities to
9837 * describe the behavior of elements added to the Layout. Check out the Edje
9838 * documentation and the EDC reference to get more information about what can
9839 * be done with Edje.
9841 * Just like @ref List, @ref Box, and other container widgets, any
9842 * object added to the Layout will become its child, meaning that it will be
9843 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9845 * The Layout widget can contain as many Contents, Boxes or Tables as
9846 * described in its theme file. For instance, objects can be added to
9847 * different Tables by specifying the respective Table part names. The same
9848 * is valid for Content and Box.
9850 * The objects added as child of the Layout will behave as described in the
9851 * part description where they were added. There are 3 possible types of
9852 * parts where a child can be added:
9854 * @section secContent Content (SWALLOW part)
9856 * Only one object can be added to the @c SWALLOW part (but you still can
9857 * have many @c SWALLOW parts and one object on each of them). Use the @c
9858 * elm_object_content_set/get/unset functions to set, retrieve and unset
9859 * objects as content of the @c SWALLOW. After being set to this part, the
9860 * object size, position, visibility, clipping and other description
9861 * properties will be totally controled by the description of the given part
9862 * (inside the Edje theme file).
9864 * One can use @c evas_object_size_hint_* functions on the child to have some
9865 * kind of control over its behavior, but the resulting behavior will still
9866 * depend heavily on the @c SWALLOW part description.
9868 * The Edje theme also can change the part description, based on signals or
9869 * scripts running inside the theme. This change can also be animated. All of
9870 * this will affect the child object set as content accordingly. The object
9871 * size will be changed if the part size is changed, it will animate move if
9872 * the part is moving, and so on.
9874 * The following picture demonstrates a Layout widget with a child object
9875 * added to its @c SWALLOW:
9877 * @image html layout_swallow.png
9878 * @image latex layout_swallow.eps width=\textwidth
9880 * @section secBox Box (BOX part)
9882 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9883 * allows one to add objects to the box and have them distributed along its
9884 * area, accordingly to the specified @a layout property (now by @a layout we
9885 * mean the chosen layouting design of the Box, not the Layout widget
9888 * A similar effect for having a box with its position, size and other things
9889 * controled by the Layout theme would be to create an Elementary @ref Box
9890 * widget and add it as a Content in the @c SWALLOW part.
9892 * The main difference of using the Layout Box is that its behavior, the box
9893 * properties like layouting format, padding, align, etc. will be all
9894 * controled by the theme. This means, for example, that a signal could be
9895 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9896 * handled the signal by changing the box padding, or align, or both. Using
9897 * the Elementary @ref Box widget is not necessarily harder or easier, it
9898 * just depends on the circunstances and requirements.
9900 * The Layout Box can be used through the @c elm_layout_box_* set of
9903 * The following picture demonstrates a Layout widget with many child objects
9904 * added to its @c BOX part:
9906 * @image html layout_box.png
9907 * @image latex layout_box.eps width=\textwidth
9909 * @section secTable Table (TABLE part)
9911 * Just like the @ref secBox, the Layout Table is very similar to the
9912 * Elementary @ref Table widget. It allows one to add objects to the Table
9913 * specifying the row and column where the object should be added, and any
9914 * column or row span if necessary.
9916 * Again, we could have this design by adding a @ref Table widget to the @c
9917 * SWALLOW part using elm_object_content_part_set(). The same difference happens
9918 * here when choosing to use the Layout Table (a @c TABLE part) instead of
9919 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9921 * The Layout Table can be used through the @c elm_layout_table_* set of
9924 * The following picture demonstrates a Layout widget with many child objects
9925 * added to its @c TABLE part:
9927 * @image html layout_table.png
9928 * @image latex layout_table.eps width=\textwidth
9930 * @section secPredef Predefined Layouts
9932 * Another interesting thing about the Layout widget is that it offers some
9933 * predefined themes that come with the default Elementary theme. These
9934 * themes can be set by the call elm_layout_theme_set(), and provide some
9935 * basic functionality depending on the theme used.
9937 * Most of them already send some signals, some already provide a toolbar or
9938 * back and next buttons.
9940 * These are available predefined theme layouts. All of them have class = @c
9941 * layout, group = @c application, and style = one of the following options:
9943 * @li @c toolbar-content - application with toolbar and main content area
9944 * @li @c toolbar-content-back - application with toolbar and main content
9945 * area with a back button and title area
9946 * @li @c toolbar-content-back-next - application with toolbar and main
9947 * content area with a back and next buttons and title area
9948 * @li @c content-back - application with a main content area with a back
9949 * button and title area
9950 * @li @c content-back-next - application with a main content area with a
9951 * back and next buttons and title area
9952 * @li @c toolbar-vbox - application with toolbar and main content area as a
9954 * @li @c toolbar-table - application with toolbar and main content area as a
9957 * @section secExamples Examples
9959 * Some examples of the Layout widget can be found here:
9960 * @li @ref layout_example_01
9961 * @li @ref layout_example_02
9962 * @li @ref layout_example_03
9963 * @li @ref layout_example_edc
9968 * Add a new layout to the parent
9970 * @param parent The parent object
9971 * @return The new object or NULL if it cannot be created
9973 * @see elm_layout_file_set()
9974 * @see elm_layout_theme_set()
9978 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9980 * Set the file that will be used as layout
9982 * @param obj The layout object
9983 * @param file The path to file (edj) that will be used as layout
9984 * @param group The group that the layout belongs in edje file
9986 * @return (1 = success, 0 = error)
9990 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9992 * Set the edje group from the elementary theme that will be used as layout
9994 * @param obj The layout object
9995 * @param clas the clas of the group
9996 * @param group the group
9997 * @param style the style to used
9999 * @return (1 = success, 0 = error)
10003 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
10005 * Set the layout content.
10007 * @param obj The layout object
10008 * @param swallow The swallow part name in the edje file
10009 * @param content The child that will be added in this layout object
10011 * Once the content object is set, a previously set one will be deleted.
10012 * If you want to keep that old content object, use the
10013 * elm_object_content_part_unset() function.
10015 * @note In an Edje theme, the part used as a content container is called @c
10016 * SWALLOW. This is why the parameter name is called @p swallow, but it is
10017 * expected to be a part name just like the second parameter of
10018 * elm_layout_box_append().
10020 * @see elm_layout_box_append()
10021 * @see elm_object_content_part_get()
10022 * @see elm_object_content_part_unset()
10024 * @deprecated use elm_object_content_part_set() instead
10028 EINA_DEPRECATED EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10030 * Get the child object in the given content part.
10032 * @param obj The layout object
10033 * @param swallow The SWALLOW part to get its content
10035 * @return The swallowed object or NULL if none or an error occurred
10037 * @deprecated use elm_object_content_part_get() instead
10041 EINA_DEPRECATED EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10043 * Unset the layout content.
10045 * @param obj The layout object
10046 * @param swallow The swallow part name in the edje file
10047 * @return The content that was being used
10049 * Unparent and return the content object which was set for this part.
10051 * @deprecated use elm_object_content_part_unset() instead
10055 EINA_DEPRECATED EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10057 * Set the text of the given part
10059 * @param obj The layout object
10060 * @param part The TEXT part where to set the text
10061 * @param text The text to set
10064 * @deprecated use elm_object_text_part_set() instead.
10066 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
10068 * Get the text set in the given part
10070 * @param obj The layout object
10071 * @param part The TEXT part to retrieve the text off
10073 * @return The text set in @p part
10076 * @deprecated use elm_object_text_part_get() instead.
10078 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
10080 * Append child to layout box part.
10082 * @param obj the layout object
10083 * @param part the box part to which the object will be appended.
10084 * @param child the child object to append to box.
10086 * Once the object is appended, it will become child of the layout. Its
10087 * lifetime will be bound to the layout, whenever the layout dies the child
10088 * will be deleted automatically. One should use elm_layout_box_remove() to
10089 * make this layout forget about the object.
10091 * @see elm_layout_box_prepend()
10092 * @see elm_layout_box_insert_before()
10093 * @see elm_layout_box_insert_at()
10094 * @see elm_layout_box_remove()
10098 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10100 * Prepend child to layout box part.
10102 * @param obj the layout object
10103 * @param part the box part to prepend.
10104 * @param child the child object to prepend to box.
10106 * Once the object is prepended, it will become child of the layout. Its
10107 * lifetime will be bound to the layout, whenever the layout dies the child
10108 * will be deleted automatically. One should use elm_layout_box_remove() to
10109 * make this layout forget about the object.
10111 * @see elm_layout_box_append()
10112 * @see elm_layout_box_insert_before()
10113 * @see elm_layout_box_insert_at()
10114 * @see elm_layout_box_remove()
10118 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10120 * Insert child to layout box part before a reference object.
10122 * @param obj the layout object
10123 * @param part the box part to insert.
10124 * @param child the child object to insert into box.
10125 * @param reference another reference object to insert before in box.
10127 * Once the object is inserted, it will become child of the layout. Its
10128 * lifetime will be bound to the layout, whenever the layout dies the child
10129 * will be deleted automatically. One should use elm_layout_box_remove() to
10130 * make this layout forget about the object.
10132 * @see elm_layout_box_append()
10133 * @see elm_layout_box_prepend()
10134 * @see elm_layout_box_insert_before()
10135 * @see elm_layout_box_remove()
10139 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
10141 * Insert child to layout box part at a given position.
10143 * @param obj the layout object
10144 * @param part the box part to insert.
10145 * @param child the child object to insert into box.
10146 * @param pos the numeric position >=0 to insert the child.
10148 * Once the object is inserted, it will become child of the layout. Its
10149 * lifetime will be bound to the layout, whenever the layout dies the child
10150 * will be deleted automatically. One should use elm_layout_box_remove() to
10151 * make this layout forget about the object.
10153 * @see elm_layout_box_append()
10154 * @see elm_layout_box_prepend()
10155 * @see elm_layout_box_insert_before()
10156 * @see elm_layout_box_remove()
10160 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
10162 * Remove a child of the given part box.
10164 * @param obj The layout object
10165 * @param part The box part name to remove child.
10166 * @param child The object to remove from box.
10167 * @return The object that was being used, or NULL if not found.
10169 * The object will be removed from the box part and its lifetime will
10170 * not be handled by the layout anymore. This is equivalent to
10171 * elm_object_content_part_unset() for box.
10173 * @see elm_layout_box_append()
10174 * @see elm_layout_box_remove_all()
10178 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
10180 * Remove all child of the given part box.
10182 * @param obj The layout object
10183 * @param part The box part name to remove child.
10184 * @param clear If EINA_TRUE, then all objects will be deleted as
10185 * well, otherwise they will just be removed and will be
10186 * dangling on the canvas.
10188 * The objects will be removed from the box part and their lifetime will
10189 * not be handled by the layout anymore. This is equivalent to
10190 * elm_layout_box_remove() for all box children.
10192 * @see elm_layout_box_append()
10193 * @see elm_layout_box_remove()
10197 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10199 * Insert child to layout table part.
10201 * @param obj the layout object
10202 * @param part the box part to pack child.
10203 * @param child_obj the child object to pack into table.
10204 * @param col the column to which the child should be added. (>= 0)
10205 * @param row the row to which the child should be added. (>= 0)
10206 * @param colspan how many columns should be used to store this object. (>=
10208 * @param rowspan how many rows should be used to store this object. (>= 1)
10210 * Once the object is inserted, it will become child of the table. Its
10211 * lifetime will be bound to the layout, and whenever the layout dies the
10212 * child will be deleted automatically. One should use
10213 * elm_layout_table_remove() to make this layout forget about the object.
10215 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
10216 * more space than a single cell. For instance, the following code:
10218 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
10221 * Would result in an object being added like the following picture:
10223 * @image html layout_colspan.png
10224 * @image latex layout_colspan.eps width=\textwidth
10226 * @see elm_layout_table_unpack()
10227 * @see elm_layout_table_clear()
10231 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);
10233 * Unpack (remove) a child of the given part table.
10235 * @param obj The layout object
10236 * @param part The table part name to remove child.
10237 * @param child_obj The object to remove from table.
10238 * @return The object that was being used, or NULL if not found.
10240 * The object will be unpacked from the table part and its lifetime
10241 * will not be handled by the layout anymore. This is equivalent to
10242 * elm_object_content_part_unset() for table.
10244 * @see elm_layout_table_pack()
10245 * @see elm_layout_table_clear()
10249 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
10251 * Remove all child of the given part table.
10253 * @param obj The layout object
10254 * @param part The table part name to remove child.
10255 * @param clear If EINA_TRUE, then all objects will be deleted as
10256 * well, otherwise they will just be removed and will be
10257 * dangling on the canvas.
10259 * The objects will be removed from the table part and their lifetime will
10260 * not be handled by the layout anymore. This is equivalent to
10261 * elm_layout_table_unpack() for all table children.
10263 * @see elm_layout_table_pack()
10264 * @see elm_layout_table_unpack()
10268 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10270 * Get the edje layout
10272 * @param obj The layout object
10274 * @return A Evas_Object with the edje layout settings loaded
10275 * with function elm_layout_file_set
10277 * This returns the edje object. It is not expected to be used to then
10278 * swallow objects via edje_object_part_swallow() for example. Use
10279 * elm_object_content_part_set() instead so child object handling and sizing is
10282 * @note This function should only be used if you really need to call some
10283 * low level Edje function on this edje object. All the common stuff (setting
10284 * text, emitting signals, hooking callbacks to signals, etc.) can be done
10285 * with proper elementary functions.
10287 * @see elm_object_signal_callback_add()
10288 * @see elm_object_signal_emit()
10289 * @see elm_object_text_part_set()
10290 * @see elm_object_content_part_set()
10291 * @see elm_layout_box_append()
10292 * @see elm_layout_table_pack()
10293 * @see elm_layout_data_get()
10297 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10299 * Get the edje data from the given layout
10301 * @param obj The layout object
10302 * @param key The data key
10304 * @return The edje data string
10306 * This function fetches data specified inside the edje theme of this layout.
10307 * This function return NULL if data is not found.
10309 * In EDC this comes from a data block within the group block that @p
10310 * obj was loaded from. E.g.
10317 * item: "key1" "value1";
10318 * item: "key2" "value2";
10326 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
10330 * @param obj The layout object
10332 * Manually forces a sizing re-evaluation. This is useful when the minimum
10333 * size required by the edje theme of this layout has changed. The change on
10334 * the minimum size required by the edje theme is not immediately reported to
10335 * the elementary layout, so one needs to call this function in order to tell
10336 * the widget (layout) that it needs to reevaluate its own size.
10338 * The minimum size of the theme is calculated based on minimum size of
10339 * parts, the size of elements inside containers like box and table, etc. All
10340 * of this can change due to state changes, and that's when this function
10341 * should be called.
10343 * Also note that a standard signal of "size,eval" "elm" emitted from the
10344 * edje object will cause this to happen too.
10348 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
10351 * Sets a specific cursor for an edje part.
10353 * @param obj The layout object.
10354 * @param part_name a part from loaded edje group.
10355 * @param cursor cursor name to use, see Elementary_Cursor.h
10357 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10358 * part not exists or it has "mouse_events: 0".
10362 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
10365 * Get the cursor to be shown when mouse is over an edje part
10367 * @param obj The layout object.
10368 * @param part_name a part from loaded edje group.
10369 * @return the cursor name.
10373 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10376 * Unsets a cursor previously set with elm_layout_part_cursor_set().
10378 * @param obj The layout object.
10379 * @param part_name a part from loaded edje group, that had a cursor set
10380 * with elm_layout_part_cursor_set().
10384 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10387 * Sets a specific cursor style for an edje part.
10389 * @param obj The layout object.
10390 * @param part_name a part from loaded edje group.
10391 * @param style the theme style to use (default, transparent, ...)
10393 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10394 * part not exists or it did not had a cursor set.
10398 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
10401 * Gets a specific cursor style for an edje part.
10403 * @param obj The layout object.
10404 * @param part_name a part from loaded edje group.
10406 * @return the theme style in use, defaults to "default". If the
10407 * object does not have a cursor set, then NULL is returned.
10411 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10414 * Sets if the cursor set should be searched on the theme or should use
10415 * the provided by the engine, only.
10417 * @note before you set if should look on theme you should define a
10418 * cursor with elm_layout_part_cursor_set(). By default it will only
10419 * look for cursors provided by the engine.
10421 * @param obj The layout object.
10422 * @param part_name a part from loaded edje group.
10423 * @param engine_only if cursors should be just provided by the engine
10424 * or should also search on widget's theme as well
10426 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10427 * part not exists or it did not had a cursor set.
10431 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);
10434 * Gets a specific cursor engine_only for an edje part.
10436 * @param obj The layout object.
10437 * @param part_name a part from loaded edje group.
10439 * @return whenever the cursor is just provided by engine or also from theme.
10443 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10446 * @def elm_layout_icon_set
10447 * Convienience macro to set the icon object in a layout that follows the
10448 * Elementary naming convention for its parts.
10452 #define elm_layout_icon_set(_ly, _obj) \
10455 elm_object_content_part_set((_ly), "elm.swallow.icon", (_obj)); \
10456 if ((_obj)) sig = "elm,state,icon,visible"; \
10457 else sig = "elm,state,icon,hidden"; \
10458 elm_object_signal_emit((_ly), sig, "elm"); \
10462 * @def elm_layout_icon_get
10463 * Convienience macro to get the icon object from a layout that follows the
10464 * Elementary naming convention for its parts.
10468 #define elm_layout_icon_get(_ly) \
10469 elm_object_content_part_get((_ly), "elm.swallow.icon")
10472 * @def elm_layout_end_set
10473 * Convienience macro to set the end object in a layout that follows the
10474 * Elementary naming convention for its parts.
10478 #define elm_layout_end_set(_ly, _obj) \
10481 elm_object_content_part_set((_ly), "elm.swallow.end", (_obj)); \
10482 if ((_obj)) sig = "elm,state,end,visible"; \
10483 else sig = "elm,state,end,hidden"; \
10484 elm_object_signal_emit((_ly), sig, "elm"); \
10488 * @def elm_layout_end_get
10489 * Convienience macro to get the end object in a layout that follows the
10490 * Elementary naming convention for its parts.
10494 #define elm_layout_end_get(_ly) \
10495 elm_object_content_part_get((_ly), "elm.swallow.end")
10498 * @def elm_layout_label_set
10499 * Convienience macro to set the label in a layout that follows the
10500 * Elementary naming convention for its parts.
10503 * @deprecated use elm_object_text_set() instead.
10505 #define elm_layout_label_set(_ly, _txt) \
10506 elm_layout_text_set((_ly), "elm.text", (_txt))
10509 * @def elm_layout_label_get
10510 * Convenience macro to get the label in a layout that follows the
10511 * Elementary naming convention for its parts.
10514 * @deprecated use elm_object_text_set() instead.
10516 #define elm_layout_label_get(_ly) \
10517 elm_layout_text_get((_ly), "elm.text")
10519 /* smart callbacks called:
10520 * "theme,changed" - when elm theme is changed.
10524 * @defgroup Notify Notify
10526 * @image html img/widget/notify/preview-00.png
10527 * @image latex img/widget/notify/preview-00.eps
10529 * Display a container in a particular region of the parent(top, bottom,
10530 * etc). A timeout can be set to automatically hide the notify. This is so
10531 * that, after an evas_object_show() on a notify object, if a timeout was set
10532 * on it, it will @b automatically get hidden after that time.
10534 * Signals that you can add callbacks for are:
10535 * @li "timeout" - when timeout happens on notify and it's hidden
10536 * @li "block,clicked" - when a click outside of the notify happens
10538 * Default contents parts of the notify widget that you can use for are:
10539 * @li "elm.swallow.content" - A content of the notify
10541 * @ref tutorial_notify show usage of the API.
10546 * @brief Possible orient values for notify.
10548 * This values should be used in conjunction to elm_notify_orient_set() to
10549 * set the position in which the notify should appear(relative to its parent)
10550 * and in conjunction with elm_notify_orient_get() to know where the notify
10553 typedef enum _Elm_Notify_Orient
10555 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
10556 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
10557 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
10558 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
10559 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
10560 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
10561 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
10562 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
10563 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10564 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10565 } Elm_Notify_Orient;
10567 * @brief Add a new notify to the parent
10569 * @param parent The parent object
10570 * @return The new object or NULL if it cannot be created
10572 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10574 * @brief Set the content of the notify widget
10576 * @param obj The notify object
10577 * @param content The content will be filled in this notify object
10579 * Once the content object is set, a previously set one will be deleted. If
10580 * you want to keep that old content object, use the
10581 * elm_notify_content_unset() function.
10583 * @deprecated use elm_object_content_set() instead
10586 EINA_DEPRECATED EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10588 * @brief Unset the content of the notify widget
10590 * @param obj The notify object
10591 * @return The content that was being used
10593 * Unparent and return the content object which was set for this widget
10595 * @see elm_notify_content_set()
10596 * @deprecated use elm_object_content_unset() instead
10599 EINA_DEPRECATED EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10601 * @brief Return the content of the notify widget
10603 * @param obj The notify object
10604 * @return The content that is being used
10606 * @see elm_notify_content_set()
10607 * @deprecated use elm_object_content_get() instead
10610 EINA_DEPRECATED EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10612 * @brief Set the notify parent
10614 * @param obj The notify object
10615 * @param content The new parent
10617 * Once the parent object is set, a previously set one will be disconnected
10620 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10622 * @brief Get the notify parent
10624 * @param obj The notify object
10625 * @return The parent
10627 * @see elm_notify_parent_set()
10629 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10631 * @brief Set the orientation
10633 * @param obj The notify object
10634 * @param orient The new orientation
10636 * Sets the position in which the notify will appear in its parent.
10638 * @see @ref Elm_Notify_Orient for possible values.
10640 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10642 * @brief Return the orientation
10643 * @param obj The notify object
10644 * @return The orientation of the notification
10646 * @see elm_notify_orient_set()
10647 * @see Elm_Notify_Orient
10649 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10651 * @brief Set the time interval after which the notify window is going to be
10654 * @param obj The notify object
10655 * @param time The timeout in seconds
10657 * This function sets a timeout and starts the timer controlling when the
10658 * notify is hidden. Since calling evas_object_show() on a notify restarts
10659 * the timer controlling when the notify is hidden, setting this before the
10660 * notify is shown will in effect mean starting the timer when the notify is
10663 * @note Set a value <= 0.0 to disable a running timer.
10665 * @note If the value > 0.0 and the notify is previously visible, the
10666 * timer will be started with this value, canceling any running timer.
10668 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10670 * @brief Return the timeout value (in seconds)
10671 * @param obj the notify object
10673 * @see elm_notify_timeout_set()
10675 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10677 * @brief Sets whether events should be passed to by a click outside
10680 * @param obj The notify object
10681 * @param repeats EINA_TRUE Events are repeats, else no
10683 * When true if the user clicks outside the window the events will be caught
10684 * by the others widgets, else the events are blocked.
10686 * @note The default value is EINA_TRUE.
10688 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10690 * @brief Return true if events are repeat below the notify object
10691 * @param obj the notify object
10693 * @see elm_notify_repeat_events_set()
10695 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10701 * @defgroup Hover Hover
10703 * @image html img/widget/hover/preview-00.png
10704 * @image latex img/widget/hover/preview-00.eps
10706 * A Hover object will hover over its @p parent object at the @p target
10707 * location. Anything in the background will be given a darker coloring to
10708 * indicate that the hover object is on top (at the default theme). When the
10709 * hover is clicked it is dismissed(hidden), if the contents of the hover are
10710 * clicked that @b doesn't cause the hover to be dismissed.
10712 * A Hover object has two parents. One parent that owns it during creation
10713 * and the other parent being the one over which the hover object spans.
10716 * @note The hover object will take up the entire space of @p target
10719 * Elementary has the following styles for the hover widget:
10723 * @li hoversel_vertical
10725 * The following are the available position for content:
10737 * Signals that you can add callbacks for are:
10738 * @li "clicked" - the user clicked the empty space in the hover to dismiss
10739 * @li "smart,changed" - a content object placed under the "smart"
10740 * policy was replaced to a new slot direction.
10742 * See @ref tutorial_hover for more information.
10746 typedef enum _Elm_Hover_Axis
10748 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10749 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10750 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10751 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10754 * @brief Adds a hover object to @p parent
10756 * @param parent The parent object
10757 * @return The hover object or NULL if one could not be created
10759 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10761 * @brief Sets the target object for the hover.
10763 * @param obj The hover object
10764 * @param target The object to center the hover onto. The hover
10766 * This function will cause the hover to be centered on the target object.
10768 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10770 * @brief Gets the target object for the hover.
10772 * @param obj The hover object
10773 * @param parent The object to locate the hover over.
10775 * @see elm_hover_target_set()
10777 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10779 * @brief Sets the parent object for the hover.
10781 * @param obj The hover object
10782 * @param parent The object to locate the hover over.
10784 * This function will cause the hover to take up the entire space that the
10785 * parent object fills.
10787 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10789 * @brief Gets the parent object for the hover.
10791 * @param obj The hover object
10792 * @return The parent object to locate the hover over.
10794 * @see elm_hover_parent_set()
10796 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10798 * @brief Sets the content of the hover object and the direction in which it
10801 * @param obj The hover object
10802 * @param swallow The direction that the object will be displayed
10803 * at. Accepted values are "left", "top-left", "top", "top-right",
10804 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10806 * @param content The content to place at @p swallow
10808 * Once the content object is set for a given direction, a previously
10809 * set one (on the same direction) will be deleted. If you want to
10810 * keep that old content object, use the elm_hover_content_unset()
10813 * All directions may have contents at the same time, except for
10814 * "smart". This is a special placement hint and its use case
10815 * independs of the calculations coming from
10816 * elm_hover_best_content_location_get(). Its use is for cases when
10817 * one desires only one hover content, but with a dinamic special
10818 * placement within the hover area. The content's geometry, whenever
10819 * it changes, will be used to decide on a best location not
10820 * extrapolating the hover's parent object view to show it in (still
10821 * being the hover's target determinant of its medium part -- move and
10822 * resize it to simulate finger sizes, for example). If one of the
10823 * directions other than "smart" are used, a previously content set
10824 * using it will be deleted, and vice-versa.
10826 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10828 * @brief Get the content of the hover object, in a given direction.
10830 * Return the content object which was set for this widget in the
10831 * @p swallow direction.
10833 * @param obj The hover object
10834 * @param swallow The direction that the object was display at.
10835 * @return The content that was being used
10837 * @see elm_hover_content_set()
10839 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10841 * @brief Unset the content of the hover object, in a given direction.
10843 * Unparent and return the content object set at @p swallow direction.
10845 * @param obj The hover object
10846 * @param swallow The direction that the object was display at.
10847 * @return The content that was being used.
10849 * @see elm_hover_content_set()
10851 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10853 * @brief Returns the best swallow location for content in the hover.
10855 * @param obj The hover object
10856 * @param pref_axis The preferred orientation axis for the hover object to use
10857 * @return The edje location to place content into the hover or @c
10860 * Best is defined here as the location at which there is the most available
10863 * @p pref_axis may be one of
10864 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10865 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10866 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10867 * - @c ELM_HOVER_AXIS_BOTH -- both
10869 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10870 * nescessarily be along the horizontal axis("left" or "right"). If
10871 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10872 * be along the vertical axis("top" or "bottom"). Chossing
10873 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10874 * returned position may be in either axis.
10876 * @see elm_hover_content_set()
10878 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10885 * @defgroup Entry Entry
10887 * @image html img/widget/entry/preview-00.png
10888 * @image latex img/widget/entry/preview-00.eps width=\textwidth
10889 * @image html img/widget/entry/preview-01.png
10890 * @image latex img/widget/entry/preview-01.eps width=\textwidth
10891 * @image html img/widget/entry/preview-02.png
10892 * @image latex img/widget/entry/preview-02.eps width=\textwidth
10893 * @image html img/widget/entry/preview-03.png
10894 * @image latex img/widget/entry/preview-03.eps width=\textwidth
10896 * An entry is a convenience widget which shows a box that the user can
10897 * enter text into. Entries by default don't scroll, so they grow to
10898 * accomodate the entire text, resizing the parent window as needed. This
10899 * can be changed with the elm_entry_scrollable_set() function.
10901 * They can also be single line or multi line (the default) and when set
10902 * to multi line mode they support text wrapping in any of the modes
10903 * indicated by #Elm_Wrap_Type.
10905 * Other features include password mode, filtering of inserted text with
10906 * elm_entry_text_filter_append() and related functions, inline "items" and
10907 * formatted markup text.
10909 * @section entry-markup Formatted text
10911 * The markup tags supported by the Entry are defined by the theme, but
10912 * even when writing new themes or extensions it's a good idea to stick to
10913 * a sane default, to maintain coherency and avoid application breakages.
10914 * Currently defined by the default theme are the following tags:
10915 * @li \<br\>: Inserts a line break.
10916 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10918 * @li \<tab\>: Inserts a tab.
10919 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10921 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10922 * @li \<link\>...\</link\>: Underlines the enclosed text.
10923 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10925 * @section entry-special Special markups
10927 * Besides those used to format text, entries support two special markup
10928 * tags used to insert clickable portions of text or items inlined within
10931 * @subsection entry-anchors Anchors
10933 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10934 * \</a\> tags and an event will be generated when this text is clicked,
10938 * This text is outside <a href=anc-01>but this one is an anchor</a>
10941 * The @c href attribute in the opening tag gives the name that will be
10942 * used to identify the anchor and it can be any valid utf8 string.
10944 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10945 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10946 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10947 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10950 * @subsection entry-items Items
10952 * Inlined in the text, any other @c Evas_Object can be inserted by using
10953 * \<item\> tags this way:
10956 * <item size=16x16 vsize=full href=emoticon/haha></item>
10959 * Just like with anchors, the @c href identifies each item, but these need,
10960 * in addition, to indicate their size, which is done using any one of
10961 * @c size, @c absize or @c relsize attributes. These attributes take their
10962 * value in the WxH format, where W is the width and H the height of the
10965 * @li absize: Absolute pixel size for the item. Whatever value is set will
10966 * be the item's size regardless of any scale value the object may have
10967 * been set to. The final line height will be adjusted to fit larger items.
10968 * @li size: Similar to @c absize, but it's adjusted to the scale value set
10970 * @li relsize: Size is adjusted for the item to fit within the current
10973 * Besides their size, items are specificed a @c vsize value that affects
10974 * how their final size and position are calculated. The possible values
10976 * @li ascent: Item will be placed within the line's baseline and its
10977 * ascent. That is, the height between the line where all characters are
10978 * positioned and the highest point in the line. For @c size and @c absize
10979 * items, the descent value will be added to the total line height to make
10980 * them fit. @c relsize items will be adjusted to fit within this space.
10981 * @li full: Items will be placed between the descent and ascent, or the
10982 * lowest point in the line and its highest.
10984 * The next image shows different configurations of items and how they
10985 * are the previously mentioned options affect their sizes. In all cases,
10986 * the green line indicates the ascent, blue for the baseline and red for
10989 * @image html entry_item.png
10990 * @image latex entry_item.eps width=\textwidth
10992 * And another one to show how size differs from absize. In the first one,
10993 * the scale value is set to 1.0, while the second one is using one of 2.0.
10995 * @image html entry_item_scale.png
10996 * @image latex entry_item_scale.eps width=\textwidth
10998 * After the size for an item is calculated, the entry will request an
10999 * object to place in its space. For this, the functions set with
11000 * elm_entry_item_provider_append() and related functions will be called
11001 * in order until one of them returns a @c non-NULL value. If no providers
11002 * are available, or all of them return @c NULL, then the entry falls back
11003 * to one of the internal defaults, provided the name matches with one of
11006 * All of the following are currently supported:
11009 * - emoticon/angry-shout
11010 * - emoticon/crazy-laugh
11011 * - emoticon/evil-laugh
11013 * - emoticon/goggle-smile
11014 * - emoticon/grumpy
11015 * - emoticon/grumpy-smile
11016 * - emoticon/guilty
11017 * - emoticon/guilty-smile
11019 * - emoticon/half-smile
11020 * - emoticon/happy-panting
11022 * - emoticon/indifferent
11024 * - emoticon/knowing-grin
11026 * - emoticon/little-bit-sorry
11027 * - emoticon/love-lots
11029 * - emoticon/minimal-smile
11030 * - emoticon/not-happy
11031 * - emoticon/not-impressed
11033 * - emoticon/opensmile
11036 * - emoticon/squint-laugh
11037 * - emoticon/surprised
11038 * - emoticon/suspicious
11039 * - emoticon/tongue-dangling
11040 * - emoticon/tongue-poke
11042 * - emoticon/unhappy
11043 * - emoticon/very-sorry
11046 * - emoticon/worried
11049 * Alternatively, an item may reference an image by its path, using
11050 * the URI form @c file:///path/to/an/image.png and the entry will then
11051 * use that image for the item.
11053 * @section entry-files Loading and saving files
11055 * Entries have convinience functions to load text from a file and save
11056 * changes back to it after a short delay. The automatic saving is enabled
11057 * by default, but can be disabled with elm_entry_autosave_set() and files
11058 * can be loaded directly as plain text or have any markup in them
11059 * recognized. See elm_entry_file_set() for more details.
11061 * @section entry-signals Emitted signals
11063 * This widget emits the following signals:
11065 * @li "changed": The text within the entry was changed.
11066 * @li "changed,user": The text within the entry was changed because of user interaction.
11067 * @li "activated": The enter key was pressed on a single line entry.
11068 * @li "press": A mouse button has been pressed on the entry.
11069 * @li "longpressed": A mouse button has been pressed and held for a couple
11071 * @li "clicked": The entry has been clicked (mouse press and release).
11072 * @li "clicked,double": The entry has been double clicked.
11073 * @li "clicked,triple": The entry has been triple clicked.
11074 * @li "focused": The entry has received focus.
11075 * @li "unfocused": The entry has lost focus.
11076 * @li "selection,paste": A paste of the clipboard contents was requested.
11077 * @li "selection,copy": A copy of the selected text into the clipboard was
11079 * @li "selection,cut": A cut of the selected text into the clipboard was
11081 * @li "selection,start": A selection has begun and no previous selection
11083 * @li "selection,changed": The current selection has changed.
11084 * @li "selection,cleared": The current selection has been cleared.
11085 * @li "cursor,changed": The cursor has changed position.
11086 * @li "anchor,clicked": An anchor has been clicked. The event_info
11087 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11088 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
11089 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11090 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
11091 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11092 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
11093 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11094 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
11095 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11096 * @li "preedit,changed": The preedit string has changed.
11097 * @li "language,changed": Program language changed.
11099 * @section entry-examples
11101 * An overview of the Entry API can be seen in @ref entry_example_01
11106 * @typedef Elm_Entry_Anchor_Info
11108 * The info sent in the callback for the "anchor,clicked" signals emitted
11111 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
11113 * @struct _Elm_Entry_Anchor_Info
11115 * The info sent in the callback for the "anchor,clicked" signals emitted
11118 struct _Elm_Entry_Anchor_Info
11120 const char *name; /**< The name of the anchor, as stated in its href */
11121 int button; /**< The mouse button used to click on it */
11122 Evas_Coord x, /**< Anchor geometry, relative to canvas */
11123 y, /**< Anchor geometry, relative to canvas */
11124 w, /**< Anchor geometry, relative to canvas */
11125 h; /**< Anchor geometry, relative to canvas */
11128 * @typedef Elm_Entry_Filter_Cb
11129 * This callback type is used by entry filters to modify text.
11130 * @param data The data specified as the last param when adding the filter
11131 * @param entry The entry object
11132 * @param text A pointer to the location of the text being filtered. This data can be modified,
11133 * but any additional allocations must be managed by the user.
11134 * @see elm_entry_text_filter_append
11135 * @see elm_entry_text_filter_prepend
11137 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
11140 * This adds an entry to @p parent object.
11142 * By default, entries are:
11146 * @li autosave is enabled
11148 * @param parent The parent object
11149 * @return The new object or NULL if it cannot be created
11151 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11153 * Sets the entry to single line mode.
11155 * In single line mode, entries don't ever wrap when the text reaches the
11156 * edge, and instead they keep growing horizontally. Pressing the @c Enter
11157 * key will generate an @c "activate" event instead of adding a new line.
11159 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
11160 * and pressing enter will break the text into a different line
11161 * without generating any events.
11163 * @param obj The entry object
11164 * @param single_line If true, the text in the entry
11165 * will be on a single line.
11167 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
11169 * Gets whether the entry is set to be single line.
11171 * @param obj The entry object
11172 * @return single_line If true, the text in the entry is set to display
11173 * on a single line.
11175 * @see elm_entry_single_line_set()
11177 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11179 * Sets the entry to password mode.
11181 * In password mode, entries are implicitly single line and the display of
11182 * any text in them is replaced with asterisks (*).
11184 * @param obj The entry object
11185 * @param password If true, password mode is enabled.
11187 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
11189 * Gets whether the entry is set to password mode.
11191 * @param obj The entry object
11192 * @return If true, the entry is set to display all characters
11193 * as asterisks (*).
11195 * @see elm_entry_password_set()
11197 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11199 * This sets the text displayed within the entry to @p entry.
11201 * @param obj The entry object
11202 * @param entry The text to be displayed
11204 * @deprecated Use elm_object_text_set() instead.
11205 * @note Using this function bypasses text filters
11207 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11209 * This returns the text currently shown in object @p entry.
11210 * See also elm_entry_entry_set().
11212 * @param obj The entry object
11213 * @return The currently displayed text or NULL on failure
11215 * @deprecated Use elm_object_text_get() instead.
11217 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11219 * Appends @p entry to the text of the entry.
11221 * Adds the text in @p entry to the end of any text already present in the
11224 * The appended text is subject to any filters set for the widget.
11226 * @param obj The entry object
11227 * @param entry The text to be displayed
11229 * @see elm_entry_text_filter_append()
11231 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11233 * Gets whether the entry is empty.
11235 * Empty means no text at all. If there are any markup tags, like an item
11236 * tag for which no provider finds anything, and no text is displayed, this
11237 * function still returns EINA_FALSE.
11239 * @param obj The entry object
11240 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
11242 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11244 * Gets any selected text within the entry.
11246 * If there's any selected text in the entry, this function returns it as
11247 * a string in markup format. NULL is returned if no selection exists or
11248 * if an error occurred.
11250 * The returned value points to an internal string and should not be freed
11251 * or modified in any way. If the @p entry object is deleted or its
11252 * contents are changed, the returned pointer should be considered invalid.
11254 * @param obj The entry object
11255 * @return The selected text within the entry or NULL on failure
11257 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11259 * Inserts the given text into the entry at the current cursor position.
11261 * This inserts text at the cursor position as if it was typed
11262 * by the user (note that this also allows markup which a user
11263 * can't just "type" as it would be converted to escaped text, so this
11264 * call can be used to insert things like emoticon items or bold push/pop
11265 * tags, other font and color change tags etc.)
11267 * If any selection exists, it will be replaced by the inserted text.
11269 * The inserted text is subject to any filters set for the widget.
11271 * @param obj The entry object
11272 * @param entry The text to insert
11274 * @see elm_entry_text_filter_append()
11276 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11278 * Set the line wrap type to use on multi-line entries.
11280 * Sets the wrap type used by the entry to any of the specified in
11281 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
11282 * line (without inserting a line break or paragraph separator) when it
11283 * reaches the far edge of the widget.
11285 * Note that this only makes sense for multi-line entries. A widget set
11286 * to be single line will never wrap.
11288 * @param obj The entry object
11289 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
11291 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
11293 * Gets the wrap mode the entry was set to use.
11295 * @param obj The entry object
11296 * @return Wrap type
11298 * @see also elm_entry_line_wrap_set()
11300 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11302 * Sets if the entry is to be editable or not.
11304 * By default, entries are editable and when focused, any text input by the
11305 * user will be inserted at the current cursor position. But calling this
11306 * function with @p editable as EINA_FALSE will prevent the user from
11307 * inputting text into the entry.
11309 * The only way to change the text of a non-editable entry is to use
11310 * elm_object_text_set(), elm_entry_entry_insert() and other related
11313 * @param obj The entry object
11314 * @param editable If EINA_TRUE, user input will be inserted in the entry,
11315 * if not, the entry is read-only and no user input is allowed.
11317 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
11319 * Gets whether the entry is editable or not.
11321 * @param obj The entry object
11322 * @return If true, the entry is editable by the user.
11323 * If false, it is not editable by the user
11325 * @see elm_entry_editable_set()
11327 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11329 * This drops any existing text selection within the entry.
11331 * @param obj The entry object
11333 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
11335 * This selects all text within the entry.
11337 * @param obj The entry object
11339 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
11341 * This moves the cursor one place to the right within the entry.
11343 * @param obj The entry object
11344 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11346 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
11348 * This moves the cursor one place to the left within the entry.
11350 * @param obj The entry object
11351 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11353 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
11355 * This moves the cursor one line up within the entry.
11357 * @param obj The entry object
11358 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11360 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
11362 * This moves the cursor one line down within the entry.
11364 * @param obj The entry object
11365 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11367 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
11369 * This moves the cursor to the beginning of the entry.
11371 * @param obj The entry object
11373 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11375 * This moves the cursor to the end of the entry.
11377 * @param obj The entry object
11379 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11381 * This moves the cursor to the beginning of the current line.
11383 * @param obj The entry object
11385 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11387 * This moves the cursor to the end of the current line.
11389 * @param obj The entry object
11391 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11393 * This begins a selection within the entry as though
11394 * the user were holding down the mouse button to make a selection.
11396 * @param obj The entry object
11398 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
11400 * This ends a selection within the entry as though
11401 * the user had just released the mouse button while making a selection.
11403 * @param obj The entry object
11405 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11407 * Gets whether a format node exists at the current cursor position.
11409 * A format node is anything that defines how the text is rendered. It can
11410 * be a visible format node, such as a line break or a paragraph separator,
11411 * or an invisible one, such as bold begin or end tag.
11412 * This function returns whether any format node exists at the current
11415 * @param obj The entry object
11416 * @return EINA_TRUE if the current cursor position contains a format node,
11417 * EINA_FALSE otherwise.
11419 * @see elm_entry_cursor_is_visible_format_get()
11421 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11423 * Gets if the current cursor position holds a visible format node.
11425 * @param obj The entry object
11426 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
11427 * if it's an invisible one or no format exists.
11429 * @see elm_entry_cursor_is_format_get()
11431 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11433 * Gets the character pointed by the cursor at its current position.
11435 * This function returns a string with the utf8 character stored at the
11436 * current cursor position.
11437 * Only the text is returned, any format that may exist will not be part
11438 * of the return value.
11440 * @param obj The entry object
11441 * @return The text pointed by the cursors.
11443 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11445 * This function returns the geometry of the cursor.
11447 * It's useful if you want to draw something on the cursor (or where it is),
11448 * or for example in the case of scrolled entry where you want to show the
11451 * @param obj The entry object
11452 * @param x returned geometry
11453 * @param y returned geometry
11454 * @param w returned geometry
11455 * @param h returned geometry
11456 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11458 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);
11460 * Sets the cursor position in the entry to the given value
11462 * The value in @p pos is the index of the character position within the
11463 * contents of the string as returned by elm_entry_cursor_pos_get().
11465 * @param obj The entry object
11466 * @param pos The position of the cursor
11468 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
11470 * Retrieves the current position of the cursor in the entry
11472 * @param obj The entry object
11473 * @return The cursor position
11475 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11477 * This executes a "cut" action on the selected text in the entry.
11479 * @param obj The entry object
11481 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
11483 * This executes a "copy" action on the selected text in the entry.
11485 * @param obj The entry object
11487 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
11489 * This executes a "paste" action in the entry.
11491 * @param obj The entry object
11493 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
11495 * This clears and frees the items in a entry's contextual (longpress)
11498 * @param obj The entry object
11500 * @see elm_entry_context_menu_item_add()
11502 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11504 * This adds an item to the entry's contextual menu.
11506 * A longpress on an entry will make the contextual menu show up, if this
11507 * hasn't been disabled with elm_entry_context_menu_disabled_set().
11508 * By default, this menu provides a few options like enabling selection mode,
11509 * which is useful on embedded devices that need to be explicit about it,
11510 * and when a selection exists it also shows the copy and cut actions.
11512 * With this function, developers can add other options to this menu to
11513 * perform any action they deem necessary.
11515 * @param obj The entry object
11516 * @param label The item's text label
11517 * @param icon_file The item's icon file
11518 * @param icon_type The item's icon type
11519 * @param func The callback to execute when the item is clicked
11520 * @param data The data to associate with the item for related functions
11522 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);
11524 * This disables the entry's contextual (longpress) menu.
11526 * @param obj The entry object
11527 * @param disabled If true, the menu is disabled
11529 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11531 * This returns whether the entry's contextual (longpress) menu is
11534 * @param obj The entry object
11535 * @return If true, the menu is disabled
11537 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11539 * This appends a custom item provider to the list for that entry
11541 * This appends the given callback. The list is walked from beginning to end
11542 * with each function called given the item href string in the text. If the
11543 * function returns an object handle other than NULL (it should create an
11544 * object to do this), then this object is used to replace that item. If
11545 * not the next provider is called until one provides an item object, or the
11546 * default provider in entry does.
11548 * @param obj The entry object
11549 * @param func The function called to provide the item object
11550 * @param data The data passed to @p func
11552 * @see @ref entry-items
11554 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);
11556 * This prepends a custom item provider to the list for that entry
11558 * This prepends the given callback. See elm_entry_item_provider_append() for
11561 * @param obj The entry object
11562 * @param func The function called to provide the item object
11563 * @param data The data passed to @p func
11565 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);
11567 * This removes a custom item provider to the list for that entry
11569 * This removes the given callback. See elm_entry_item_provider_append() for
11572 * @param obj The entry object
11573 * @param func The function called to provide the item object
11574 * @param data The data passed to @p func
11576 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);
11578 * Append a filter function for text inserted in the entry
11580 * Append the given callback to the list. This functions will be called
11581 * whenever any text is inserted into the entry, with the text to be inserted
11582 * as a parameter. The callback function is free to alter the text in any way
11583 * it wants, but it must remember to free the given pointer and update it.
11584 * If the new text is to be discarded, the function can free it and set its
11585 * text parameter to NULL. This will also prevent any following filters from
11588 * @param obj The entry object
11589 * @param func The function to use as text filter
11590 * @param data User data to pass to @p func
11592 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11594 * Prepend a filter function for text insdrted in the entry
11596 * Prepend the given callback to the list. See elm_entry_text_filter_append()
11597 * for more information
11599 * @param obj The entry object
11600 * @param func The function to use as text filter
11601 * @param data User data to pass to @p func
11603 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11605 * Remove a filter from the list
11607 * Removes the given callback from the filter list. See
11608 * elm_entry_text_filter_append() for more information.
11610 * @param obj The entry object
11611 * @param func The filter function to remove
11612 * @param data The user data passed when adding the function
11614 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11616 * This converts a markup (HTML-like) string into UTF-8.
11618 * The returned string is a malloc'ed buffer and it should be freed when
11619 * not needed anymore.
11621 * @param s The string (in markup) to be converted
11622 * @return The converted string (in UTF-8). It should be freed.
11624 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11626 * This converts a UTF-8 string into markup (HTML-like).
11628 * The returned string is a malloc'ed buffer and it should be freed when
11629 * not needed anymore.
11631 * @param s The string (in UTF-8) to be converted
11632 * @return The converted string (in markup). It should be freed.
11634 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11636 * This sets the file (and implicitly loads it) for the text to display and
11637 * then edit. All changes are written back to the file after a short delay if
11638 * the entry object is set to autosave (which is the default).
11640 * If the entry had any other file set previously, any changes made to it
11641 * will be saved if the autosave feature is enabled, otherwise, the file
11642 * will be silently discarded and any non-saved changes will be lost.
11644 * @param obj The entry object
11645 * @param file The path to the file to load and save
11646 * @param format The file format
11648 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11650 * Gets the file being edited by the entry.
11652 * This function can be used to retrieve any file set on the entry for
11653 * edition, along with the format used to load and save it.
11655 * @param obj The entry object
11656 * @param file The path to the file to load and save
11657 * @param format The file format
11659 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11661 * This function writes any changes made to the file set with
11662 * elm_entry_file_set()
11664 * @param obj The entry object
11666 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11668 * This sets the entry object to 'autosave' the loaded text file or not.
11670 * @param obj The entry object
11671 * @param autosave Autosave the loaded file or not
11673 * @see elm_entry_file_set()
11675 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11677 * This gets the entry object's 'autosave' status.
11679 * @param obj The entry object
11680 * @return Autosave the loaded file or not
11682 * @see elm_entry_file_set()
11684 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11686 * Control pasting of text and images for the widget.
11688 * Normally the entry allows both text and images to be pasted. By setting
11689 * textonly to be true, this prevents images from being pasted.
11691 * Note this only changes the behaviour of text.
11693 * @param obj The entry object
11694 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11695 * text+image+other.
11697 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11699 * Getting elm_entry text paste/drop mode.
11701 * In textonly mode, only text may be pasted or dropped into the widget.
11703 * @param obj The entry object
11704 * @return If the widget only accepts text from pastes.
11706 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11708 * Enable or disable scrolling in entry
11710 * Normally the entry is not scrollable unless you enable it with this call.
11712 * @param obj The entry object
11713 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11715 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11717 * Get the scrollable state of the entry
11719 * Normally the entry is not scrollable. This gets the scrollable state
11720 * of the entry. See elm_entry_scrollable_set() for more information.
11722 * @param obj The entry object
11723 * @return The scrollable state
11725 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
11727 * This sets a widget to be displayed to the left of a scrolled entry.
11729 * @param obj The scrolled entry object
11730 * @param icon The widget to display on the left side of the scrolled
11733 * @note A previously set widget will be destroyed.
11734 * @note If the object being set does not have minimum size hints set,
11735 * it won't get properly displayed.
11737 * @see elm_entry_end_set()
11739 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11741 * Gets the leftmost widget of the scrolled entry. This object is
11742 * owned by the scrolled entry and should not be modified.
11744 * @param obj The scrolled entry object
11745 * @return the left widget inside the scroller
11747 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11749 * Unset the leftmost widget of the scrolled entry, unparenting and
11752 * @param obj The scrolled entry object
11753 * @return the previously set icon sub-object of this entry, on
11756 * @see elm_entry_icon_set()
11758 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11760 * Sets the visibility of the left-side widget of the scrolled entry,
11761 * set by elm_entry_icon_set().
11763 * @param obj The scrolled entry object
11764 * @param setting EINA_TRUE if the object should be displayed,
11765 * EINA_FALSE if not.
11767 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11769 * This sets a widget to be displayed to the end of a scrolled entry.
11771 * @param obj The scrolled entry object
11772 * @param end The widget to display on the right side of the scrolled
11775 * @note A previously set widget will be destroyed.
11776 * @note If the object being set does not have minimum size hints set,
11777 * it won't get properly displayed.
11779 * @see elm_entry_icon_set
11781 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11783 * Gets the endmost widget of the scrolled entry. This object is owned
11784 * by the scrolled entry and should not be modified.
11786 * @param obj The scrolled entry object
11787 * @return the right widget inside the scroller
11789 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11791 * Unset the endmost widget of the scrolled entry, unparenting and
11794 * @param obj The scrolled entry object
11795 * @return the previously set icon sub-object of this entry, on
11798 * @see elm_entry_icon_set()
11800 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11802 * Sets the visibility of the end widget of the scrolled entry, set by
11803 * elm_entry_end_set().
11805 * @param obj The scrolled entry object
11806 * @param setting EINA_TRUE if the object should be displayed,
11807 * EINA_FALSE if not.
11809 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11811 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11814 * Setting an entry to single-line mode with elm_entry_single_line_set()
11815 * will automatically disable the display of scrollbars when the entry
11816 * moves inside its scroller.
11818 * @param obj The scrolled entry object
11819 * @param h The horizontal scrollbar policy to apply
11820 * @param v The vertical scrollbar policy to apply
11822 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11824 * This enables/disables bouncing within the entry.
11826 * This function sets whether the entry will bounce when scrolling reaches
11827 * the end of the contained entry.
11829 * @param obj The scrolled entry object
11830 * @param h The horizontal bounce state
11831 * @param v The vertical bounce state
11833 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11835 * Get the bounce mode
11837 * @param obj The Entry object
11838 * @param h_bounce Allow bounce horizontally
11839 * @param v_bounce Allow bounce vertically
11841 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11843 /* pre-made filters for entries */
11845 * @typedef Elm_Entry_Filter_Limit_Size
11847 * Data for the elm_entry_filter_limit_size() entry filter.
11849 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11851 * @struct _Elm_Entry_Filter_Limit_Size
11853 * Data for the elm_entry_filter_limit_size() entry filter.
11855 struct _Elm_Entry_Filter_Limit_Size
11857 int max_char_count; /**< The maximum number of characters allowed. */
11858 int max_byte_count; /**< The maximum number of bytes allowed*/
11861 * Filter inserted text based on user defined character and byte limits
11863 * Add this filter to an entry to limit the characters that it will accept
11864 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11865 * The funtion works on the UTF-8 representation of the string, converting
11866 * it from the set markup, thus not accounting for any format in it.
11868 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11869 * it as data when setting the filter. In it, it's possible to set limits
11870 * by character count or bytes (any of them is disabled if 0), and both can
11871 * be set at the same time. In that case, it first checks for characters,
11874 * The function will cut the inserted text in order to allow only the first
11875 * number of characters that are still allowed. The cut is made in
11876 * characters, even when limiting by bytes, in order to always contain
11877 * valid ones and avoid half unicode characters making it in.
11879 * This filter, like any others, does not apply when setting the entry text
11880 * directly with elm_object_text_set() (or the deprecated
11881 * elm_entry_entry_set()).
11883 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11885 * @typedef Elm_Entry_Filter_Accept_Set
11887 * Data for the elm_entry_filter_accept_set() entry filter.
11889 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11891 * @struct _Elm_Entry_Filter_Accept_Set
11893 * Data for the elm_entry_filter_accept_set() entry filter.
11895 struct _Elm_Entry_Filter_Accept_Set
11897 const char *accepted; /**< Set of characters accepted in the entry. */
11898 const char *rejected; /**< Set of characters rejected from the entry. */
11901 * Filter inserted text based on accepted or rejected sets of characters
11903 * Add this filter to an entry to restrict the set of accepted characters
11904 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11905 * This structure contains both accepted and rejected sets, but they are
11906 * mutually exclusive.
11908 * The @c accepted set takes preference, so if it is set, the filter will
11909 * only work based on the accepted characters, ignoring anything in the
11910 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11912 * In both cases, the function filters by matching utf8 characters to the
11913 * raw markup text, so it can be used to remove formatting tags.
11915 * This filter, like any others, does not apply when setting the entry text
11916 * directly with elm_object_text_set() (or the deprecated
11917 * elm_entry_entry_set()).
11919 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11921 * Set the input panel layout of the entry
11923 * @param obj The entry object
11924 * @param layout layout type
11926 EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
11928 * Get the input panel layout of the entry
11930 * @param obj The entry object
11931 * @return layout type
11933 * @see elm_entry_input_panel_layout_set
11935 EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11937 * Set the autocapitalization type on the immodule.
11939 * @param obj The entry object
11940 * @param autocapital_type The type of autocapitalization
11942 EAPI void elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type) EINA_ARG_NONNULL(1);
11944 * Retrieve the autocapitalization type on the immodule.
11946 * @param obj The entry object
11947 * @return autocapitalization type
11949 EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11951 * Sets the attribute to show the input panel automatically.
11953 * @param obj The entry object
11954 * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
11956 EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
11958 * Retrieve the attribute to show the input panel automatically.
11960 * @param obj The entry object
11961 * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
11963 EAPI Eina_Bool elm_entry_input_panel_enabled_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11969 /* composite widgets - these basically put together basic widgets above
11970 * in convenient packages that do more than basic stuff */
11974 * @defgroup Anchorview Anchorview
11976 * @image html img/widget/anchorview/preview-00.png
11977 * @image latex img/widget/anchorview/preview-00.eps
11979 * Anchorview is for displaying text that contains markup with anchors
11980 * like <c>\<a href=1234\>something\</\></c> in it.
11982 * Besides being styled differently, the anchorview widget provides the
11983 * necessary functionality so that clicking on these anchors brings up a
11984 * popup with user defined content such as "call", "add to contacts" or
11985 * "open web page". This popup is provided using the @ref Hover widget.
11987 * This widget is very similar to @ref Anchorblock, so refer to that
11988 * widget for an example. The only difference Anchorview has is that the
11989 * widget is already provided with scrolling functionality, so if the
11990 * text set to it is too large to fit in the given space, it will scroll,
11991 * whereas the @ref Anchorblock widget will keep growing to ensure all the
11992 * text can be displayed.
11994 * This widget emits the following signals:
11995 * @li "anchor,clicked": will be called when an anchor is clicked. The
11996 * @p event_info parameter on the callback will be a pointer of type
11997 * ::Elm_Entry_Anchorview_Info.
11999 * See @ref Anchorblock for an example on how to use both of them.
12008 * @typedef Elm_Entry_Anchorview_Info
12010 * The info sent in the callback for "anchor,clicked" signals emitted by
12011 * the Anchorview widget.
12013 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
12015 * @struct _Elm_Entry_Anchorview_Info
12017 * The info sent in the callback for "anchor,clicked" signals emitted by
12018 * the Anchorview widget.
12020 struct _Elm_Entry_Anchorview_Info
12022 const char *name; /**< Name of the anchor, as indicated in its href
12024 int button; /**< The mouse button used to click on it */
12025 Evas_Object *hover; /**< The hover object to use for the popup */
12027 Evas_Coord x, y, w, h;
12028 } anchor, /**< Geometry selection of text used as anchor */
12029 hover_parent; /**< Geometry of the object used as parent by the
12031 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
12032 for content on the left side of
12033 the hover. Before calling the
12034 callback, the widget will make the
12035 necessary calculations to check
12036 which sides are fit to be set with
12037 content, based on the position the
12038 hover is activated and its distance
12039 to the edges of its parent object
12041 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
12042 the right side of the hover.
12043 See @ref hover_left */
12044 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
12045 of the hover. See @ref hover_left */
12046 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
12047 below the hover. See @ref
12051 * Add a new Anchorview object
12053 * @param parent The parent object
12054 * @return The new object or NULL if it cannot be created
12056 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12058 * Set the text to show in the anchorview
12060 * Sets the text of the anchorview to @p text. This text can include markup
12061 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
12062 * text that will be specially styled and react to click events, ended with
12063 * either of \</a\> or \</\>. When clicked, the anchor will emit an
12064 * "anchor,clicked" signal that you can attach a callback to with
12065 * evas_object_smart_callback_add(). The name of the anchor given in the
12066 * event info struct will be the one set in the href attribute, in this
12067 * case, anchorname.
12069 * Other markup can be used to style the text in different ways, but it's
12070 * up to the style defined in the theme which tags do what.
12071 * @deprecated use elm_object_text_set() instead.
12073 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12075 * Get the markup text set for the anchorview
12077 * Retrieves the text set on the anchorview, with markup tags included.
12079 * @param obj The anchorview object
12080 * @return The markup text set or @c NULL if nothing was set or an error
12082 * @deprecated use elm_object_text_set() instead.
12084 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12086 * Set the parent of the hover popup
12088 * Sets the parent object to use by the hover created by the anchorview
12089 * when an anchor is clicked. See @ref Hover for more details on this.
12090 * If no parent is set, the same anchorview object will be used.
12092 * @param obj The anchorview object
12093 * @param parent The object to use as parent for the hover
12095 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12097 * Get the parent of the hover popup
12099 * Get the object used as parent for the hover created by the anchorview
12100 * widget. See @ref Hover for more details on this.
12102 * @param obj The anchorview object
12103 * @return The object used as parent for the hover, NULL if none is set.
12105 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12107 * Set the style that the hover should use
12109 * When creating the popup hover, anchorview will request that it's
12110 * themed according to @p style.
12112 * @param obj The anchorview object
12113 * @param style The style to use for the underlying hover
12115 * @see elm_object_style_set()
12117 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12119 * Get the style that the hover should use
12121 * Get the style the hover created by anchorview will use.
12123 * @param obj The anchorview object
12124 * @return The style to use by the hover. NULL means the default is used.
12126 * @see elm_object_style_set()
12128 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12130 * Ends the hover popup in the anchorview
12132 * When an anchor is clicked, the anchorview widget will create a hover
12133 * object to use as a popup with user provided content. This function
12134 * terminates this popup, returning the anchorview to its normal state.
12136 * @param obj The anchorview object
12138 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12140 * Set bouncing behaviour when the scrolled content reaches an edge
12142 * Tell the internal scroller object whether it should bounce or not
12143 * when it reaches the respective edges for each axis.
12145 * @param obj The anchorview object
12146 * @param h_bounce Whether to bounce or not in the horizontal axis
12147 * @param v_bounce Whether to bounce or not in the vertical axis
12149 * @see elm_scroller_bounce_set()
12151 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
12153 * Get the set bouncing behaviour of the internal scroller
12155 * Get whether the internal scroller should bounce when the edge of each
12156 * axis is reached scrolling.
12158 * @param obj The anchorview object
12159 * @param h_bounce Pointer where to store the bounce state of the horizontal
12161 * @param v_bounce Pointer where to store the bounce state of the vertical
12164 * @see elm_scroller_bounce_get()
12166 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
12168 * Appends a custom item provider to the given anchorview
12170 * Appends the given function to the list of items providers. This list is
12171 * called, one function at a time, with the given @p data pointer, the
12172 * anchorview object and, in the @p item parameter, the item name as
12173 * referenced in its href string. Following functions in the list will be
12174 * called in order until one of them returns something different to NULL,
12175 * which should be an Evas_Object which will be used in place of the item
12178 * Items in the markup text take the form \<item relsize=16x16 vsize=full
12179 * href=item/name\>\</item\>
12181 * @param obj The anchorview object
12182 * @param func The function to add to the list of providers
12183 * @param data User data that will be passed to the callback function
12185 * @see elm_entry_item_provider_append()
12187 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);
12189 * Prepend a custom item provider to the given anchorview
12191 * Like elm_anchorview_item_provider_append(), but it adds the function
12192 * @p func to the beginning of the list, instead of the end.
12194 * @param obj The anchorview object
12195 * @param func The function to add to the list of providers
12196 * @param data User data that will be passed to the callback function
12198 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);
12200 * Remove a custom item provider from the list of the given anchorview
12202 * Removes the function and data pairing that matches @p func and @p data.
12203 * That is, unless the same function and same user data are given, the
12204 * function will not be removed from the list. This allows us to add the
12205 * same callback several times, with different @p data pointers and be
12206 * able to remove them later without conflicts.
12208 * @param obj The anchorview object
12209 * @param func The function to remove from the list
12210 * @param data The data matching the function to remove from the list
12212 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);
12219 * @defgroup Anchorblock Anchorblock
12221 * @image html img/widget/anchorblock/preview-00.png
12222 * @image latex img/widget/anchorblock/preview-00.eps
12224 * Anchorblock is for displaying text that contains markup with anchors
12225 * like <c>\<a href=1234\>something\</\></c> in it.
12227 * Besides being styled differently, the anchorblock widget provides the
12228 * necessary functionality so that clicking on these anchors brings up a
12229 * popup with user defined content such as "call", "add to contacts" or
12230 * "open web page". This popup is provided using the @ref Hover widget.
12232 * This widget emits the following signals:
12233 * @li "anchor,clicked": will be called when an anchor is clicked. The
12234 * @p event_info parameter on the callback will be a pointer of type
12235 * ::Elm_Entry_Anchorblock_Info.
12241 * Since examples are usually better than plain words, we might as well
12242 * try @ref tutorial_anchorblock_example "one".
12245 * @addtogroup Anchorblock
12249 * @typedef Elm_Entry_Anchorblock_Info
12251 * The info sent in the callback for "anchor,clicked" signals emitted by
12252 * the Anchorblock widget.
12254 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
12256 * @struct _Elm_Entry_Anchorblock_Info
12258 * The info sent in the callback for "anchor,clicked" signals emitted by
12259 * the Anchorblock widget.
12261 struct _Elm_Entry_Anchorblock_Info
12263 const char *name; /**< Name of the anchor, as indicated in its href
12265 int button; /**< The mouse button used to click on it */
12266 Evas_Object *hover; /**< The hover object to use for the popup */
12268 Evas_Coord x, y, w, h;
12269 } anchor, /**< Geometry selection of text used as anchor */
12270 hover_parent; /**< Geometry of the object used as parent by the
12272 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
12273 for content on the left side of
12274 the hover. Before calling the
12275 callback, the widget will make the
12276 necessary calculations to check
12277 which sides are fit to be set with
12278 content, based on the position the
12279 hover is activated and its distance
12280 to the edges of its parent object
12282 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
12283 the right side of the hover.
12284 See @ref hover_left */
12285 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
12286 of the hover. See @ref hover_left */
12287 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
12288 below the hover. See @ref
12292 * Add a new Anchorblock object
12294 * @param parent The parent object
12295 * @return The new object or NULL if it cannot be created
12297 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12299 * Set the text to show in the anchorblock
12301 * Sets the text of the anchorblock to @p text. This text can include markup
12302 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
12303 * of text that will be specially styled and react to click events, ended
12304 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
12305 * "anchor,clicked" signal that you can attach a callback to with
12306 * evas_object_smart_callback_add(). The name of the anchor given in the
12307 * event info struct will be the one set in the href attribute, in this
12308 * case, anchorname.
12310 * Other markup can be used to style the text in different ways, but it's
12311 * up to the style defined in the theme which tags do what.
12312 * @deprecated use elm_object_text_set() instead.
12314 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12316 * Get the markup text set for the anchorblock
12318 * Retrieves the text set on the anchorblock, with markup tags included.
12320 * @param obj The anchorblock object
12321 * @return The markup text set or @c NULL if nothing was set or an error
12323 * @deprecated use elm_object_text_set() instead.
12325 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12327 * Set the parent of the hover popup
12329 * Sets the parent object to use by the hover created by the anchorblock
12330 * when an anchor is clicked. See @ref Hover for more details on this.
12332 * @param obj The anchorblock object
12333 * @param parent The object to use as parent for the hover
12335 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12337 * Get the parent of the hover popup
12339 * Get the object used as parent for the hover created by the anchorblock
12340 * widget. See @ref Hover for more details on this.
12341 * If no parent is set, the same anchorblock object will be used.
12343 * @param obj The anchorblock object
12344 * @return The object used as parent for the hover, NULL if none is set.
12346 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12348 * Set the style that the hover should use
12350 * When creating the popup hover, anchorblock will request that it's
12351 * themed according to @p style.
12353 * @param obj The anchorblock object
12354 * @param style The style to use for the underlying hover
12356 * @see elm_object_style_set()
12358 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12360 * Get the style that the hover should use
12362 * Get the style, the hover created by anchorblock will use.
12364 * @param obj The anchorblock object
12365 * @return The style to use by the hover. NULL means the default is used.
12367 * @see elm_object_style_set()
12369 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12371 * Ends the hover popup in the anchorblock
12373 * When an anchor is clicked, the anchorblock widget will create a hover
12374 * object to use as a popup with user provided content. This function
12375 * terminates this popup, returning the anchorblock to its normal state.
12377 * @param obj The anchorblock object
12379 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12381 * Appends a custom item provider to the given anchorblock
12383 * Appends the given function to the list of items providers. This list is
12384 * called, one function at a time, with the given @p data pointer, the
12385 * anchorblock object and, in the @p item parameter, the item name as
12386 * referenced in its href string. Following functions in the list will be
12387 * called in order until one of them returns something different to NULL,
12388 * which should be an Evas_Object which will be used in place of the item
12391 * Items in the markup text take the form \<item relsize=16x16 vsize=full
12392 * href=item/name\>\</item\>
12394 * @param obj The anchorblock object
12395 * @param func The function to add to the list of providers
12396 * @param data User data that will be passed to the callback function
12398 * @see elm_entry_item_provider_append()
12400 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);
12402 * Prepend a custom item provider to the given anchorblock
12404 * Like elm_anchorblock_item_provider_append(), but it adds the function
12405 * @p func to the beginning of the list, instead of the end.
12407 * @param obj The anchorblock object
12408 * @param func The function to add to the list of providers
12409 * @param data User data that will be passed to the callback function
12411 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);
12413 * Remove a custom item provider from the list of the given anchorblock
12415 * Removes the function and data pairing that matches @p func and @p data.
12416 * That is, unless the same function and same user data are given, the
12417 * function will not be removed from the list. This allows us to add the
12418 * same callback several times, with different @p data pointers and be
12419 * able to remove them later without conflicts.
12421 * @param obj The anchorblock object
12422 * @param func The function to remove from the list
12423 * @param data The data matching the function to remove from the list
12425 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);
12431 * @defgroup Bubble Bubble
12433 * @image html img/widget/bubble/preview-00.png
12434 * @image latex img/widget/bubble/preview-00.eps
12435 * @image html img/widget/bubble/preview-01.png
12436 * @image latex img/widget/bubble/preview-01.eps
12437 * @image html img/widget/bubble/preview-02.png
12438 * @image latex img/widget/bubble/preview-02.eps
12440 * @brief The Bubble is a widget to show text similar to how speech is
12441 * represented in comics.
12443 * The bubble widget contains 5 important visual elements:
12444 * @li The frame is a rectangle with rounded edjes and an "arrow".
12445 * @li The @p icon is an image to which the frame's arrow points to.
12446 * @li The @p label is a text which appears to the right of the icon if the
12447 * corner is "top_left" or "bottom_left" and is right aligned to the frame
12449 * @li The @p info is a text which appears to the right of the label. Info's
12450 * font is of a ligther color than label.
12451 * @li The @p content is an evas object that is shown inside the frame.
12453 * The position of the arrow, icon, label and info depends on which corner is
12454 * selected. The four available corners are:
12455 * @li "top_left" - Default
12457 * @li "bottom_left"
12458 * @li "bottom_right"
12460 * Signals that you can add callbacks for are:
12461 * @li "clicked" - This is called when a user has clicked the bubble.
12463 * For an example of using a buble see @ref bubble_01_example_page "this".
12468 * Add a new bubble to the parent
12470 * @param parent The parent object
12471 * @return The new object or NULL if it cannot be created
12473 * This function adds a text bubble to the given parent evas object.
12475 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12477 * Set the label of the bubble
12479 * @param obj The bubble object
12480 * @param label The string to set in the label
12482 * This function sets the title of the bubble. Where this appears depends on
12483 * the selected corner.
12484 * @deprecated use elm_object_text_set() instead.
12486 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12488 * Get the label of the bubble
12490 * @param obj The bubble object
12491 * @return The string of set in the label
12493 * This function gets the title of the bubble.
12494 * @deprecated use elm_object_text_get() instead.
12496 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12498 * Set the info of the bubble
12500 * @param obj The bubble object
12501 * @param info The given info about the bubble
12503 * This function sets the info of the bubble. Where this appears depends on
12504 * the selected corner.
12505 * @deprecated use elm_object_text_part_set() instead. (with "info" as the parameter).
12507 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
12509 * Get the info of the bubble
12511 * @param obj The bubble object
12513 * @return The "info" string of the bubble
12515 * This function gets the info text.
12516 * @deprecated use elm_object_text_part_get() instead. (with "info" as the parameter).
12518 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12520 * Set the content to be shown in the bubble
12522 * Once the content object is set, a previously set one will be deleted.
12523 * If you want to keep the old content object, use the
12524 * elm_bubble_content_unset() function.
12526 * @param obj The bubble object
12527 * @param content The given content of the bubble
12529 * This function sets the content shown on the middle of the bubble.
12531 * @deprecated use elm_object_content_set() instead
12534 EINA_DEPRECATED EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12536 * Get the content shown in the bubble
12538 * Return the content object which is set for this widget.
12540 * @param obj The bubble object
12541 * @return The content that is being used
12543 * @deprecated use elm_object_content_get() instead
12546 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12548 * Unset the content shown in the bubble
12550 * Unparent and return the content object which was set for this widget.
12552 * @param obj The bubble object
12553 * @return The content that was being used
12555 * @deprecated use elm_object_content_unset() instead
12558 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12560 * Set the icon of the bubble
12562 * Once the icon object is set, a previously set one will be deleted.
12563 * If you want to keep the old content object, use the
12564 * elm_icon_content_unset() function.
12566 * @param obj The bubble object
12567 * @param icon The given icon for the bubble
12569 EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12571 * Get the icon of the bubble
12573 * @param obj The bubble object
12574 * @return The icon for the bubble
12576 * This function gets the icon shown on the top left of bubble.
12578 EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12580 * Unset the icon of the bubble
12582 * Unparent and return the icon object which was set for this widget.
12584 * @param obj The bubble object
12585 * @return The icon that was being used
12587 EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12589 * Set the corner of the bubble
12591 * @param obj The bubble object.
12592 * @param corner The given corner for the bubble.
12594 * This function sets the corner of the bubble. The corner will be used to
12595 * determine where the arrow in the frame points to and where label, icon and
12598 * Possible values for corner are:
12599 * @li "top_left" - Default
12601 * @li "bottom_left"
12602 * @li "bottom_right"
12604 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
12606 * Get the corner of the bubble
12608 * @param obj The bubble object.
12609 * @return The given corner for the bubble.
12611 * This function gets the selected corner of the bubble.
12613 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12619 * @defgroup Photo Photo
12621 * For displaying the photo of a person (contact). Simple, yet
12622 * with a very specific purpose.
12624 * Signals that you can add callbacks for are:
12626 * "clicked" - This is called when a user has clicked the photo
12627 * "drag,start" - Someone started dragging the image out of the object
12628 * "drag,end" - Dragged item was dropped (somewhere)
12634 * Add a new photo to the parent
12636 * @param parent The parent object
12637 * @return The new object or NULL if it cannot be created
12641 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12644 * Set the file that will be used as photo
12646 * @param obj The photo object
12647 * @param file The path to file that will be used as photo
12649 * @return (1 = success, 0 = error)
12653 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12656 * Set the file that will be used as thumbnail in the photo.
12658 * @param obj The photo object.
12659 * @param file The path to file that will be used as thumb.
12660 * @param group The key used in case of an EET file.
12664 EAPI void elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
12667 * Set the size that will be used on the photo
12669 * @param obj The photo object
12670 * @param size The size that the photo will be
12674 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12677 * Set if the photo should be completely visible or not.
12679 * @param obj The photo object
12680 * @param fill if true the photo will be completely visible
12684 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12687 * Set editability of the photo.
12689 * An editable photo can be dragged to or from, and can be cut or
12690 * pasted too. Note that pasting an image or dropping an item on
12691 * the image will delete the existing content.
12693 * @param obj The photo object.
12694 * @param set To set of clear editablity.
12696 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12702 /* gesture layer */
12704 * @defgroup Elm_Gesture_Layer Gesture Layer
12705 * Gesture Layer Usage:
12707 * Use Gesture Layer to detect gestures.
12708 * The advantage is that you don't have to implement
12709 * gesture detection, just set callbacks of gesture state.
12710 * By using gesture layer we make standard interface.
12712 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12713 * with a parent object parameter.
12714 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12715 * call. Usually with same object as target (2nd parameter).
12717 * Now you need to tell gesture layer what gestures you follow.
12718 * This is done with @ref elm_gesture_layer_cb_set call.
12719 * By setting the callback you actually saying to gesture layer:
12720 * I would like to know when the gesture @ref Elm_Gesture_Types
12721 * switches to state @ref Elm_Gesture_State.
12723 * Next, you need to implement the actual action that follows the input
12724 * in your callback.
12726 * Note that if you like to stop being reported about a gesture, just set
12727 * all callbacks referring this gesture to NULL.
12728 * (again with @ref elm_gesture_layer_cb_set)
12730 * The information reported by gesture layer to your callback is depending
12731 * on @ref Elm_Gesture_Types:
12732 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12733 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12734 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12736 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12737 * @ref ELM_GESTURE_MOMENTUM.
12739 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12740 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12741 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12742 * Note that we consider a flick as a line-gesture that should be completed
12743 * in flick-time-limit as defined in @ref Config.
12745 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12747 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12750 * Gesture Layer Tweaks:
12752 * Note that line, flick, gestures can start without the need to remove fingers from surface.
12753 * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
12755 * Setting glayer_continues_enable to false in @ref Config will change this behavior
12756 * so gesture starts when user touches (a *DOWN event) touch-surface
12757 * and ends when no fingers touches surface (a *UP event).
12761 * @enum _Elm_Gesture_Types
12762 * Enum of supported gesture types.
12763 * @ingroup Elm_Gesture_Layer
12765 enum _Elm_Gesture_Types
12767 ELM_GESTURE_FIRST = 0,
12769 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12770 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12771 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12772 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12774 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12776 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12777 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12779 ELM_GESTURE_ZOOM, /**< Zoom */
12780 ELM_GESTURE_ROTATE, /**< Rotate */
12786 * @typedef Elm_Gesture_Types
12787 * gesture types enum
12788 * @ingroup Elm_Gesture_Layer
12790 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12793 * @enum _Elm_Gesture_State
12794 * Enum of gesture states.
12795 * @ingroup Elm_Gesture_Layer
12797 enum _Elm_Gesture_State
12799 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12800 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
12801 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
12802 ELM_GESTURE_STATE_END, /**< Gesture completed */
12803 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
12807 * @typedef Elm_Gesture_State
12808 * gesture states enum
12809 * @ingroup Elm_Gesture_Layer
12811 typedef enum _Elm_Gesture_State Elm_Gesture_State;
12814 * @struct _Elm_Gesture_Taps_Info
12815 * Struct holds taps info for user
12816 * @ingroup Elm_Gesture_Layer
12818 struct _Elm_Gesture_Taps_Info
12820 Evas_Coord x, y; /**< Holds center point between fingers */
12821 unsigned int n; /**< Number of fingers tapped */
12822 unsigned int timestamp; /**< event timestamp */
12826 * @typedef Elm_Gesture_Taps_Info
12827 * holds taps info for user
12828 * @ingroup Elm_Gesture_Layer
12830 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12833 * @struct _Elm_Gesture_Momentum_Info
12834 * Struct holds momentum info for user
12835 * x1 and y1 are not necessarily in sync
12836 * x1 holds x value of x direction starting point
12837 * and same holds for y1.
12838 * This is noticeable when doing V-shape movement
12839 * @ingroup Elm_Gesture_Layer
12841 struct _Elm_Gesture_Momentum_Info
12842 { /* Report line ends, timestamps, and momentum computed */
12843 Evas_Coord x1; /**< Final-swipe direction starting point on X */
12844 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12845 Evas_Coord x2; /**< Final-swipe direction ending point on X */
12846 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
12848 unsigned int tx; /**< Timestamp of start of final x-swipe */
12849 unsigned int ty; /**< Timestamp of start of final y-swipe */
12851 Evas_Coord mx; /**< Momentum on X */
12852 Evas_Coord my; /**< Momentum on Y */
12854 unsigned int n; /**< Number of fingers */
12858 * @typedef Elm_Gesture_Momentum_Info
12859 * holds momentum info for user
12860 * @ingroup Elm_Gesture_Layer
12862 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12865 * @struct _Elm_Gesture_Line_Info
12866 * Struct holds line info for user
12867 * @ingroup Elm_Gesture_Layer
12869 struct _Elm_Gesture_Line_Info
12870 { /* Report line ends, timestamps, and momentum computed */
12871 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12872 double angle; /**< Angle (direction) of lines */
12876 * @typedef Elm_Gesture_Line_Info
12877 * Holds line info for user
12878 * @ingroup Elm_Gesture_Layer
12880 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12883 * @struct _Elm_Gesture_Zoom_Info
12884 * Struct holds zoom info for user
12885 * @ingroup Elm_Gesture_Layer
12887 struct _Elm_Gesture_Zoom_Info
12889 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12890 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12891 double zoom; /**< Zoom value: 1.0 means no zoom */
12892 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12896 * @typedef Elm_Gesture_Zoom_Info
12897 * Holds zoom info for user
12898 * @ingroup Elm_Gesture_Layer
12900 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12903 * @struct _Elm_Gesture_Rotate_Info
12904 * Struct holds rotation info for user
12905 * @ingroup Elm_Gesture_Layer
12907 struct _Elm_Gesture_Rotate_Info
12909 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12910 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12911 double base_angle; /**< Holds start-angle */
12912 double angle; /**< Rotation value: 0.0 means no rotation */
12913 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12917 * @typedef Elm_Gesture_Rotate_Info
12918 * Holds rotation info for user
12919 * @ingroup Elm_Gesture_Layer
12921 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12924 * @typedef Elm_Gesture_Event_Cb
12925 * User callback used to stream gesture info from gesture layer
12926 * @param data user data
12927 * @param event_info gesture report info
12928 * Returns a flag field to be applied on the causing event.
12929 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12930 * upon the event, in an irreversible way.
12932 * @ingroup Elm_Gesture_Layer
12934 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12937 * Use function to set callbacks to be notified about
12938 * change of state of gesture.
12939 * When a user registers a callback with this function
12940 * this means this gesture has to be tested.
12942 * When ALL callbacks for a gesture are set to NULL
12943 * it means user isn't interested in gesture-state
12944 * and it will not be tested.
12946 * @param obj Pointer to gesture-layer.
12947 * @param idx The gesture you would like to track its state.
12948 * @param cb callback function pointer.
12949 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
12950 * @param data user info to be sent to callback (usually, Smart Data)
12952 * @ingroup Elm_Gesture_Layer
12954 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);
12957 * Call this function to get repeat-events settings.
12959 * @param obj Pointer to gesture-layer.
12961 * @return repeat events settings.
12962 * @see elm_gesture_layer_hold_events_set()
12963 * @ingroup Elm_Gesture_Layer
12965 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12968 * This function called in order to make gesture-layer repeat events.
12969 * Set this of you like to get the raw events only if gestures were not detected.
12970 * Clear this if you like gesture layer to fwd events as testing gestures.
12972 * @param obj Pointer to gesture-layer.
12973 * @param r Repeat: TRUE/FALSE
12975 * @ingroup Elm_Gesture_Layer
12977 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
12980 * This function sets step-value for zoom action.
12981 * Set step to any positive value.
12982 * Cancel step setting by setting to 0.0
12984 * @param obj Pointer to gesture-layer.
12985 * @param s new zoom step value.
12987 * @ingroup Elm_Gesture_Layer
12989 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12992 * This function sets step-value for rotate action.
12993 * Set step to any positive value.
12994 * Cancel step setting by setting to 0.0
12996 * @param obj Pointer to gesture-layer.
12997 * @param s new roatate step value.
12999 * @ingroup Elm_Gesture_Layer
13001 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
13004 * This function called to attach gesture-layer to an Evas_Object.
13005 * @param obj Pointer to gesture-layer.
13006 * @param t Pointer to underlying object (AKA Target)
13008 * @return TRUE, FALSE on success, failure.
13010 * @ingroup Elm_Gesture_Layer
13012 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
13015 * Call this function to construct a new gesture-layer object.
13016 * This does not activate the gesture layer. You have to
13017 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
13019 * @param parent the parent object.
13021 * @return Pointer to new gesture-layer object.
13023 * @ingroup Elm_Gesture_Layer
13025 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13028 * @defgroup Thumb Thumb
13030 * @image html img/widget/thumb/preview-00.png
13031 * @image latex img/widget/thumb/preview-00.eps
13033 * A thumb object is used for displaying the thumbnail of an image or video.
13034 * You must have compiled Elementary with Ethumb_Client support and the DBus
13035 * service must be present and auto-activated in order to have thumbnails to
13038 * Once the thumbnail object becomes visible, it will check if there is a
13039 * previously generated thumbnail image for the file set on it. If not, it
13040 * will start generating this thumbnail.
13042 * Different config settings will cause different thumbnails to be generated
13043 * even on the same file.
13045 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
13046 * Ethumb documentation to change this path, and to see other configuration
13049 * Signals that you can add callbacks for are:
13051 * - "clicked" - This is called when a user has clicked the thumb without dragging
13053 * - "clicked,double" - This is called when a user has double-clicked the thumb.
13054 * - "press" - This is called when a user has pressed down the thumb.
13055 * - "generate,start" - The thumbnail generation started.
13056 * - "generate,stop" - The generation process stopped.
13057 * - "generate,error" - The generation failed.
13058 * - "load,error" - The thumbnail image loading failed.
13060 * available styles:
13064 * An example of use of thumbnail:
13066 * - @ref thumb_example_01
13070 * @addtogroup Thumb
13075 * @enum _Elm_Thumb_Animation_Setting
13076 * @typedef Elm_Thumb_Animation_Setting
13078 * Used to set if a video thumbnail is animating or not.
13082 typedef enum _Elm_Thumb_Animation_Setting
13084 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
13085 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
13086 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
13087 ELM_THUMB_ANIMATION_LAST
13088 } Elm_Thumb_Animation_Setting;
13091 * Add a new thumb object to the parent.
13093 * @param parent The parent object.
13094 * @return The new object or NULL if it cannot be created.
13096 * @see elm_thumb_file_set()
13097 * @see elm_thumb_ethumb_client_get()
13101 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13103 * Reload thumbnail if it was generated before.
13105 * @param obj The thumb object to reload
13107 * This is useful if the ethumb client configuration changed, like its
13108 * size, aspect or any other property one set in the handle returned
13109 * by elm_thumb_ethumb_client_get().
13111 * If the options didn't change, the thumbnail won't be generated again, but
13112 * the old one will still be used.
13114 * @see elm_thumb_file_set()
13118 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
13120 * Set the file that will be used as thumbnail.
13122 * @param obj The thumb object.
13123 * @param file The path to file that will be used as thumb.
13124 * @param key The key used in case of an EET file.
13126 * The file can be an image or a video (in that case, acceptable extensions are:
13127 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
13128 * function elm_thumb_animate().
13130 * @see elm_thumb_file_get()
13131 * @see elm_thumb_reload()
13132 * @see elm_thumb_animate()
13136 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
13138 * Get the image or video path and key used to generate the thumbnail.
13140 * @param obj The thumb object.
13141 * @param file Pointer to filename.
13142 * @param key Pointer to key.
13144 * @see elm_thumb_file_set()
13145 * @see elm_thumb_path_get()
13149 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13151 * Get the path and key to the image or video generated by ethumb.
13153 * One just need to make sure that the thumbnail was generated before getting
13154 * its path; otherwise, the path will be NULL. One way to do that is by asking
13155 * for the path when/after the "generate,stop" smart callback is called.
13157 * @param obj The thumb object.
13158 * @param file Pointer to thumb path.
13159 * @param key Pointer to thumb key.
13161 * @see elm_thumb_file_get()
13165 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13167 * Set the animation state for the thumb object. If its content is an animated
13168 * video, you may start/stop the animation or tell it to play continuously and
13171 * @param obj The thumb object.
13172 * @param setting The animation setting.
13174 * @see elm_thumb_file_set()
13178 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
13180 * Get the animation state for the thumb object.
13182 * @param obj The thumb object.
13183 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
13186 * @see elm_thumb_animate_set()
13190 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13192 * Get the ethumb_client handle so custom configuration can be made.
13194 * @return Ethumb_Client instance or NULL.
13196 * This must be called before the objects are created to be sure no object is
13197 * visible and no generation started.
13199 * Example of usage:
13202 * #include <Elementary.h>
13203 * #ifndef ELM_LIB_QUICKLAUNCH
13205 * elm_main(int argc, char **argv)
13207 * Ethumb_Client *client;
13209 * elm_need_ethumb();
13213 * client = elm_thumb_ethumb_client_get();
13216 * ERR("could not get ethumb_client");
13219 * ethumb_client_size_set(client, 100, 100);
13220 * ethumb_client_crop_align_set(client, 0.5, 0.5);
13223 * // Create elm_thumb objects here
13233 * @note There's only one client handle for Ethumb, so once a configuration
13234 * change is done to it, any other request for thumbnails (for any thumbnail
13235 * object) will use that configuration. Thus, this configuration is global.
13239 EAPI void *elm_thumb_ethumb_client_get(void);
13241 * Get the ethumb_client connection state.
13243 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
13246 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
13248 * Make the thumbnail 'editable'.
13250 * @param obj Thumb object.
13251 * @param set Turn on or off editability. Default is @c EINA_FALSE.
13253 * This means the thumbnail is a valid drag target for drag and drop, and can be
13254 * cut or pasted too.
13256 * @see elm_thumb_editable_get()
13260 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
13262 * Make the thumbnail 'editable'.
13264 * @param obj Thumb object.
13265 * @return Editability.
13267 * This means the thumbnail is a valid drag target for drag and drop, and can be
13268 * cut or pasted too.
13270 * @see elm_thumb_editable_set()
13274 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13281 * @defgroup Web Web
13283 * @image html img/widget/web/preview-00.png
13284 * @image latex img/widget/web/preview-00.eps
13286 * A web object is used for displaying web pages (HTML/CSS/JS)
13287 * using WebKit-EFL. You must have compiled Elementary with
13290 * Signals that you can add callbacks for are:
13291 * @li "download,request": A file download has been requested. Event info is
13292 * a pointer to a Elm_Web_Download
13293 * @li "editorclient,contents,changed": Editor client's contents changed
13294 * @li "editorclient,selection,changed": Editor client's selection changed
13295 * @li "frame,created": A new frame was created. Event info is an
13296 * Evas_Object which can be handled with WebKit's ewk_frame API
13297 * @li "icon,received": An icon was received by the main frame
13298 * @li "inputmethod,changed": Input method changed. Event info is an
13299 * Eina_Bool indicating whether it's enabled or not
13300 * @li "js,windowobject,clear": JS window object has been cleared
13301 * @li "link,hover,in": Mouse cursor is hovering over a link. Event info
13302 * is a char *link[2], where the first string contains the URL the link
13303 * points to, and the second one the title of the link
13304 * @li "link,hover,out": Mouse cursor left the link
13305 * @li "load,document,finished": Loading of a document finished. Event info
13306 * is the frame that finished loading
13307 * @li "load,error": Load failed. Event info is a pointer to
13308 * Elm_Web_Frame_Load_Error
13309 * @li "load,finished": Load finished. Event info is NULL on success, on
13310 * error it's a pointer to Elm_Web_Frame_Load_Error
13311 * @li "load,newwindow,show": A new window was created and is ready to be
13313 * @li "load,progress": Overall load progress. Event info is a pointer to
13314 * a double containing a value between 0.0 and 1.0
13315 * @li "load,provisional": Started provisional load
13316 * @li "load,started": Loading of a document started
13317 * @li "menubar,visible,get": Queries if the menubar is visible. Event info
13318 * is a pointer to Eina_Bool where the callback should set EINA_TRUE if
13319 * the menubar is visible, or EINA_FALSE in case it's not
13320 * @li "menubar,visible,set": Informs menubar visibility. Event info is
13321 * an Eina_Bool indicating the visibility
13322 * @li "popup,created": A dropdown widget was activated, requesting its
13323 * popup menu to be created. Event info is a pointer to Elm_Web_Menu
13324 * @li "popup,willdelete": The web object is ready to destroy the popup
13325 * object created. Event info is a pointer to Elm_Web_Menu
13326 * @li "ready": Page is fully loaded
13327 * @li "scrollbars,visible,get": Queries visibility of scrollbars. Event
13328 * info is a pointer to Eina_Bool where the visibility state should be set
13329 * @li "scrollbars,visible,set": Informs scrollbars visibility. Event info
13330 * is an Eina_Bool with the visibility state set
13331 * @li "statusbar,text,set": Text of the statusbar changed. Even info is
13332 * a string with the new text
13333 * @li "statusbar,visible,get": Queries visibility of the status bar.
13334 * Event info is a pointer to Eina_Bool where the visibility state should be
13336 * @li "statusbar,visible,set": Informs statusbar visibility. Event info is
13337 * an Eina_Bool with the visibility value
13338 * @li "title,changed": Title of the main frame changed. Event info is a
13339 * string with the new title
13340 * @li "toolbars,visible,get": Queries visibility of toolbars. Event info
13341 * is a pointer to Eina_Bool where the visibility state should be set
13342 * @li "toolbars,visible,set": Informs the visibility of toolbars. Event
13343 * info is an Eina_Bool with the visibility state
13344 * @li "tooltip,text,set": Show and set text of a tooltip. Event info is
13345 * a string with the text to show
13346 * @li "uri,changed": URI of the main frame changed. Event info is a string
13348 * @li "view,resized": The web object internal's view changed sized
13349 * @li "windows,close,request": A JavaScript request to close the current
13350 * window was requested
13351 * @li "zoom,animated,end": Animated zoom finished
13353 * available styles:
13356 * An example of use of web:
13358 * - @ref web_example_01 TBD
13367 * Structure used to report load errors.
13369 * Load errors are reported as signal by elm_web. All the strings are
13370 * temporary references and should @b not be used after the signal
13371 * callback returns. If it's required, make copies with strdup() or
13372 * eina_stringshare_add() (they are not even guaranteed to be
13373 * stringshared, so must use eina_stringshare_add() and not
13374 * eina_stringshare_ref()).
13376 typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
13378 * Structure used to report load errors.
13380 * Load errors are reported as signal by elm_web. All the strings are
13381 * temporary references and should @b not be used after the signal
13382 * callback returns. If it's required, make copies with strdup() or
13383 * eina_stringshare_add() (they are not even guaranteed to be
13384 * stringshared, so must use eina_stringshare_add() and not
13385 * eina_stringshare_ref()).
13387 struct _Elm_Web_Frame_Load_Error
13389 int code; /**< Numeric error code */
13390 Eina_Bool is_cancellation; /**< Error produced by cancelling a request */
13391 const char *domain; /**< Error domain name */
13392 const char *description; /**< Error description (already localized) */
13393 const char *failing_url; /**< The URL that failed to load */
13394 Evas_Object *frame; /**< Frame object that produced the error */
13398 * The possibles types that the items in a menu can be
13400 typedef enum _Elm_Web_Menu_Item_Type
13402 ELM_WEB_MENU_SEPARATOR,
13403 ELM_WEB_MENU_GROUP,
13404 ELM_WEB_MENU_OPTION
13405 } Elm_Web_Menu_Item_Type;
13408 * Structure describing the items in a menu
13410 typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item;
13412 * Structure describing the items in a menu
13414 struct _Elm_Web_Menu_Item
13416 const char *text; /**< The text for the item */
13417 Elm_Web_Menu_Item_Type type; /**< The type of the item */
13421 * Structure describing the menu of a popup
13423 * This structure will be passed as the @c event_info for the "popup,create"
13424 * signal, which is emitted when a dropdown menu is opened. Users wanting
13425 * to handle these popups by themselves should listen to this signal and
13426 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13427 * property as @c EINA_FALSE means that the user will not handle the popup
13428 * and the default implementation will be used.
13430 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13431 * will be emitted to notify the user that it can destroy any objects and
13432 * free all data related to it.
13434 * @see elm_web_popup_selected_set()
13435 * @see elm_web_popup_destroy()
13437 typedef struct _Elm_Web_Menu Elm_Web_Menu;
13439 * Structure describing the menu of a popup
13441 * This structure will be passed as the @c event_info for the "popup,create"
13442 * signal, which is emitted when a dropdown menu is opened. Users wanting
13443 * to handle these popups by themselves should listen to this signal and
13444 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13445 * property as @c EINA_FALSE means that the user will not handle the popup
13446 * and the default implementation will be used.
13448 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13449 * will be emitted to notify the user that it can destroy any objects and
13450 * free all data related to it.
13452 * @see elm_web_popup_selected_set()
13453 * @see elm_web_popup_destroy()
13455 struct _Elm_Web_Menu
13457 Eina_List *items; /**< List of #Elm_Web_Menu_Item */
13458 int x; /**< The X position of the popup, relative to the elm_web object */
13459 int y; /**< The Y position of the popup, relative to the elm_web object */
13460 int width; /**< Width of the popup menu */
13461 int height; /**< Height of the popup menu */
13463 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. */
13466 typedef struct _Elm_Web_Download Elm_Web_Download;
13467 struct _Elm_Web_Download
13473 * Types of zoom available.
13475 typedef enum _Elm_Web_Zoom_Mode
13477 ELM_WEB_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_web_zoom_set */
13478 ELM_WEB_ZOOM_MODE_AUTO_FIT, /**< Zoom until content fits in web object */
13479 ELM_WEB_ZOOM_MODE_AUTO_FILL, /**< Zoom until content fills web object */
13480 ELM_WEB_ZOOM_MODE_LAST
13481 } Elm_Web_Zoom_Mode;
13483 * Opaque handler containing the features (such as statusbar, menubar, etc)
13484 * that are to be set on a newly requested window.
13486 typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
13488 * Callback type for the create_window hook.
13490 * The function parameters are:
13491 * @li @p data User data pointer set when setting the hook function
13492 * @li @p obj The elm_web object requesting the new window
13493 * @li @p js Set to @c EINA_TRUE if the request was originated from
13494 * JavaScript. @c EINA_FALSE otherwise.
13495 * @li @p window_features A pointer of #Elm_Web_Window_Features indicating
13496 * the features requested for the new window.
13498 * The returned value of the function should be the @c elm_web widget where
13499 * the request will be loaded. That is, if a new window or tab is created,
13500 * the elm_web widget in it should be returned, and @b NOT the window
13502 * Returning @c NULL should cancel the request.
13504 * @see elm_web_window_create_hook_set()
13506 typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
13508 * Callback type for the JS alert hook.
13510 * The function parameters are:
13511 * @li @p data User data pointer set when setting the hook function
13512 * @li @p obj The elm_web object requesting the new window
13513 * @li @p message The message to show in the alert dialog
13515 * The function should return the object representing the alert dialog.
13516 * Elm_Web will run a second main loop to handle the dialog and normal
13517 * flow of the application will be restored when the object is deleted, so
13518 * the user should handle the popup properly in order to delete the object
13519 * when the action is finished.
13520 * If the function returns @c NULL the popup will be ignored.
13522 * @see elm_web_dialog_alert_hook_set()
13524 typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
13526 * Callback type for the JS confirm hook.
13528 * The function parameters are:
13529 * @li @p data User data pointer set when setting the hook function
13530 * @li @p obj The elm_web object requesting the new window
13531 * @li @p message The message to show in the confirm dialog
13532 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13533 * the user selected @c Ok, @c EINA_FALSE otherwise.
13535 * The function should return the object representing the confirm dialog.
13536 * Elm_Web will run a second main loop to handle the dialog and normal
13537 * flow of the application will be restored when the object is deleted, so
13538 * the user should handle the popup properly in order to delete the object
13539 * when the action is finished.
13540 * If the function returns @c NULL the popup will be ignored.
13542 * @see elm_web_dialog_confirm_hook_set()
13544 typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
13546 * Callback type for the JS prompt hook.
13548 * The function parameters are:
13549 * @li @p data User data pointer set when setting the hook function
13550 * @li @p obj The elm_web object requesting the new window
13551 * @li @p message The message to show in the prompt dialog
13552 * @li @p def_value The default value to present the user in the entry
13553 * @li @p value Pointer where to store the value given by the user. Must
13554 * be a malloc'ed string or @c NULL if the user cancelled the popup.
13555 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13556 * the user selected @c Ok, @c EINA_FALSE otherwise.
13558 * The function should return the object representing the prompt dialog.
13559 * Elm_Web will run a second main loop to handle the dialog and normal
13560 * flow of the application will be restored when the object is deleted, so
13561 * the user should handle the popup properly in order to delete the object
13562 * when the action is finished.
13563 * If the function returns @c NULL the popup will be ignored.
13565 * @see elm_web_dialog_prompt_hook_set()
13567 typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret);
13569 * Callback type for the JS file selector hook.
13571 * The function parameters are:
13572 * @li @p data User data pointer set when setting the hook function
13573 * @li @p obj The elm_web object requesting the new window
13574 * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
13575 * @li @p accept_types Mime types accepted
13576 * @li @p selected Pointer where to store the list of malloc'ed strings
13577 * containing the path to each file selected. Must be @c NULL if the file
13578 * dialog is cancelled
13579 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13580 * the user selected @c Ok, @c EINA_FALSE otherwise.
13582 * The function should return the object representing the file selector
13584 * Elm_Web will run a second main loop to handle the dialog and normal
13585 * flow of the application will be restored when the object is deleted, so
13586 * the user should handle the popup properly in order to delete the object
13587 * when the action is finished.
13588 * If the function returns @c NULL the popup will be ignored.
13590 * @see elm_web_dialog_file selector_hook_set()
13592 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);
13594 * Callback type for the JS console message hook.
13596 * When a console message is added from JavaScript, any set function to the
13597 * console message hook will be called for the user to handle. There is no
13598 * default implementation of this hook.
13600 * The function parameters are:
13601 * @li @p data User data pointer set when setting the hook function
13602 * @li @p obj The elm_web object that originated the message
13603 * @li @p message The message sent
13604 * @li @p line_number The line number
13605 * @li @p source_id Source id
13607 * @see elm_web_console_message_hook_set()
13609 typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
13611 * Add a new web object to the parent.
13613 * @param parent The parent object.
13614 * @return The new object or NULL if it cannot be created.
13616 * @see elm_web_uri_set()
13617 * @see elm_web_webkit_view_get()
13619 EAPI Evas_Object *elm_web_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13622 * Get internal ewk_view object from web object.
13624 * Elementary may not provide some low level features of EWebKit,
13625 * instead of cluttering the API with proxy methods we opted to
13626 * return the internal reference. Be careful using it as it may
13627 * interfere with elm_web behavior.
13629 * @param obj The web object.
13630 * @return The internal ewk_view object or NULL if it does not
13631 * exist. (Failure to create or Elementary compiled without
13634 * @see elm_web_add()
13636 EAPI Evas_Object *elm_web_webkit_view_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13639 * Sets the function to call when a new window is requested
13641 * This hook will be called when a request to create a new window is
13642 * issued from the web page loaded.
13643 * There is no default implementation for this feature, so leaving this
13644 * unset or passing @c NULL in @p func will prevent new windows from
13647 * @param obj The web object where to set the hook function
13648 * @param func The hook function to be called when a window is requested
13649 * @param data User data
13651 EAPI void elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data);
13653 * Sets the function to call when an alert dialog
13655 * This hook will be called when a JavaScript alert dialog is requested.
13656 * If no function is set or @c NULL is passed in @p func, the default
13657 * implementation will take place.
13659 * @param obj The web object where to set the hook function
13660 * @param func The callback function to be used
13661 * @param data User data
13663 * @see elm_web_inwin_mode_set()
13665 EAPI void elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data);
13667 * Sets the function to call when an confirm dialog
13669 * This hook will be called when a JavaScript confirm dialog is requested.
13670 * If no function is set or @c NULL is passed in @p func, the default
13671 * implementation will take place.
13673 * @param obj The web object where to set the hook function
13674 * @param func The callback function to be used
13675 * @param data User data
13677 * @see elm_web_inwin_mode_set()
13679 EAPI void elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data);
13681 * Sets the function to call when an prompt dialog
13683 * This hook will be called when a JavaScript prompt dialog is requested.
13684 * If no function is set or @c NULL is passed in @p func, the default
13685 * implementation will take place.
13687 * @param obj The web object where to set the hook function
13688 * @param func The callback function to be used
13689 * @param data User data
13691 * @see elm_web_inwin_mode_set()
13693 EAPI void elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data);
13695 * Sets the function to call when an file selector dialog
13697 * This hook will be called when a JavaScript file selector dialog is
13699 * If no function is set or @c NULL is passed in @p func, the default
13700 * implementation will take place.
13702 * @param obj The web object where to set the hook function
13703 * @param func The callback function to be used
13704 * @param data User data
13706 * @see elm_web_inwin_mode_set()
13708 EAPI void elm_web_dialog_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data);
13710 * Sets the function to call when a console message is emitted from JS
13712 * This hook will be called when a console message is emitted from
13713 * JavaScript. There is no default implementation for this feature.
13715 * @param obj The web object where to set the hook function
13716 * @param func The callback function to be used
13717 * @param data User data
13719 EAPI void elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data);
13721 * Gets the status of the tab propagation
13723 * @param obj The web object to query
13724 * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
13726 * @see elm_web_tab_propagate_set()
13728 EAPI Eina_Bool elm_web_tab_propagate_get(const Evas_Object *obj);
13730 * Sets whether to use tab propagation
13732 * If tab propagation is enabled, whenever the user presses the Tab key,
13733 * Elementary will handle it and switch focus to the next widget.
13734 * The default value is disabled, where WebKit will handle the Tab key to
13735 * cycle focus though its internal objects, jumping to the next widget
13736 * only when that cycle ends.
13738 * @param obj The web object
13739 * @param propagate Whether to propagate Tab keys to Elementary or not
13741 EAPI void elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate);
13743 * Sets the URI for the web object
13745 * It must be a full URI, with resource included, in the form
13746 * http://www.enlightenment.org or file:///tmp/something.html
13748 * @param obj The web object
13749 * @param uri The URI to set
13750 * @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
13752 EAPI Eina_Bool elm_web_uri_set(Evas_Object *obj, const char *uri);
13754 * Gets the current URI for the object
13756 * The returned string must not be freed and is guaranteed to be
13759 * @param obj The web object
13760 * @return A stringshared internal string with the current URI, or NULL on
13763 EAPI const char *elm_web_uri_get(const Evas_Object *obj);
13765 * Gets the current title
13767 * The returned string must not be freed and is guaranteed to be
13770 * @param obj The web object
13771 * @return A stringshared internal string with the current title, or NULL on
13774 EAPI const char *elm_web_title_get(const Evas_Object *obj);
13776 * Sets the background color to be used by the web object
13778 * This is the color that will be used by default when the loaded page
13779 * does not set it's own. Color values are pre-multiplied.
13781 * @param obj The web object
13782 * @param r Red component
13783 * @param g Green component
13784 * @param b Blue component
13785 * @param a Alpha component
13787 EAPI void elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a);
13789 * Gets the background color to be used by the web object
13791 * This is the color that will be used by default when the loaded page
13792 * does not set it's own. Color values are pre-multiplied.
13794 * @param obj The web object
13795 * @param r Red component
13796 * @param g Green component
13797 * @param b Blue component
13798 * @param a Alpha component
13800 EAPI void elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
13802 * Gets a copy of the currently selected text
13804 * The string returned must be freed by the user when it's done with it.
13806 * @param obj The web object
13807 * @return A newly allocated string, or NULL if nothing is selected or an
13810 EAPI char *elm_view_selection_get(const Evas_Object *obj);
13812 * Tells the web object which index in the currently open popup was selected
13814 * When the user handles the popup creation from the "popup,created" signal,
13815 * it needs to tell the web object which item was selected by calling this
13816 * function with the index corresponding to the item.
13818 * @param obj The web object
13819 * @param index The index selected
13821 * @see elm_web_popup_destroy()
13823 EAPI void elm_web_popup_selected_set(Evas_Object *obj, int index);
13825 * Dismisses an open dropdown popup
13827 * When the popup from a dropdown widget is to be dismissed, either after
13828 * selecting an option or to cancel it, this function must be called, which
13829 * will later emit an "popup,willdelete" signal to notify the user that
13830 * any memory and objects related to this popup can be freed.
13832 * @param obj The web object
13833 * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE
13834 * if there was no menu to destroy
13836 EAPI Eina_Bool elm_web_popup_destroy(Evas_Object *obj);
13838 * Searches the given string in a document.
13840 * @param obj The web object where to search the text
13841 * @param string String to search
13842 * @param case_sensitive If search should be case sensitive or not
13843 * @param forward If search is from cursor and on or backwards
13844 * @param wrap If search should wrap at the end
13846 * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not
13849 EAPI Eina_Bool elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
13851 * Marks matches of the given string in a document.
13853 * @param obj The web object where to search text
13854 * @param string String to match
13855 * @param case_sensitive If match should be case sensitive or not
13856 * @param highlight If matches should be highlighted
13857 * @param limit Maximum amount of matches, or zero to unlimited
13859 * @return number of matched @a string
13861 EAPI unsigned int elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
13863 * Clears all marked matches in the document
13865 * @param obj The web object
13867 * @return EINA_TRUE on success, EINA_FALSE otherwise
13869 EAPI Eina_Bool elm_web_text_matches_unmark_all(Evas_Object *obj);
13871 * Sets whether to highlight the matched marks
13873 * If enabled, marks set with elm_web_text_matches_mark() will be
13876 * @param obj The web object
13877 * @param highlight Whether to highlight the marks or not
13879 * @return EINA_TRUE on success, EINA_FALSE otherwise
13881 EAPI Eina_Bool elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight);
13883 * Gets whether highlighting marks is enabled
13885 * @param The web object
13887 * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
13890 EAPI Eina_Bool elm_web_text_matches_highlight_get(const Evas_Object *obj);
13892 * Gets the overall loading progress of the page
13894 * Returns the estimated loading progress of the page, with a value between
13895 * 0.0 and 1.0. This is an estimated progress accounting for all the frames
13896 * included in the page.
13898 * @param The web object
13900 * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
13903 EAPI double elm_web_load_progress_get(const Evas_Object *obj);
13905 * Stops loading the current page
13907 * Cancels the loading of the current page in the web object. This will
13908 * cause a "load,error" signal to be emitted, with the is_cancellation
13909 * flag set to EINA_TRUE.
13911 * @param obj The web object
13913 * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
13915 EAPI Eina_Bool elm_web_stop(Evas_Object *obj);
13917 * Requests a reload of the current document in the object
13919 * @param obj The web object
13921 * @return EINA_TRUE on success, EINA_FALSE otherwise
13923 EAPI Eina_Bool elm_web_reload(Evas_Object *obj);
13925 * Requests a reload of the current document, avoiding any existing caches
13927 * @param obj The web object
13929 * @return EINA_TRUE on success, EINA_FALSE otherwise
13931 EAPI Eina_Bool elm_web_reload_full(Evas_Object *obj);
13933 * Goes back one step in the browsing history
13935 * This is equivalent to calling elm_web_object_navigate(obj, -1);
13937 * @param obj The web object
13939 * @return EINA_TRUE on success, EINA_FALSE otherwise
13941 * @see elm_web_history_enable_set()
13942 * @see elm_web_back_possible()
13943 * @see elm_web_forward()
13944 * @see elm_web_navigate()
13946 EAPI Eina_Bool elm_web_back(Evas_Object *obj);
13948 * Goes forward one step in the browsing history
13950 * This is equivalent to calling elm_web_object_navigate(obj, 1);
13952 * @param obj The web object
13954 * @return EINA_TRUE on success, EINA_FALSE otherwise
13956 * @see elm_web_history_enable_set()
13957 * @see elm_web_forward_possible()
13958 * @see elm_web_back()
13959 * @see elm_web_navigate()
13961 EAPI Eina_Bool elm_web_forward(Evas_Object *obj);
13963 * Jumps the given number of steps in the browsing history
13965 * The @p steps value can be a negative integer to back in history, or a
13966 * positive to move forward.
13968 * @param obj The web object
13969 * @param steps The number of steps to jump
13971 * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
13972 * history exists to jump the given number of steps
13974 * @see elm_web_history_enable_set()
13975 * @see elm_web_navigate_possible()
13976 * @see elm_web_back()
13977 * @see elm_web_forward()
13979 EAPI Eina_Bool elm_web_navigate(Evas_Object *obj, int steps);
13981 * Queries whether it's possible to go back in history
13983 * @param obj The web object
13985 * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
13988 EAPI Eina_Bool elm_web_back_possible(Evas_Object *obj);
13990 * Queries whether it's possible to go forward in history
13992 * @param obj The web object
13994 * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
13997 EAPI Eina_Bool elm_web_forward_possible(Evas_Object *obj);
13999 * Queries whether it's possible to jump the given number of steps
14001 * The @p steps value can be a negative integer to back in history, or a
14002 * positive to move forward.
14004 * @param obj The web object
14005 * @param steps The number of steps to check for
14007 * @return EINA_TRUE if enough history exists to perform the given jump,
14008 * EINA_FALSE otherwise
14010 EAPI Eina_Bool elm_web_navigate_possible(Evas_Object *obj, int steps);
14012 * Gets whether browsing history is enabled for the given object
14014 * @param obj The web object
14016 * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
14018 EAPI Eina_Bool elm_web_history_enable_get(const Evas_Object *obj);
14020 * Enables or disables the browsing history
14022 * @param obj The web object
14023 * @param enable Whether to enable or disable the browsing history
14025 EAPI void elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
14027 * Sets the zoom level of the web object
14029 * Zoom level matches the Webkit API, so 1.0 means normal zoom, with higher
14030 * values meaning zoom in and lower meaning zoom out. This function will
14031 * only affect the zoom level if the mode set with elm_web_zoom_mode_set()
14032 * is ::ELM_WEB_ZOOM_MODE_MANUAL.
14034 * @param obj The web object
14035 * @param zoom The zoom level to set
14037 EAPI void elm_web_zoom_set(Evas_Object *obj, double zoom);
14039 * Gets the current zoom level set on the web object
14041 * Note that this is the zoom level set on the web object and not that
14042 * of the underlying Webkit one. In the ::ELM_WEB_ZOOM_MODE_MANUAL mode,
14043 * the two zoom levels should match, but for the other two modes the
14044 * Webkit zoom is calculated internally to match the chosen mode without
14045 * changing the zoom level set for the web object.
14047 * @param obj The web object
14049 * @return The zoom level set on the object
14051 EAPI double elm_web_zoom_get(const Evas_Object *obj);
14053 * Sets the zoom mode to use
14055 * The modes can be any of those defined in ::Elm_Web_Zoom_Mode, except
14056 * ::ELM_WEB_ZOOM_MODE_LAST. The default is ::ELM_WEB_ZOOM_MODE_MANUAL.
14058 * ::ELM_WEB_ZOOM_MODE_MANUAL means the zoom level will be controlled
14059 * with the elm_web_zoom_set() function.
14060 * ::ELM_WEB_ZOOM_MODE_AUTO_FIT will calculate the needed zoom level to
14061 * make sure the entirety of the web object's contents are shown.
14062 * ::ELM_WEB_ZOOM_MODE_AUTO_FILL will calculate the needed zoom level to
14063 * fit the contents in the web object's size, without leaving any space
14066 * @param obj The web object
14067 * @param mode The mode to set
14069 EAPI void elm_web_zoom_mode_set(Evas_Object *obj, Elm_Web_Zoom_Mode mode);
14071 * Gets the currently set zoom mode
14073 * @param obj The web object
14075 * @return The current zoom mode set for the object, or
14076 * ::ELM_WEB_ZOOM_MODE_LAST on error
14078 EAPI Elm_Web_Zoom_Mode elm_web_zoom_mode_get(const Evas_Object *obj);
14080 * Shows the given region in the web object
14082 * @param obj The web object
14083 * @param x The x coordinate of the region to show
14084 * @param y The y coordinate of the region to show
14085 * @param w The width of the region to show
14086 * @param h The height of the region to show
14088 EAPI void elm_web_region_show(Evas_Object *obj, int x, int y, int w, int h);
14090 * Brings in the region to the visible area
14092 * Like elm_web_region_show(), but it animates the scrolling of the object
14095 * @param obj The web object
14096 * @param x The x coordinate of the region to show
14097 * @param y The y coordinate of the region to show
14098 * @param w The width of the region to show
14099 * @param h The height of the region to show
14101 EAPI void elm_web_region_bring_in(Evas_Object *obj, int x, int y, int w, int h);
14103 * Sets the default dialogs to use an Inwin instead of a normal window
14105 * If set, then the default implementation for the JavaScript dialogs and
14106 * file selector will be opened in an Inwin. Otherwise they will use a
14107 * normal separated window.
14109 * @param obj The web object
14110 * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
14112 EAPI void elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
14114 * Gets whether Inwin mode is set for the current object
14116 * @param obj The web object
14118 * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
14120 EAPI Eina_Bool elm_web_inwin_mode_get(const Evas_Object *obj);
14122 EAPI void elm_web_window_features_ref(Elm_Web_Window_Features *wf);
14123 EAPI void elm_web_window_features_unref(Elm_Web_Window_Features *wf);
14124 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);
14125 EAPI void elm_web_window_features_int_property_get(const Elm_Web_Window_Features *wf, int *x, int *y, int *w, int *h);
14132 * @defgroup Hoversel Hoversel
14134 * @image html img/widget/hoversel/preview-00.png
14135 * @image latex img/widget/hoversel/preview-00.eps
14137 * A hoversel is a button that pops up a list of items (automatically
14138 * choosing the direction to display) that have a label and, optionally, an
14139 * icon to select from. It is a convenience widget to avoid the need to do
14140 * all the piecing together yourself. It is intended for a small number of
14141 * items in the hoversel menu (no more than 8), though is capable of many
14144 * Signals that you can add callbacks for are:
14145 * "clicked" - the user clicked the hoversel button and popped up the sel
14146 * "selected" - an item in the hoversel list is selected. event_info is the item
14147 * "dismissed" - the hover is dismissed
14149 * See @ref tutorial_hoversel for an example.
14152 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
14154 * @brief Add a new Hoversel object
14156 * @param parent The parent object
14157 * @return The new object or NULL if it cannot be created
14159 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14161 * @brief This sets the hoversel to expand horizontally.
14163 * @param obj The hoversel object
14164 * @param horizontal If true, the hover will expand horizontally to the
14167 * @note The initial button will display horizontally regardless of this
14170 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14172 * @brief This returns whether the hoversel is set to expand horizontally.
14174 * @param obj The hoversel object
14175 * @return If true, the hover will expand horizontally to the right.
14177 * @see elm_hoversel_horizontal_set()
14179 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14181 * @brief Set the Hover parent
14183 * @param obj The hoversel object
14184 * @param parent The parent to use
14186 * Sets the hover parent object, the area that will be darkened when the
14187 * hoversel is clicked. Should probably be the window that the hoversel is
14188 * in. See @ref Hover objects for more information.
14190 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14192 * @brief Get the Hover parent
14194 * @param obj The hoversel object
14195 * @return The used parent
14197 * Gets the hover parent object.
14199 * @see elm_hoversel_hover_parent_set()
14201 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14203 * @brief Set the hoversel button label
14205 * @param obj The hoversel object
14206 * @param label The label text.
14208 * This sets the label of the button that is always visible (before it is
14209 * clicked and expanded).
14211 * @deprecated elm_object_text_set()
14213 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14215 * @brief Get the hoversel button label
14217 * @param obj The hoversel object
14218 * @return The label text.
14220 * @deprecated elm_object_text_get()
14222 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14224 * @brief Set the icon of the hoversel button
14226 * @param obj The hoversel object
14227 * @param icon The icon object
14229 * Sets the icon of the button that is always visible (before it is clicked
14230 * and expanded). Once the icon object is set, a previously set one will be
14231 * deleted, if you want to keep that old content object, use the
14232 * elm_hoversel_icon_unset() function.
14234 * @see elm_object_content_set() for the button widget
14236 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
14238 * @brief Get the icon of the hoversel button
14240 * @param obj The hoversel object
14241 * @return The icon object
14243 * Get the icon of the button that is always visible (before it is clicked
14244 * and expanded). Also see elm_object_content_get() for the button widget.
14246 * @see elm_hoversel_icon_set()
14248 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14250 * @brief Get and unparent the icon of the hoversel button
14252 * @param obj The hoversel object
14253 * @return The icon object that was being used
14255 * Unparent and return the icon of the button that is always visible
14256 * (before it is clicked and expanded).
14258 * @see elm_hoversel_icon_set()
14259 * @see elm_object_content_unset() for the button widget
14261 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14263 * @brief This triggers the hoversel popup from code, the same as if the user
14264 * had clicked the button.
14266 * @param obj The hoversel object
14268 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
14270 * @brief This dismisses the hoversel popup as if the user had clicked
14271 * outside the hover.
14273 * @param obj The hoversel object
14275 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
14277 * @brief Returns whether the hoversel is expanded.
14279 * @param obj The hoversel object
14280 * @return This will return EINA_TRUE if the hoversel is expanded or
14281 * EINA_FALSE if it is not expanded.
14283 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14285 * @brief This will remove all the children items from the hoversel.
14287 * @param obj The hoversel object
14289 * @warning Should @b not be called while the hoversel is active; use
14290 * elm_hoversel_expanded_get() to check first.
14292 * @see elm_hoversel_item_del_cb_set()
14293 * @see elm_hoversel_item_del()
14295 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14297 * @brief Get the list of items within the given hoversel.
14299 * @param obj The hoversel object
14300 * @return Returns a list of Elm_Hoversel_Item*
14302 * @see elm_hoversel_item_add()
14304 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14306 * @brief Add an item to the hoversel button
14308 * @param obj The hoversel object
14309 * @param label The text label to use for the item (NULL if not desired)
14310 * @param icon_file An image file path on disk to use for the icon or standard
14311 * icon name (NULL if not desired)
14312 * @param icon_type The icon type if relevant
14313 * @param func Convenience function to call when this item is selected
14314 * @param data Data to pass to item-related functions
14315 * @return A handle to the item added.
14317 * This adds an item to the hoversel to show when it is clicked. Note: if you
14318 * need to use an icon from an edje file then use
14319 * elm_hoversel_item_icon_set() right after the this function, and set
14320 * icon_file to NULL here.
14322 * For more information on what @p icon_file and @p icon_type are see the
14323 * @ref Icon "icon documentation".
14325 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);
14327 * @brief Delete an item from the hoversel
14329 * @param item The item to delete
14331 * This deletes the item from the hoversel (should not be called while the
14332 * hoversel is active; use elm_hoversel_expanded_get() to check first).
14334 * @see elm_hoversel_item_add()
14335 * @see elm_hoversel_item_del_cb_set()
14337 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
14339 * @brief Set the function to be called when an item from the hoversel is
14342 * @param item The item to set the callback on
14343 * @param func The function called
14345 * That function will receive these parameters:
14346 * @li void *item_data
14347 * @li Evas_Object *the_item_object
14348 * @li Elm_Hoversel_Item *the_object_struct
14350 * @see elm_hoversel_item_add()
14352 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14354 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
14355 * that will be passed to associated function callbacks.
14357 * @param item The item to get the data from
14358 * @return The data pointer set with elm_hoversel_item_add()
14360 * @see elm_hoversel_item_add()
14362 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14364 * @brief This returns the label text of the given hoversel item.
14366 * @param item The item to get the label
14367 * @return The label text of the hoversel item
14369 * @see elm_hoversel_item_add()
14371 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14373 * @brief This sets the icon for the given hoversel item.
14375 * @param item The item to set the icon
14376 * @param icon_file An image file path on disk to use for the icon or standard
14378 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
14379 * to NULL if the icon is not an edje file
14380 * @param icon_type The icon type
14382 * The icon can be loaded from the standard set, from an image file, or from
14385 * @see elm_hoversel_item_add()
14387 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);
14389 * @brief Get the icon object of the hoversel item
14391 * @param item The item to get the icon from
14392 * @param icon_file The image file path on disk used for the icon or standard
14394 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
14395 * if the icon is not an edje file
14396 * @param icon_type The icon type
14398 * @see elm_hoversel_item_icon_set()
14399 * @see elm_hoversel_item_add()
14401 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);
14407 * @defgroup Toolbar Toolbar
14408 * @ingroup Elementary
14410 * @image html img/widget/toolbar/preview-00.png
14411 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
14413 * @image html img/toolbar.png
14414 * @image latex img/toolbar.eps width=\textwidth
14416 * A toolbar is a widget that displays a list of items inside
14417 * a box. It can be scrollable, show a menu with items that don't fit
14418 * to toolbar size or even crop them.
14420 * Only one item can be selected at a time.
14422 * Items can have multiple states, or show menus when selected by the user.
14424 * Smart callbacks one can listen to:
14425 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
14426 * - "language,changed" - when the program language changes
14428 * Available styles for it:
14430 * - @c "transparent" - no background or shadow, just show the content
14432 * List of examples:
14433 * @li @ref toolbar_example_01
14434 * @li @ref toolbar_example_02
14435 * @li @ref toolbar_example_03
14439 * @addtogroup Toolbar
14444 * @enum _Elm_Toolbar_Shrink_Mode
14445 * @typedef Elm_Toolbar_Shrink_Mode
14447 * Set toolbar's items display behavior, it can be scrollabel,
14448 * show a menu with exceeding items, or simply hide them.
14450 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
14453 * Values <b> don't </b> work as bitmask, only one can be choosen.
14455 * @see elm_toolbar_mode_shrink_set()
14456 * @see elm_toolbar_mode_shrink_get()
14460 typedef enum _Elm_Toolbar_Shrink_Mode
14462 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
14463 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
14464 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
14465 ELM_TOOLBAR_SHRINK_MENU, /**< Inserts a button to pop up a menu with exceeding items. */
14466 ELM_TOOLBAR_SHRINK_LAST /**< Indicates error if returned by elm_toolbar_shrink_mode_get() */
14467 } Elm_Toolbar_Shrink_Mode;
14469 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(). */
14471 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(). */
14474 * Add a new toolbar widget to the given parent Elementary
14475 * (container) object.
14477 * @param parent The parent object.
14478 * @return a new toolbar widget handle or @c NULL, on errors.
14480 * This function inserts a new toolbar widget on the canvas.
14484 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14487 * Set the icon size, in pixels, to be used by toolbar items.
14489 * @param obj The toolbar object
14490 * @param icon_size The icon size in pixels
14492 * @note Default value is @c 32. It reads value from elm config.
14494 * @see elm_toolbar_icon_size_get()
14498 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
14501 * Get the icon size, in pixels, to be used by toolbar items.
14503 * @param obj The toolbar object.
14504 * @return The icon size in pixels.
14506 * @see elm_toolbar_icon_size_set() for details.
14510 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14513 * Sets icon lookup order, for toolbar items' icons.
14515 * @param obj The toolbar object.
14516 * @param order The icon lookup order.
14518 * Icons added before calling this function will not be affected.
14519 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
14521 * @see elm_toolbar_icon_order_lookup_get()
14525 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
14528 * Gets the icon lookup order.
14530 * @param obj The toolbar object.
14531 * @return The icon lookup order.
14533 * @see elm_toolbar_icon_order_lookup_set() for details.
14537 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14540 * Set whether the toolbar should always have an item selected.
14542 * @param obj The toolbar object.
14543 * @param wrap @c EINA_TRUE to enable always-select mode or @c EINA_FALSE to
14546 * This will cause the toolbar to always have an item selected, and clicking
14547 * the selected item will not cause a selected event to be emitted. Enabling this mode
14548 * will immediately select the first toolbar item.
14550 * Always-selected is disabled by default.
14552 * @see elm_toolbar_always_select_mode_get().
14556 EAPI void elm_toolbar_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14559 * Get whether the toolbar should always have an item selected.
14561 * @param obj The toolbar object.
14562 * @return @c EINA_TRUE means an item will always be selected, @c EINA_FALSE indicates
14563 * that it is possible to have no items selected. If @p obj is @c NULL, @c EINA_FALSE is returned.
14565 * @see elm_toolbar_always_select_mode_set() for details.
14569 EAPI Eina_Bool elm_toolbar_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14572 * Set whether the toolbar items' should be selected by the user or not.
14574 * @param obj The toolbar object.
14575 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
14578 * This will turn off the ability to select items entirely and they will
14579 * neither appear selected nor emit selected signals. The clicked
14580 * callback function will still be called.
14582 * Selection is enabled by default.
14584 * @see elm_toolbar_no_select_mode_get().
14588 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14591 * Set whether the toolbar items' should be selected by the user or not.
14593 * @param obj The toolbar object.
14594 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
14595 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
14597 * @see elm_toolbar_no_select_mode_set() for details.
14601 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14604 * Append item to the toolbar.
14606 * @param obj The toolbar object.
14607 * @param icon A string with icon name or the absolute path of an image file.
14608 * @param label The label of the item.
14609 * @param func The function to call when the item is clicked.
14610 * @param data The data to associate with the item for related callbacks.
14611 * @return The created item or @c NULL upon failure.
14613 * A new item will be created and appended to the toolbar, i.e., will
14614 * be set as @b last item.
14616 * Items created with this method can be deleted with
14617 * elm_toolbar_item_del().
14619 * Associated @p data can be properly freed when item is deleted if a
14620 * callback function is set with elm_toolbar_item_del_cb_set().
14622 * If a function is passed as argument, it will be called everytime this item
14623 * is selected, i.e., the user clicks over an unselected item.
14624 * If such function isn't needed, just passing
14625 * @c NULL as @p func is enough. The same should be done for @p data.
14627 * Toolbar will load icon image from fdo or current theme.
14628 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14629 * If an absolute path is provided it will load it direct from a file.
14631 * @see elm_toolbar_item_icon_set()
14632 * @see elm_toolbar_item_del()
14633 * @see elm_toolbar_item_del_cb_set()
14637 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);
14640 * Prepend item to the toolbar.
14642 * @param obj The toolbar object.
14643 * @param icon A string with icon name or the absolute path of an image file.
14644 * @param label The label of the item.
14645 * @param func The function to call when the item is clicked.
14646 * @param data The data to associate with the item for related callbacks.
14647 * @return The created item or @c NULL upon failure.
14649 * A new item will be created and prepended to the toolbar, i.e., will
14650 * be set as @b first item.
14652 * Items created with this method can be deleted with
14653 * elm_toolbar_item_del().
14655 * Associated @p data can be properly freed when item is deleted if a
14656 * callback function is set with elm_toolbar_item_del_cb_set().
14658 * If a function is passed as argument, it will be called everytime this item
14659 * is selected, i.e., the user clicks over an unselected item.
14660 * If such function isn't needed, just passing
14661 * @c NULL as @p func is enough. The same should be done for @p data.
14663 * Toolbar will load icon image from fdo or current theme.
14664 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14665 * If an absolute path is provided it will load it direct from a file.
14667 * @see elm_toolbar_item_icon_set()
14668 * @see elm_toolbar_item_del()
14669 * @see elm_toolbar_item_del_cb_set()
14673 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);
14676 * Insert a new item into the toolbar object before item @p before.
14678 * @param obj The toolbar object.
14679 * @param before The toolbar item to insert before.
14680 * @param icon A string with icon name or the absolute path of an image file.
14681 * @param label The label of the item.
14682 * @param func The function to call when the item is clicked.
14683 * @param data The data to associate with the item for related callbacks.
14684 * @return The created item or @c NULL upon failure.
14686 * A new item will be created and added to the toolbar. Its position in
14687 * this toolbar will be just before item @p before.
14689 * Items created with this method can be deleted with
14690 * elm_toolbar_item_del().
14692 * Associated @p data can be properly freed when item is deleted if a
14693 * callback function is set with elm_toolbar_item_del_cb_set().
14695 * If a function is passed as argument, it will be called everytime this item
14696 * is selected, i.e., the user clicks over an unselected item.
14697 * If such function isn't needed, just passing
14698 * @c NULL as @p func is enough. The same should be done for @p data.
14700 * Toolbar will load icon image from fdo or current theme.
14701 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14702 * If an absolute path is provided it will load it direct from a file.
14704 * @see elm_toolbar_item_icon_set()
14705 * @see elm_toolbar_item_del()
14706 * @see elm_toolbar_item_del_cb_set()
14710 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);
14713 * Insert a new item into the toolbar object after item @p after.
14715 * @param obj The toolbar object.
14716 * @param after The toolbar item to insert after.
14717 * @param icon A string with icon name or the absolute path of an image file.
14718 * @param label The label of the item.
14719 * @param func The function to call when the item is clicked.
14720 * @param data The data to associate with the item for related callbacks.
14721 * @return The created item or @c NULL upon failure.
14723 * A new item will be created and added to the toolbar. Its position in
14724 * this toolbar will be just after item @p after.
14726 * Items created with this method can be deleted with
14727 * elm_toolbar_item_del().
14729 * Associated @p data can be properly freed when item is deleted if a
14730 * callback function is set with elm_toolbar_item_del_cb_set().
14732 * If a function is passed as argument, it will be called everytime this item
14733 * is selected, i.e., the user clicks over an unselected item.
14734 * If such function isn't needed, just passing
14735 * @c NULL as @p func is enough. The same should be done for @p data.
14737 * Toolbar will load icon image from fdo or current theme.
14738 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14739 * If an absolute path is provided it will load it direct from a file.
14741 * @see elm_toolbar_item_icon_set()
14742 * @see elm_toolbar_item_del()
14743 * @see elm_toolbar_item_del_cb_set()
14747 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);
14750 * Get the first item in the given toolbar widget's list of
14753 * @param obj The toolbar object
14754 * @return The first item or @c NULL, if it has no items (and on
14757 * @see elm_toolbar_item_append()
14758 * @see elm_toolbar_last_item_get()
14762 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14765 * Get the last item in the given toolbar widget's list of
14768 * @param obj The toolbar object
14769 * @return The last item or @c NULL, if it has no items (and on
14772 * @see elm_toolbar_item_prepend()
14773 * @see elm_toolbar_first_item_get()
14777 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14780 * Get the item after @p item in toolbar.
14782 * @param item The toolbar item.
14783 * @return The item after @p item, or @c NULL if none or on failure.
14785 * @note If it is the last item, @c NULL will be returned.
14787 * @see elm_toolbar_item_append()
14791 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14794 * Get the item before @p item in toolbar.
14796 * @param item The toolbar item.
14797 * @return The item before @p item, or @c NULL if none or on failure.
14799 * @note If it is the first item, @c NULL will be returned.
14801 * @see elm_toolbar_item_prepend()
14805 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14808 * Get the toolbar object from an item.
14810 * @param item The item.
14811 * @return The toolbar object.
14813 * This returns the toolbar object itself that an item belongs to.
14817 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14820 * Set the priority of a toolbar item.
14822 * @param item The toolbar item.
14823 * @param priority The item priority. The default is zero.
14825 * This is used only when the toolbar shrink mode is set to
14826 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
14827 * When space is less than required, items with low priority
14828 * will be removed from the toolbar and added to a dynamically-created menu,
14829 * while items with higher priority will remain on the toolbar,
14830 * with the same order they were added.
14832 * @see elm_toolbar_item_priority_get()
14836 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
14839 * Get the priority of a toolbar item.
14841 * @param item The toolbar item.
14842 * @return The @p item priority, or @c 0 on failure.
14844 * @see elm_toolbar_item_priority_set() for details.
14848 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14851 * Get the label of item.
14853 * @param item The item of toolbar.
14854 * @return The label of item.
14856 * The return value is a pointer to the label associated to @p item when
14857 * it was created, with function elm_toolbar_item_append() or similar,
14859 * with function elm_toolbar_item_label_set. If no label
14860 * was passed as argument, it will return @c NULL.
14862 * @see elm_toolbar_item_label_set() for more details.
14863 * @see elm_toolbar_item_append()
14867 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14870 * Set the label of item.
14872 * @param item The item of toolbar.
14873 * @param text The label of item.
14875 * The label to be displayed by the item.
14876 * Label will be placed at icons bottom (if set).
14878 * If a label was passed as argument on item creation, with function
14879 * elm_toolbar_item_append() or similar, it will be already
14880 * displayed by the item.
14882 * @see elm_toolbar_item_label_get()
14883 * @see elm_toolbar_item_append()
14887 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
14890 * Return the data associated with a given toolbar widget item.
14892 * @param item The toolbar widget item handle.
14893 * @return The data associated with @p item.
14895 * @see elm_toolbar_item_data_set()
14899 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14902 * Set the data associated with a given toolbar widget item.
14904 * @param item The toolbar widget item handle.
14905 * @param data The new data pointer to set to @p item.
14907 * This sets new item data on @p item.
14909 * @warning The old data pointer won't be touched by this function, so
14910 * the user had better to free that old data himself/herself.
14914 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
14917 * Returns a pointer to a toolbar item by its label.
14919 * @param obj The toolbar object.
14920 * @param label The label of the item to find.
14922 * @return The pointer to the toolbar item matching @p label or @c NULL
14927 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14930 * Get whether the @p item is selected or not.
14932 * @param item The toolbar item.
14933 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
14934 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
14936 * @see elm_toolbar_selected_item_set() for details.
14937 * @see elm_toolbar_item_selected_get()
14941 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14944 * Set the selected state of an item.
14946 * @param item The toolbar item
14947 * @param selected The selected state
14949 * This sets the selected state of the given item @p it.
14950 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
14952 * If a new item is selected the previosly selected will be unselected.
14953 * Previoulsy selected item can be get with function
14954 * elm_toolbar_selected_item_get().
14956 * Selected items will be highlighted.
14958 * @see elm_toolbar_item_selected_get()
14959 * @see elm_toolbar_selected_item_get()
14963 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14966 * Get the selected item.
14968 * @param obj The toolbar object.
14969 * @return The selected toolbar item.
14971 * The selected item can be unselected with function
14972 * elm_toolbar_item_selected_set().
14974 * The selected item always will be highlighted on toolbar.
14976 * @see elm_toolbar_selected_items_get()
14980 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14983 * Set the icon associated with @p item.
14985 * @param obj The parent of this item.
14986 * @param item The toolbar item.
14987 * @param icon A string with icon name or the absolute path of an image file.
14989 * Toolbar will load icon image from fdo or current theme.
14990 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14991 * If an absolute path is provided it will load it direct from a file.
14993 * @see elm_toolbar_icon_order_lookup_set()
14994 * @see elm_toolbar_icon_order_lookup_get()
14998 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
15001 * Get the string used to set the icon of @p item.
15003 * @param item The toolbar item.
15004 * @return The string associated with the icon object.
15006 * @see elm_toolbar_item_icon_set() for details.
15010 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15013 * Get the object of @p item.
15015 * @param item The toolbar item.
15016 * @return The object
15020 EAPI Evas_Object *elm_toolbar_item_object_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15023 * Get the icon object of @p item.
15025 * @param item The toolbar item.
15026 * @return The icon object
15028 * @see elm_toolbar_item_icon_set() or elm_toolbar_item_icon_memfile_set() for details.
15032 EAPI Evas_Object *elm_toolbar_item_icon_object_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15035 * Set the icon associated with @p item to an image in a binary buffer.
15037 * @param item The toolbar item.
15038 * @param img The binary data that will be used as an image
15039 * @param size The size of binary data @p img
15040 * @param format Optional format of @p img to pass to the image loader
15041 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
15043 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
15045 * @note The icon image set by this function can be changed by
15046 * elm_toolbar_item_icon_set().
15050 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);
15053 * Delete them item from the toolbar.
15055 * @param item The item of toolbar to be deleted.
15057 * @see elm_toolbar_item_append()
15058 * @see elm_toolbar_item_del_cb_set()
15062 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15065 * Set the function called when a toolbar item is freed.
15067 * @param item The item to set the callback on.
15068 * @param func The function called.
15070 * If there is a @p func, then it will be called prior item's memory release.
15071 * That will be called with the following arguments:
15073 * @li item's Evas object;
15076 * This way, a data associated to a toolbar item could be properly freed.
15080 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15083 * Get a value whether toolbar item is disabled or not.
15085 * @param item The item.
15086 * @return The disabled state.
15088 * @see elm_toolbar_item_disabled_set() for more details.
15092 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15095 * Sets the disabled/enabled state of a toolbar item.
15097 * @param item The item.
15098 * @param disabled The disabled state.
15100 * A disabled item cannot be selected or unselected. It will also
15101 * change its appearance (generally greyed out). This sets the
15102 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
15107 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15110 * Set or unset item as a separator.
15112 * @param item The toolbar item.
15113 * @param setting @c EINA_TRUE to set item @p item as separator or
15114 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
15116 * Items aren't set as separator by default.
15118 * If set as separator it will display separator theme, so won't display
15121 * @see elm_toolbar_item_separator_get()
15125 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
15128 * Get a value whether item is a separator or not.
15130 * @param item The toolbar item.
15131 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
15132 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
15134 * @see elm_toolbar_item_separator_set() for details.
15138 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15141 * Set the shrink state of toolbar @p obj.
15143 * @param obj The toolbar object.
15144 * @param shrink_mode Toolbar's items display behavior.
15146 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
15147 * but will enforce a minimun size so all the items will fit, won't scroll
15148 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
15149 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
15150 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
15154 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
15157 * Get the shrink mode of toolbar @p obj.
15159 * @param obj The toolbar object.
15160 * @return Toolbar's items display behavior.
15162 * @see elm_toolbar_mode_shrink_set() for details.
15166 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15169 * Enable/disable homogenous mode.
15171 * @param obj The toolbar object
15172 * @param homogeneous Assume the items within the toolbar are of the
15173 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15175 * This will enable the homogeneous mode where items are of the same size.
15176 * @see elm_toolbar_homogeneous_get()
15180 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
15183 * Get whether the homogenous mode is enabled.
15185 * @param obj The toolbar object.
15186 * @return Assume the items within the toolbar are of the same height
15187 * and width (EINA_TRUE = on, EINA_FALSE = off).
15189 * @see elm_toolbar_homogeneous_set()
15193 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15196 * Enable/disable homogenous mode.
15198 * @param obj The toolbar object
15199 * @param homogeneous Assume the items within the toolbar are of the
15200 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15202 * This will enable the homogeneous mode where items are of the same size.
15203 * @see elm_toolbar_homogeneous_get()
15205 * @deprecated use elm_toolbar_homogeneous_set() instead.
15209 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
15212 * Get whether the homogenous mode is enabled.
15214 * @param obj The toolbar object.
15215 * @return Assume the items within the toolbar are of the same height
15216 * and width (EINA_TRUE = on, EINA_FALSE = off).
15218 * @see elm_toolbar_homogeneous_set()
15219 * @deprecated use elm_toolbar_homogeneous_get() instead.
15223 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15226 * Set the parent object of the toolbar items' menus.
15228 * @param obj The toolbar object.
15229 * @param parent The parent of the menu objects.
15231 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
15233 * For more details about setting the parent for toolbar menus, see
15234 * elm_menu_parent_set().
15236 * @see elm_menu_parent_set() for details.
15237 * @see elm_toolbar_item_menu_set() for details.
15241 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15244 * Get the parent object of the toolbar items' menus.
15246 * @param obj The toolbar object.
15247 * @return The parent of the menu objects.
15249 * @see elm_toolbar_menu_parent_set() for details.
15253 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15256 * Set the alignment of the items.
15258 * @param obj The toolbar object.
15259 * @param align The new alignment, a float between <tt> 0.0 </tt>
15260 * and <tt> 1.0 </tt>.
15262 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
15263 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
15266 * Centered items by default.
15268 * @see elm_toolbar_align_get()
15272 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
15275 * Get the alignment of the items.
15277 * @param obj The toolbar object.
15278 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
15281 * @see elm_toolbar_align_set() for details.
15285 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15288 * Set whether the toolbar item opens a menu.
15290 * @param item The toolbar item.
15291 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
15293 * A toolbar item can be set to be a menu, using this function.
15295 * Once it is set to be a menu, it can be manipulated through the
15296 * menu-like function elm_toolbar_menu_parent_set() and the other
15297 * elm_menu functions, using the Evas_Object @c menu returned by
15298 * elm_toolbar_item_menu_get().
15300 * So, items to be displayed in this item's menu should be added with
15301 * elm_menu_item_add().
15303 * The following code exemplifies the most basic usage:
15305 * tb = elm_toolbar_add(win)
15306 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
15307 * elm_toolbar_item_menu_set(item, EINA_TRUE);
15308 * elm_toolbar_menu_parent_set(tb, win);
15309 * menu = elm_toolbar_item_menu_get(item);
15310 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
15311 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
15315 * @see elm_toolbar_item_menu_get()
15319 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
15322 * Get toolbar item's menu.
15324 * @param item The toolbar item.
15325 * @return Item's menu object or @c NULL on failure.
15327 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
15328 * this function will set it.
15330 * @see elm_toolbar_item_menu_set() for details.
15334 EAPI Evas_Object *elm_toolbar_item_menu_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15337 * Add a new state to @p item.
15339 * @param item The item.
15340 * @param icon A string with icon name or the absolute path of an image file.
15341 * @param label The label of the new state.
15342 * @param func The function to call when the item is clicked when this
15343 * state is selected.
15344 * @param data The data to associate with the state.
15345 * @return The toolbar item state, or @c NULL upon failure.
15347 * Toolbar will load icon image from fdo or current theme.
15348 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15349 * If an absolute path is provided it will load it direct from a file.
15351 * States created with this function can be removed with
15352 * elm_toolbar_item_state_del().
15354 * @see elm_toolbar_item_state_del()
15355 * @see elm_toolbar_item_state_sel()
15356 * @see elm_toolbar_item_state_get()
15360 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);
15363 * Delete a previoulsy added state to @p item.
15365 * @param item The toolbar item.
15366 * @param state The state to be deleted.
15367 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15369 * @see elm_toolbar_item_state_add()
15371 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15374 * Set @p state as the current state of @p it.
15376 * @param it The item.
15377 * @param state The state to use.
15378 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15380 * If @p state is @c NULL, it won't select any state and the default item's
15381 * icon and label will be used. It's the same behaviour than
15382 * elm_toolbar_item_state_unser().
15384 * @see elm_toolbar_item_state_unset()
15388 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15391 * Unset the state of @p it.
15393 * @param it The item.
15395 * The default icon and label from this item will be displayed.
15397 * @see elm_toolbar_item_state_set() for more details.
15401 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15404 * Get the current state of @p it.
15406 * @param item The item.
15407 * @return The selected state or @c NULL if none is selected or on failure.
15409 * @see elm_toolbar_item_state_set() for details.
15410 * @see elm_toolbar_item_state_unset()
15411 * @see elm_toolbar_item_state_add()
15415 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15418 * Get the state after selected state in toolbar's @p item.
15420 * @param it The toolbar item to change state.
15421 * @return The state after current state, or @c NULL on failure.
15423 * If last state is selected, this function will return first state.
15425 * @see elm_toolbar_item_state_set()
15426 * @see elm_toolbar_item_state_add()
15430 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15433 * Get the state before selected state in toolbar's @p item.
15435 * @param it The toolbar item to change state.
15436 * @return The state before current state, or @c NULL on failure.
15438 * If first state is selected, this function will return last state.
15440 * @see elm_toolbar_item_state_set()
15441 * @see elm_toolbar_item_state_add()
15445 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15448 * Set the text to be shown in a given toolbar item's tooltips.
15450 * @param item Target item.
15451 * @param text The text to set in the content.
15453 * Setup the text as tooltip to object. The item can have only one tooltip,
15454 * so any previous tooltip data - set with this function or
15455 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
15457 * @see elm_object_tooltip_text_set() for more details.
15461 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
15464 * Set the content to be shown in the tooltip item.
15466 * Setup the tooltip to item. The item can have only one tooltip,
15467 * so any previous tooltip data is removed. @p func(with @p data) will
15468 * be called every time that need show the tooltip and it should
15469 * return a valid Evas_Object. This object is then managed fully by
15470 * tooltip system and is deleted when the tooltip is gone.
15472 * @param item the toolbar item being attached a tooltip.
15473 * @param func the function used to create the tooltip contents.
15474 * @param data what to provide to @a func as callback data/context.
15475 * @param del_cb called when data is not needed anymore, either when
15476 * another callback replaces @a func, the tooltip is unset with
15477 * elm_toolbar_item_tooltip_unset() or the owner @a item
15478 * dies. This callback receives as the first parameter the
15479 * given @a data, and @c event_info is the item.
15481 * @see elm_object_tooltip_content_cb_set() for more details.
15485 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);
15488 * Unset tooltip from item.
15490 * @param item toolbar item to remove previously set tooltip.
15492 * Remove tooltip from item. The callback provided as del_cb to
15493 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
15494 * it is not used anymore.
15496 * @see elm_object_tooltip_unset() for more details.
15497 * @see elm_toolbar_item_tooltip_content_cb_set()
15501 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15504 * Sets a different style for this item tooltip.
15506 * @note before you set a style you should define a tooltip with
15507 * elm_toolbar_item_tooltip_content_cb_set() or
15508 * elm_toolbar_item_tooltip_text_set()
15510 * @param item toolbar item with tooltip already set.
15511 * @param style the theme style to use (default, transparent, ...)
15513 * @see elm_object_tooltip_style_set() for more details.
15517 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15520 * Get the style for this item tooltip.
15522 * @param item toolbar item with tooltip already set.
15523 * @return style the theme style in use, defaults to "default". If the
15524 * object does not have a tooltip set, then NULL is returned.
15526 * @see elm_object_tooltip_style_get() for more details.
15527 * @see elm_toolbar_item_tooltip_style_set()
15531 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15534 * Set the type of mouse pointer/cursor decoration to be shown,
15535 * when the mouse pointer is over the given toolbar widget item
15537 * @param item toolbar item to customize cursor on
15538 * @param cursor the cursor type's name
15540 * This function works analogously as elm_object_cursor_set(), but
15541 * here the cursor's changing area is restricted to the item's
15542 * area, and not the whole widget's. Note that that item cursors
15543 * have precedence over widget cursors, so that a mouse over an
15544 * item with custom cursor set will always show @b that cursor.
15546 * If this function is called twice for an object, a previously set
15547 * cursor will be unset on the second call.
15549 * @see elm_object_cursor_set()
15550 * @see elm_toolbar_item_cursor_get()
15551 * @see elm_toolbar_item_cursor_unset()
15555 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15558 * Get the type of mouse pointer/cursor decoration set to be shown,
15559 * when the mouse pointer is over the given toolbar widget item
15561 * @param item toolbar item with custom cursor set
15562 * @return the cursor type's name or @c NULL, if no custom cursors
15563 * were set to @p item (and on errors)
15565 * @see elm_object_cursor_get()
15566 * @see elm_toolbar_item_cursor_set()
15567 * @see elm_toolbar_item_cursor_unset()
15571 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15574 * Unset any custom mouse pointer/cursor decoration set to be
15575 * shown, when the mouse pointer is over the given toolbar widget
15576 * item, thus making it show the @b default cursor again.
15578 * @param item a toolbar item
15580 * Use this call to undo any custom settings on this item's cursor
15581 * decoration, bringing it back to defaults (no custom style set).
15583 * @see elm_object_cursor_unset()
15584 * @see elm_toolbar_item_cursor_set()
15588 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15591 * Set a different @b style for a given custom cursor set for a
15594 * @param item toolbar item with custom cursor set
15595 * @param style the <b>theme style</b> to use (e.g. @c "default",
15596 * @c "transparent", etc)
15598 * This function only makes sense when one is using custom mouse
15599 * cursor decorations <b>defined in a theme file</b>, which can have,
15600 * given a cursor name/type, <b>alternate styles</b> on it. It
15601 * works analogously as elm_object_cursor_style_set(), but here
15602 * applyed only to toolbar item objects.
15604 * @warning Before you set a cursor style you should have definen a
15605 * custom cursor previously on the item, with
15606 * elm_toolbar_item_cursor_set()
15608 * @see elm_toolbar_item_cursor_engine_only_set()
15609 * @see elm_toolbar_item_cursor_style_get()
15613 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15616 * Get the current @b style set for a given toolbar item's custom
15619 * @param item toolbar item with custom cursor set.
15620 * @return style the cursor style in use. If the object does not
15621 * have a cursor set, then @c NULL is returned.
15623 * @see elm_toolbar_item_cursor_style_set() for more details
15627 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15630 * Set if the (custom)cursor for a given toolbar item should be
15631 * searched in its theme, also, or should only rely on the
15632 * rendering engine.
15634 * @param item item with custom (custom) cursor already set on
15635 * @param engine_only Use @c EINA_TRUE to have cursors looked for
15636 * only on those provided by the rendering engine, @c EINA_FALSE to
15637 * have them searched on the widget's theme, as well.
15639 * @note This call is of use only if you've set a custom cursor
15640 * for toolbar items, with elm_toolbar_item_cursor_set().
15642 * @note By default, cursors will only be looked for between those
15643 * provided by the rendering engine.
15647 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15650 * Get if the (custom) cursor for a given toolbar item is being
15651 * searched in its theme, also, or is only relying on the rendering
15654 * @param item a toolbar item
15655 * @return @c EINA_TRUE, if cursors are being looked for only on
15656 * those provided by the rendering engine, @c EINA_FALSE if they
15657 * are being searched on the widget's theme, as well.
15659 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
15663 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15666 * Change a toolbar's orientation
15667 * @param obj The toolbar object
15668 * @param vertical If @c EINA_TRUE, the toolbar is vertical
15669 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15671 * @deprecated use elm_toolbar_horizontal_set() instead.
15673 EINA_DEPRECATED EAPI void elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
15676 * Change a toolbar's orientation
15677 * @param obj The toolbar object
15678 * @param horizontal If @c EINA_TRUE, the toolbar is horizontal
15679 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15682 EAPI void elm_toolbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15685 * Get a toolbar's orientation
15686 * @param obj The toolbar object
15687 * @return If @c EINA_TRUE, the toolbar is vertical
15688 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15690 * @deprecated use elm_toolbar_horizontal_get() instead.
15692 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_orientation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15695 * Get a toolbar's orientation
15696 * @param obj The toolbar object
15697 * @return If @c EINA_TRUE, the toolbar is horizontal
15698 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15701 EAPI Eina_Bool elm_toolbar_horizontal_get(const Evas_Object *obj);
15707 * @defgroup Tooltips Tooltips
15709 * The Tooltip is an (internal, for now) smart object used to show a
15710 * content in a frame on mouse hover of objects(or widgets), with
15711 * tips/information about them.
15716 EAPI double elm_tooltip_delay_get(void);
15717 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
15718 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
15719 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
15720 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
15721 EAPI void elm_object_tooltip_domain_translatable_text_set(Evas_Object *obj, const char *domain, const char *text) EINA_ARG_NONNULL(1, 3);
15722 #define elm_object_tooltip_translatable_text_set(obj, text) elm_object_tooltip_domain_translatable_text_set((obj), NULL, (text))
15723 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);
15724 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15725 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15726 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15727 EAPI Eina_Bool elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
15728 EAPI Eina_Bool elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
15735 * @defgroup Cursors Cursors
15737 * The Elementary cursor is an internal smart object used to
15738 * customize the mouse cursor displayed over objects (or
15739 * widgets). In the most common scenario, the cursor decoration
15740 * comes from the graphical @b engine Elementary is running
15741 * on. Those engines may provide different decorations for cursors,
15742 * and Elementary provides functions to choose them (think of X11
15743 * cursors, as an example).
15745 * There's also the possibility of, besides using engine provided
15746 * cursors, also use ones coming from Edje theming files. Both
15747 * globally and per widget, Elementary makes it possible for one to
15748 * make the cursors lookup to be held on engines only or on
15749 * Elementary's theme file, too. To set cursor's hot spot,
15750 * two data items should be added to cursor's theme: "hot_x" and
15751 * "hot_y", that are the offset from upper-left corner of the cursor
15752 * (coordinates 0,0).
15758 * Set the cursor to be shown when mouse is over the object
15760 * Set the cursor that will be displayed when mouse is over the
15761 * object. The object can have only one cursor set to it, so if
15762 * this function is called twice for an object, the previous set
15764 * If using X cursors, a definition of all the valid cursor names
15765 * is listed on Elementary_Cursors.h. If an invalid name is set
15766 * the default cursor will be used.
15768 * @param obj the object being set a cursor.
15769 * @param cursor the cursor name to be used.
15773 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
15776 * Get the cursor to be shown when mouse is over the object
15778 * @param obj an object with cursor already set.
15779 * @return the cursor name.
15783 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15786 * Unset cursor for object
15788 * Unset cursor for object, and set the cursor to default if the mouse
15789 * was over this object.
15791 * @param obj Target object
15792 * @see elm_object_cursor_set()
15796 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15799 * Sets a different style for this object cursor.
15801 * @note before you set a style you should define a cursor with
15802 * elm_object_cursor_set()
15804 * @param obj an object with cursor already set.
15805 * @param style the theme style to use (default, transparent, ...)
15809 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15812 * Get the style for this object cursor.
15814 * @param obj an object with cursor already set.
15815 * @return style the theme style in use, defaults to "default". If the
15816 * object does not have a cursor set, then NULL is returned.
15820 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15823 * Set if the cursor set should be searched on the theme or should use
15824 * the provided by the engine, only.
15826 * @note before you set if should look on theme you should define a cursor
15827 * with elm_object_cursor_set(). By default it will only look for cursors
15828 * provided by the engine.
15830 * @param obj an object with cursor already set.
15831 * @param engine_only boolean to define it cursors should be looked only
15832 * between the provided by the engine or searched on widget's theme as well.
15836 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15839 * Get the cursor engine only usage for this object cursor.
15841 * @param obj an object with cursor already set.
15842 * @return engine_only boolean to define it cursors should be
15843 * looked only between the provided by the engine or searched on
15844 * widget's theme as well. If the object does not have a cursor
15845 * set, then EINA_FALSE is returned.
15849 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15852 * Get the configured cursor engine only usage
15854 * This gets the globally configured exclusive usage of engine cursors.
15856 * @return 1 if only engine cursors should be used
15859 EAPI int elm_cursor_engine_only_get(void);
15862 * Set the configured cursor engine only usage
15864 * This sets the globally configured exclusive usage of engine cursors.
15865 * It won't affect cursors set before changing this value.
15867 * @param engine_only If 1 only engine cursors will be enabled, if 0 will
15868 * look for them on theme before.
15869 * @return EINA_TRUE if value is valid and setted (0 or 1)
15872 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
15879 * @defgroup Menu Menu
15881 * @image html img/widget/menu/preview-00.png
15882 * @image latex img/widget/menu/preview-00.eps
15884 * A menu is a list of items displayed above its parent. When the menu is
15885 * showing its parent is darkened. Each item can have a sub-menu. The menu
15886 * object can be used to display a menu on a right click event, in a toolbar,
15889 * Signals that you can add callbacks for are:
15890 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
15891 * event_info is NULL.
15893 * @see @ref tutorial_menu
15896 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
15898 * @brief Add a new menu to the parent
15900 * @param parent The parent object.
15901 * @return The new object or NULL if it cannot be created.
15903 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15905 * @brief Set the parent for the given menu widget
15907 * @param obj The menu object.
15908 * @param parent The new parent.
15910 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15912 * @brief Get the parent for the given menu widget
15914 * @param obj The menu object.
15915 * @return The parent.
15917 * @see elm_menu_parent_set()
15919 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15921 * @brief Move the menu to a new position
15923 * @param obj The menu object.
15924 * @param x The new position.
15925 * @param y The new position.
15927 * Sets the top-left position of the menu to (@p x,@p y).
15929 * @note @p x and @p y coordinates are relative to parent.
15931 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
15933 * @brief Close a opened menu
15935 * @param obj the menu object
15938 * Hides the menu and all it's sub-menus.
15940 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
15942 * @brief Returns a list of @p item's items.
15944 * @param obj The menu object
15945 * @return An Eina_List* of @p item's items
15947 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15949 * @brief Get the Evas_Object of an Elm_Menu_Item
15951 * @param item The menu item object.
15952 * @return The edje object containing the swallowed content
15954 * @warning Don't manipulate this object!
15956 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15958 * @brief Add an item at the end of the given menu widget
15960 * @param obj The menu object.
15961 * @param parent The parent menu item (optional)
15962 * @param icon A icon display on the item. The icon will be destryed by the menu.
15963 * @param label The label of the item.
15964 * @param func Function called when the user select the item.
15965 * @param data Data sent by the callback.
15966 * @return Returns the new item.
15968 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);
15970 * @brief Add an object swallowed in an item at the end of the given menu
15973 * @param obj The menu object.
15974 * @param parent The parent menu item (optional)
15975 * @param subobj The object to swallow
15976 * @param func Function called when the user select the item.
15977 * @param data Data sent by the callback.
15978 * @return Returns the new item.
15980 * Add an evas object as an item to the menu.
15982 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);
15984 * @brief Set the label of a menu item
15986 * @param item The menu item object.
15987 * @param label The label to set for @p item
15989 * @warning Don't use this funcion on items created with
15990 * elm_menu_item_add_object() or elm_menu_item_separator_add().
15992 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
15994 * @brief Get the label of a menu item
15996 * @param item The menu item object.
15997 * @return The label of @p item
15999 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16001 * @brief Set the icon of a menu item to the standard icon with name @p icon
16003 * @param item The menu item object.
16004 * @param icon The icon object to set for the content of @p item
16006 * Once this icon is set, any previously set icon will be deleted.
16008 EAPI void elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
16010 * @brief Get the string representation from the icon of a menu item
16012 * @param item The menu item object.
16013 * @return The string representation of @p item's icon or NULL
16015 * @see elm_menu_item_object_icon_name_set()
16017 EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16019 * @brief Set the content object of a menu item
16021 * @param item The menu item object
16022 * @param The content object or NULL
16023 * @return EINA_TRUE on success, else EINA_FALSE
16025 * Use this function to change the object swallowed by a menu item, deleting
16026 * any previously swallowed object.
16028 EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
16030 * @brief Get the content object of a menu item
16032 * @param item The menu item object
16033 * @return The content object or NULL
16034 * @note If @p item was added with elm_menu_item_add_object, this
16035 * function will return the object passed, else it will return the
16038 * @see elm_menu_item_object_content_set()
16040 EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16042 * @brief Set the selected state of @p item.
16044 * @param item The menu item object.
16045 * @param selected The selected/unselected state of the item
16047 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16049 * @brief Get the selected state of @p item.
16051 * @param item The menu item object.
16052 * @return The selected/unselected state of the item
16054 * @see elm_menu_item_selected_set()
16056 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16058 * @brief Set the disabled state of @p item.
16060 * @param item The menu item object.
16061 * @param disabled The enabled/disabled state of the item
16063 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
16065 * @brief Get the disabled state of @p item.
16067 * @param item The menu item object.
16068 * @return The enabled/disabled state of the item
16070 * @see elm_menu_item_disabled_set()
16072 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16074 * @brief Add a separator item to menu @p obj under @p parent.
16076 * @param obj The menu object
16077 * @param parent The item to add the separator under
16078 * @return The created item or NULL on failure
16080 * This is item is a @ref Separator.
16082 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
16084 * @brief Returns whether @p item is a separator.
16086 * @param item The item to check
16087 * @return If true, @p item is a separator
16089 * @see elm_menu_item_separator_add()
16091 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16093 * @brief Deletes an item from the menu.
16095 * @param item The item to delete.
16097 * @see elm_menu_item_add()
16099 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16101 * @brief Set the function called when a menu item is deleted.
16103 * @param item The item to set the callback on
16104 * @param func The function called
16106 * @see elm_menu_item_add()
16107 * @see elm_menu_item_del()
16109 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16111 * @brief Returns the data associated with menu item @p item.
16113 * @param item The item
16114 * @return The data associated with @p item or NULL if none was set.
16116 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
16118 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16120 * @brief Sets the data to be associated with menu item @p item.
16122 * @param item The item
16123 * @param data The data to be associated with @p item
16125 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
16127 * @brief Returns a list of @p item's subitems.
16129 * @param item The item
16130 * @return An Eina_List* of @p item's subitems
16132 * @see elm_menu_add()
16134 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16136 * @brief Get the position of a menu item
16138 * @param item The menu item
16139 * @return The item's index
16141 * This function returns the index position of a menu item in a menu.
16142 * For a sub-menu, this number is relative to the first item in the sub-menu.
16144 * @note Index values begin with 0
16146 EAPI unsigned int elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
16148 * @brief @brief Return a menu item's owner menu
16150 * @param item The menu item
16151 * @return The menu object owning @p item, or NULL on failure
16153 * Use this function to get the menu object owning an item.
16155 EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
16157 * @brief Get the selected item in the menu
16159 * @param obj The menu object
16160 * @return The selected item, or NULL if none
16162 * @see elm_menu_item_selected_get()
16163 * @see elm_menu_item_selected_set()
16165 EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16167 * @brief Get the last item in the menu
16169 * @param obj The menu object
16170 * @return The last item, or NULL if none
16172 EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16174 * @brief Get the first item in the menu
16176 * @param obj The menu object
16177 * @return The first item, or NULL if none
16179 EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16181 * @brief Get the next item in the menu.
16183 * @param item The menu item object.
16184 * @return The item after it, or NULL if none
16186 EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16188 * @brief Get the previous item in the menu.
16190 * @param item The menu item object.
16191 * @return The item before it, or NULL if none
16193 EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16199 * @defgroup List List
16200 * @ingroup Elementary
16202 * @image html img/widget/list/preview-00.png
16203 * @image latex img/widget/list/preview-00.eps width=\textwidth
16205 * @image html img/list.png
16206 * @image latex img/list.eps width=\textwidth
16208 * A list widget is a container whose children are displayed vertically or
16209 * horizontally, in order, and can be selected.
16210 * The list can accept only one or multiple items selection. Also has many
16211 * modes of items displaying.
16213 * A list is a very simple type of list widget. For more robust
16214 * lists, @ref Genlist should probably be used.
16216 * Smart callbacks one can listen to:
16217 * - @c "activated" - The user has double-clicked or pressed
16218 * (enter|return|spacebar) on an item. The @c event_info parameter
16219 * is the item that was activated.
16220 * - @c "clicked,double" - The user has double-clicked an item.
16221 * The @c event_info parameter is the item that was double-clicked.
16222 * - "selected" - when the user selected an item
16223 * - "unselected" - when the user unselected an item
16224 * - "longpressed" - an item in the list is long-pressed
16225 * - "edge,top" - the list is scrolled until the top edge
16226 * - "edge,bottom" - the list is scrolled until the bottom edge
16227 * - "edge,left" - the list is scrolled until the left edge
16228 * - "edge,right" - the list is scrolled until the right edge
16229 * - "language,changed" - the program's language changed
16231 * Available styles for it:
16234 * List of examples:
16235 * @li @ref list_example_01
16236 * @li @ref list_example_02
16237 * @li @ref list_example_03
16246 * @enum _Elm_List_Mode
16247 * @typedef Elm_List_Mode
16249 * Set list's resize behavior, transverse axis scroll and
16250 * items cropping. See each mode's description for more details.
16252 * @note Default value is #ELM_LIST_SCROLL.
16254 * Values <b> don't </b> work as bitmask, only one can be choosen.
16256 * @see elm_list_mode_set()
16257 * @see elm_list_mode_get()
16261 typedef enum _Elm_List_Mode
16263 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. */
16264 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). */
16265 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. */
16266 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. */
16267 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
16270 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(). */
16273 * Add a new list widget to the given parent Elementary
16274 * (container) object.
16276 * @param parent The parent object.
16277 * @return a new list widget handle or @c NULL, on errors.
16279 * This function inserts a new list widget on the canvas.
16283 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16288 * @param obj The list object
16290 * @note Call before running show() on the list object.
16291 * @warning If not called, it won't display the list properly.
16294 * li = elm_list_add(win);
16295 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
16296 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
16298 * evas_object_show(li);
16303 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
16306 * Enable or disable multiple items selection on the list object.
16308 * @param obj The list object
16309 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
16312 * Disabled by default. If disabled, the user can select a single item of
16313 * the list each time. Selected items are highlighted on list.
16314 * If enabled, many items can be selected.
16316 * If a selected item is selected again, it will be unselected.
16318 * @see elm_list_multi_select_get()
16322 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
16325 * Get a value whether multiple items selection is enabled or not.
16327 * @see elm_list_multi_select_set() for details.
16329 * @param obj The list object.
16330 * @return @c EINA_TRUE means multiple items selection is enabled.
16331 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16332 * @c EINA_FALSE is returned.
16336 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16339 * Set which mode to use for the list object.
16341 * @param obj The list object
16342 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16343 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
16345 * Set list's resize behavior, transverse axis scroll and
16346 * items cropping. See each mode's description for more details.
16348 * @note Default value is #ELM_LIST_SCROLL.
16350 * Only one can be set, if a previous one was set, it will be changed
16351 * by the new mode set. Bitmask won't work as well.
16353 * @see elm_list_mode_get()
16357 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16360 * Get the mode the list is at.
16362 * @param obj The list object
16363 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16364 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
16366 * @note see elm_list_mode_set() for more information.
16370 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16373 * Enable or disable horizontal mode on the list object.
16375 * @param obj The list object.
16376 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
16377 * disable it, i.e., to enable vertical mode.
16379 * @note Vertical mode is set by default.
16381 * On horizontal mode items are displayed on list from left to right,
16382 * instead of from top to bottom. Also, the list will scroll horizontally.
16383 * Each item will presents left icon on top and right icon, or end, at
16386 * @see elm_list_horizontal_get()
16390 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16393 * Get a value whether horizontal mode is enabled or not.
16395 * @param obj The list object.
16396 * @return @c EINA_TRUE means horizontal mode selection is enabled.
16397 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16398 * @c EINA_FALSE is returned.
16400 * @see elm_list_horizontal_set() for details.
16404 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16407 * Enable or disable always select mode on the list object.
16409 * @param obj The list object
16410 * @param always_select @c EINA_TRUE to enable always select mode or
16411 * @c EINA_FALSE to disable it.
16413 * @note Always select mode is disabled by default.
16415 * Default behavior of list items is to only call its callback function
16416 * the first time it's pressed, i.e., when it is selected. If a selected
16417 * item is pressed again, and multi-select is disabled, it won't call
16418 * this function (if multi-select is enabled it will unselect the item).
16420 * If always select is enabled, it will call the callback function
16421 * everytime a item is pressed, so it will call when the item is selected,
16422 * and again when a selected item is pressed.
16424 * @see elm_list_always_select_mode_get()
16425 * @see elm_list_multi_select_set()
16429 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16432 * Get a value whether always select mode is enabled or not, meaning that
16433 * an item will always call its callback function, even if already selected.
16435 * @param obj The list object
16436 * @return @c EINA_TRUE means horizontal mode selection is enabled.
16437 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16438 * @c EINA_FALSE is returned.
16440 * @see elm_list_always_select_mode_set() for details.
16444 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16447 * Set bouncing behaviour when the scrolled content reaches an edge.
16449 * Tell the internal scroller object whether it should bounce or not
16450 * when it reaches the respective edges for each axis.
16452 * @param obj The list object
16453 * @param h_bounce Whether to bounce or not in the horizontal axis.
16454 * @param v_bounce Whether to bounce or not in the vertical axis.
16456 * @see elm_scroller_bounce_set()
16460 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
16463 * Get the bouncing behaviour of the internal scroller.
16465 * Get whether the internal scroller should bounce when the edge of each
16466 * axis is reached scrolling.
16468 * @param obj The list object.
16469 * @param h_bounce Pointer where to store the bounce state of the horizontal
16471 * @param v_bounce Pointer where to store the bounce state of the vertical
16474 * @see elm_scroller_bounce_get()
16475 * @see elm_list_bounce_set()
16479 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
16482 * Set the scrollbar policy.
16484 * @param obj The list object
16485 * @param policy_h Horizontal scrollbar policy.
16486 * @param policy_v Vertical scrollbar policy.
16488 * This sets the scrollbar visibility policy for the given scroller.
16489 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
16490 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
16491 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
16492 * This applies respectively for the horizontal and vertical scrollbars.
16494 * The both are disabled by default, i.e., are set to
16495 * #ELM_SCROLLER_POLICY_OFF.
16499 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
16502 * Get the scrollbar policy.
16504 * @see elm_list_scroller_policy_get() for details.
16506 * @param obj The list object.
16507 * @param policy_h Pointer where to store horizontal scrollbar policy.
16508 * @param policy_v Pointer where to store vertical scrollbar policy.
16512 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);
16515 * Append a new item to the list object.
16517 * @param obj The list object.
16518 * @param label The label of the list item.
16519 * @param icon The icon object to use for the left side of the item. An
16520 * icon can be any Evas object, but usually it is an icon created
16521 * with elm_icon_add().
16522 * @param end The icon object to use for the right side of the item. An
16523 * icon can be any Evas object.
16524 * @param func The function to call when the item is clicked.
16525 * @param data The data to associate with the item for related callbacks.
16527 * @return The created item or @c NULL upon failure.
16529 * A new item will be created and appended to the list, i.e., will
16530 * be set as @b last item.
16532 * Items created with this method can be deleted with
16533 * elm_list_item_del().
16535 * Associated @p data can be properly freed when item is deleted if a
16536 * callback function is set with elm_list_item_del_cb_set().
16538 * If a function is passed as argument, it will be called everytime this item
16539 * is selected, i.e., the user clicks over an unselected item.
16540 * If always select is enabled it will call this function every time
16541 * user clicks over an item (already selected or not).
16542 * If such function isn't needed, just passing
16543 * @c NULL as @p func is enough. The same should be done for @p data.
16545 * Simple example (with no function callback or data associated):
16547 * li = elm_list_add(win);
16548 * ic = elm_icon_add(win);
16549 * elm_icon_file_set(ic, "path/to/image", NULL);
16550 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
16551 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
16553 * evas_object_show(li);
16556 * @see elm_list_always_select_mode_set()
16557 * @see elm_list_item_del()
16558 * @see elm_list_item_del_cb_set()
16559 * @see elm_list_clear()
16560 * @see elm_icon_add()
16564 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);
16567 * Prepend a new item to the list object.
16569 * @param obj The list object.
16570 * @param label The label of the list item.
16571 * @param icon The icon object to use for the left side of the item. An
16572 * icon can be any Evas object, but usually it is an icon created
16573 * with elm_icon_add().
16574 * @param end The icon object to use for the right side of the item. An
16575 * icon can be any Evas object.
16576 * @param func The function to call when the item is clicked.
16577 * @param data The data to associate with the item for related callbacks.
16579 * @return The created item or @c NULL upon failure.
16581 * A new item will be created and prepended to the list, i.e., will
16582 * be set as @b first item.
16584 * Items created with this method can be deleted with
16585 * elm_list_item_del().
16587 * Associated @p data can be properly freed when item is deleted if a
16588 * callback function is set with elm_list_item_del_cb_set().
16590 * If a function is passed as argument, it will be called everytime this item
16591 * is selected, i.e., the user clicks over an unselected item.
16592 * If always select is enabled it will call this function every time
16593 * user clicks over an item (already selected or not).
16594 * If such function isn't needed, just passing
16595 * @c NULL as @p func is enough. The same should be done for @p data.
16597 * @see elm_list_item_append() for a simple code example.
16598 * @see elm_list_always_select_mode_set()
16599 * @see elm_list_item_del()
16600 * @see elm_list_item_del_cb_set()
16601 * @see elm_list_clear()
16602 * @see elm_icon_add()
16606 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);
16609 * Insert a new item into the list object before item @p before.
16611 * @param obj The list object.
16612 * @param before The list item to insert before.
16613 * @param label The label of the list item.
16614 * @param icon The icon object to use for the left side of the item. An
16615 * icon can be any Evas object, but usually it is an icon created
16616 * with elm_icon_add().
16617 * @param end The icon object to use for the right side of the item. An
16618 * icon can be any Evas object.
16619 * @param func The function to call when the item is clicked.
16620 * @param data The data to associate with the item for related callbacks.
16622 * @return The created item or @c NULL upon failure.
16624 * A new item will be created and added to the list. Its position in
16625 * this list will be just before item @p before.
16627 * Items created with this method can be deleted with
16628 * elm_list_item_del().
16630 * Associated @p data can be properly freed when item is deleted if a
16631 * callback function is set with elm_list_item_del_cb_set().
16633 * If a function is passed as argument, it will be called everytime this item
16634 * is selected, i.e., the user clicks over an unselected item.
16635 * If always select is enabled it will call this function every time
16636 * user clicks over an item (already selected or not).
16637 * If such function isn't needed, just passing
16638 * @c NULL as @p func is enough. The same should be done for @p data.
16640 * @see elm_list_item_append() for a simple code example.
16641 * @see elm_list_always_select_mode_set()
16642 * @see elm_list_item_del()
16643 * @see elm_list_item_del_cb_set()
16644 * @see elm_list_clear()
16645 * @see elm_icon_add()
16649 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);
16652 * Insert a new item into the list object after item @p after.
16654 * @param obj The list object.
16655 * @param after The list item to insert after.
16656 * @param label The label of the list item.
16657 * @param icon The icon object to use for the left side of the item. An
16658 * icon can be any Evas object, but usually it is an icon created
16659 * with elm_icon_add().
16660 * @param end The icon object to use for the right side of the item. An
16661 * icon can be any Evas object.
16662 * @param func The function to call when the item is clicked.
16663 * @param data The data to associate with the item for related callbacks.
16665 * @return The created item or @c NULL upon failure.
16667 * A new item will be created and added to the list. Its position in
16668 * this list will be just after item @p after.
16670 * Items created with this method can be deleted with
16671 * elm_list_item_del().
16673 * Associated @p data can be properly freed when item is deleted if a
16674 * callback function is set with elm_list_item_del_cb_set().
16676 * If a function is passed as argument, it will be called everytime this item
16677 * is selected, i.e., the user clicks over an unselected item.
16678 * If always select is enabled it will call this function every time
16679 * user clicks over an item (already selected or not).
16680 * If such function isn't needed, just passing
16681 * @c NULL as @p func is enough. The same should be done for @p data.
16683 * @see elm_list_item_append() for a simple code example.
16684 * @see elm_list_always_select_mode_set()
16685 * @see elm_list_item_del()
16686 * @see elm_list_item_del_cb_set()
16687 * @see elm_list_clear()
16688 * @see elm_icon_add()
16692 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);
16695 * Insert a new item into the sorted list object.
16697 * @param obj The list object.
16698 * @param label The label of the list item.
16699 * @param icon The icon object to use for the left side of the item. An
16700 * icon can be any Evas object, but usually it is an icon created
16701 * with elm_icon_add().
16702 * @param end The icon object to use for the right side of the item. An
16703 * icon can be any Evas object.
16704 * @param func The function to call when the item is clicked.
16705 * @param data The data to associate with the item for related callbacks.
16706 * @param cmp_func The comparing function to be used to sort list
16707 * items <b>by #Elm_List_Item item handles</b>. This function will
16708 * receive two items and compare them, returning a non-negative integer
16709 * if the second item should be place after the first, or negative value
16710 * if should be placed before.
16712 * @return The created item or @c NULL upon failure.
16714 * @note This function inserts values into a list object assuming it was
16715 * sorted and the result will be sorted.
16717 * A new item will be created and added to the list. Its position in
16718 * this list will be found comparing the new item with previously inserted
16719 * items using function @p cmp_func.
16721 * Items created with this method can be deleted with
16722 * elm_list_item_del().
16724 * Associated @p data can be properly freed when item is deleted if a
16725 * callback function is set with elm_list_item_del_cb_set().
16727 * If a function is passed as argument, it will be called everytime this item
16728 * is selected, i.e., the user clicks over an unselected item.
16729 * If always select is enabled it will call this function every time
16730 * user clicks over an item (already selected or not).
16731 * If such function isn't needed, just passing
16732 * @c NULL as @p func is enough. The same should be done for @p data.
16734 * @see elm_list_item_append() for a simple code example.
16735 * @see elm_list_always_select_mode_set()
16736 * @see elm_list_item_del()
16737 * @see elm_list_item_del_cb_set()
16738 * @see elm_list_clear()
16739 * @see elm_icon_add()
16743 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);
16746 * Remove all list's items.
16748 * @param obj The list object
16750 * @see elm_list_item_del()
16751 * @see elm_list_item_append()
16755 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16758 * Get a list of all the list items.
16760 * @param obj The list object
16761 * @return An @c Eina_List of list items, #Elm_List_Item,
16762 * or @c NULL on failure.
16764 * @see elm_list_item_append()
16765 * @see elm_list_item_del()
16766 * @see elm_list_clear()
16770 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16773 * Get the selected item.
16775 * @param obj The list object.
16776 * @return The selected list item.
16778 * The selected item can be unselected with function
16779 * elm_list_item_selected_set().
16781 * The selected item always will be highlighted on list.
16783 * @see elm_list_selected_items_get()
16787 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16790 * Return a list of the currently selected list items.
16792 * @param obj The list object.
16793 * @return An @c Eina_List of list items, #Elm_List_Item,
16794 * or @c NULL on failure.
16796 * Multiple items can be selected if multi select is enabled. It can be
16797 * done with elm_list_multi_select_set().
16799 * @see elm_list_selected_item_get()
16800 * @see elm_list_multi_select_set()
16804 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16807 * Set the selected state of an item.
16809 * @param item The list item
16810 * @param selected The selected state
16812 * This sets the selected state of the given item @p it.
16813 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
16815 * If a new item is selected the previosly selected will be unselected,
16816 * unless multiple selection is enabled with elm_list_multi_select_set().
16817 * Previoulsy selected item can be get with function
16818 * elm_list_selected_item_get().
16820 * Selected items will be highlighted.
16822 * @see elm_list_item_selected_get()
16823 * @see elm_list_selected_item_get()
16824 * @see elm_list_multi_select_set()
16828 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16831 * Get whether the @p item is selected or not.
16833 * @param item The list item.
16834 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
16835 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
16837 * @see elm_list_selected_item_set() for details.
16838 * @see elm_list_item_selected_get()
16842 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16845 * Set or unset item as a separator.
16847 * @param it The list item.
16848 * @param setting @c EINA_TRUE to set item @p it as separator or
16849 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
16851 * Items aren't set as separator by default.
16853 * If set as separator it will display separator theme, so won't display
16856 * @see elm_list_item_separator_get()
16860 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
16863 * Get a value whether item is a separator or not.
16865 * @see elm_list_item_separator_set() for details.
16867 * @param it The list item.
16868 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
16869 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
16873 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16876 * Show @p item in the list view.
16878 * @param item The list item to be shown.
16880 * It won't animate list until item is visible. If such behavior is wanted,
16881 * use elm_list_bring_in() intead.
16885 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16888 * Bring in the given item to list view.
16890 * @param item The item.
16892 * This causes list to jump to the given item @p item and show it
16893 * (by scrolling), if it is not fully visible.
16895 * This may use animation to do so and take a period of time.
16897 * If animation isn't wanted, elm_list_item_show() can be used.
16901 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16904 * Delete them item from the list.
16906 * @param item The item of list to be deleted.
16908 * If deleting all list items is required, elm_list_clear()
16909 * should be used instead of getting items list and deleting each one.
16911 * @see elm_list_clear()
16912 * @see elm_list_item_append()
16913 * @see elm_list_item_del_cb_set()
16917 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16920 * Set the function called when a list item is freed.
16922 * @param item The item to set the callback on
16923 * @param func The function called
16925 * If there is a @p func, then it will be called prior item's memory release.
16926 * That will be called with the following arguments:
16928 * @li item's Evas object;
16931 * This way, a data associated to a list item could be properly freed.
16935 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16938 * Get the data associated to the item.
16940 * @param item The list item
16941 * @return The data associated to @p item
16943 * The return value is a pointer to data associated to @p item when it was
16944 * created, with function elm_list_item_append() or similar. If no data
16945 * was passed as argument, it will return @c NULL.
16947 * @see elm_list_item_append()
16951 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16954 * Get the left side icon associated to the item.
16956 * @param item The list item
16957 * @return The left side icon associated to @p item
16959 * The return value is a pointer to the icon associated to @p item when
16961 * created, with function elm_list_item_append() or similar, or later
16962 * with function elm_list_item_icon_set(). If no icon
16963 * was passed as argument, it will return @c NULL.
16965 * @see elm_list_item_append()
16966 * @see elm_list_item_icon_set()
16970 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16973 * Set the left side icon associated to the item.
16975 * @param item The list item
16976 * @param icon The left side icon object to associate with @p item
16978 * The icon object to use at left side of the item. An
16979 * icon can be any Evas object, but usually it is an icon created
16980 * with elm_icon_add().
16982 * Once the icon object is set, a previously set one will be deleted.
16983 * @warning Setting the same icon for two items will cause the icon to
16984 * dissapear from the first item.
16986 * If an icon was passed as argument on item creation, with function
16987 * elm_list_item_append() or similar, it will be already
16988 * associated to the item.
16990 * @see elm_list_item_append()
16991 * @see elm_list_item_icon_get()
16995 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
16998 * Get the right side icon associated to the item.
17000 * @param item The list item
17001 * @return The right side icon associated to @p item
17003 * The return value is a pointer to the icon associated to @p item when
17005 * created, with function elm_list_item_append() or similar, or later
17006 * with function elm_list_item_icon_set(). If no icon
17007 * was passed as argument, it will return @c NULL.
17009 * @see elm_list_item_append()
17010 * @see elm_list_item_icon_set()
17014 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17017 * Set the right side icon associated to the item.
17019 * @param item The list item
17020 * @param end The right side icon object to associate with @p item
17022 * The icon object to use at right side of the item. An
17023 * icon can be any Evas object, but usually it is an icon created
17024 * with elm_icon_add().
17026 * Once the icon object is set, a previously set one will be deleted.
17027 * @warning Setting the same icon for two items will cause the icon to
17028 * dissapear from the first item.
17030 * If an icon was passed as argument on item creation, with function
17031 * elm_list_item_append() or similar, it will be already
17032 * associated to the item.
17034 * @see elm_list_item_append()
17035 * @see elm_list_item_end_get()
17039 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
17042 * Gets the base object of the item.
17044 * @param item The list item
17045 * @return The base object associated with @p item
17047 * Base object is the @c Evas_Object that represents that item.
17051 EAPI Evas_Object *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17052 EINA_DEPRECATED EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17055 * Get the label of item.
17057 * @param item The item of list.
17058 * @return The label of item.
17060 * The return value is a pointer to the label associated to @p item when
17061 * it was created, with function elm_list_item_append(), or later
17062 * with function elm_list_item_label_set. If no label
17063 * was passed as argument, it will return @c NULL.
17065 * @see elm_list_item_label_set() for more details.
17066 * @see elm_list_item_append()
17070 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17073 * Set the label of item.
17075 * @param item The item of list.
17076 * @param text The label of item.
17078 * The label to be displayed by the item.
17079 * Label will be placed between left and right side icons (if set).
17081 * If a label was passed as argument on item creation, with function
17082 * elm_list_item_append() or similar, it will be already
17083 * displayed by the item.
17085 * @see elm_list_item_label_get()
17086 * @see elm_list_item_append()
17090 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17094 * Get the item before @p it in list.
17096 * @param it The list item.
17097 * @return The item before @p it, or @c NULL if none or on failure.
17099 * @note If it is the first item, @c NULL will be returned.
17101 * @see elm_list_item_append()
17102 * @see elm_list_items_get()
17106 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17109 * Get the item after @p it in list.
17111 * @param it The list item.
17112 * @return The item after @p it, or @c NULL if none or on failure.
17114 * @note If it is the last item, @c NULL will be returned.
17116 * @see elm_list_item_append()
17117 * @see elm_list_items_get()
17121 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17124 * Sets the disabled/enabled state of a list item.
17126 * @param it The item.
17127 * @param disabled The disabled state.
17129 * A disabled item cannot be selected or unselected. It will also
17130 * change its appearance (generally greyed out). This sets the
17131 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
17136 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
17139 * Get a value whether list item is disabled or not.
17141 * @param it The item.
17142 * @return The disabled state.
17144 * @see elm_list_item_disabled_set() for more details.
17148 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17151 * Set the text to be shown in a given list item's tooltips.
17153 * @param item Target item.
17154 * @param text The text to set in the content.
17156 * Setup the text as tooltip to object. The item can have only one tooltip,
17157 * so any previous tooltip data - set with this function or
17158 * elm_list_item_tooltip_content_cb_set() - is removed.
17160 * @see elm_object_tooltip_text_set() for more details.
17164 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17168 * @brief Disable size restrictions on an object's tooltip
17169 * @param item The tooltip's anchor object
17170 * @param disable If EINA_TRUE, size restrictions are disabled
17171 * @return EINA_FALSE on failure, EINA_TRUE on success
17173 * This function allows a tooltip to expand beyond its parant window's canvas.
17174 * It will instead be limited only by the size of the display.
17176 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
17178 * @brief Retrieve size restriction state of an object's tooltip
17179 * @param obj The tooltip's anchor object
17180 * @return If EINA_TRUE, size restrictions are disabled
17182 * This function returns whether a tooltip is allowed to expand beyond
17183 * its parant window's canvas.
17184 * It will instead be limited only by the size of the display.
17186 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17189 * Set the content to be shown in the tooltip item.
17191 * Setup the tooltip to item. The item can have only one tooltip,
17192 * so any previous tooltip data is removed. @p func(with @p data) will
17193 * be called every time that need show the tooltip and it should
17194 * return a valid Evas_Object. This object is then managed fully by
17195 * tooltip system and is deleted when the tooltip is gone.
17197 * @param item the list item being attached a tooltip.
17198 * @param func the function used to create the tooltip contents.
17199 * @param data what to provide to @a func as callback data/context.
17200 * @param del_cb called when data is not needed anymore, either when
17201 * another callback replaces @a func, the tooltip is unset with
17202 * elm_list_item_tooltip_unset() or the owner @a item
17203 * dies. This callback receives as the first parameter the
17204 * given @a data, and @c event_info is the item.
17206 * @see elm_object_tooltip_content_cb_set() for more details.
17210 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);
17213 * Unset tooltip from item.
17215 * @param item list item to remove previously set tooltip.
17217 * Remove tooltip from item. The callback provided as del_cb to
17218 * elm_list_item_tooltip_content_cb_set() will be called to notify
17219 * it is not used anymore.
17221 * @see elm_object_tooltip_unset() for more details.
17222 * @see elm_list_item_tooltip_content_cb_set()
17226 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17229 * Sets a different style for this item tooltip.
17231 * @note before you set a style you should define a tooltip with
17232 * elm_list_item_tooltip_content_cb_set() or
17233 * elm_list_item_tooltip_text_set()
17235 * @param item list item with tooltip already set.
17236 * @param style the theme style to use (default, transparent, ...)
17238 * @see elm_object_tooltip_style_set() for more details.
17242 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17245 * Get the style for this item tooltip.
17247 * @param item list item with tooltip already set.
17248 * @return style the theme style in use, defaults to "default". If the
17249 * object does not have a tooltip set, then NULL is returned.
17251 * @see elm_object_tooltip_style_get() for more details.
17252 * @see elm_list_item_tooltip_style_set()
17256 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17259 * Set the type of mouse pointer/cursor decoration to be shown,
17260 * when the mouse pointer is over the given list widget item
17262 * @param item list item to customize cursor on
17263 * @param cursor the cursor type's name
17265 * This function works analogously as elm_object_cursor_set(), but
17266 * here the cursor's changing area is restricted to the item's
17267 * area, and not the whole widget's. Note that that item cursors
17268 * have precedence over widget cursors, so that a mouse over an
17269 * item with custom cursor set will always show @b that cursor.
17271 * If this function is called twice for an object, a previously set
17272 * cursor will be unset on the second call.
17274 * @see elm_object_cursor_set()
17275 * @see elm_list_item_cursor_get()
17276 * @see elm_list_item_cursor_unset()
17280 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
17283 * Get the type of mouse pointer/cursor decoration set to be shown,
17284 * when the mouse pointer is over the given list widget item
17286 * @param item list item with custom cursor set
17287 * @return the cursor type's name or @c NULL, if no custom cursors
17288 * were set to @p item (and on errors)
17290 * @see elm_object_cursor_get()
17291 * @see elm_list_item_cursor_set()
17292 * @see elm_list_item_cursor_unset()
17296 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17299 * Unset any custom mouse pointer/cursor decoration set to be
17300 * shown, when the mouse pointer is over the given list widget
17301 * item, thus making it show the @b default cursor again.
17303 * @param item a list item
17305 * Use this call to undo any custom settings on this item's cursor
17306 * decoration, bringing it back to defaults (no custom style set).
17308 * @see elm_object_cursor_unset()
17309 * @see elm_list_item_cursor_set()
17313 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17316 * Set a different @b style for a given custom cursor set for a
17319 * @param item list item with custom cursor set
17320 * @param style the <b>theme style</b> to use (e.g. @c "default",
17321 * @c "transparent", etc)
17323 * This function only makes sense when one is using custom mouse
17324 * cursor decorations <b>defined in a theme file</b>, which can have,
17325 * given a cursor name/type, <b>alternate styles</b> on it. It
17326 * works analogously as elm_object_cursor_style_set(), but here
17327 * applyed only to list item objects.
17329 * @warning Before you set a cursor style you should have definen a
17330 * custom cursor previously on the item, with
17331 * elm_list_item_cursor_set()
17333 * @see elm_list_item_cursor_engine_only_set()
17334 * @see elm_list_item_cursor_style_get()
17338 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17341 * Get the current @b style set for a given list item's custom
17344 * @param item list item with custom cursor set.
17345 * @return style the cursor style in use. If the object does not
17346 * have a cursor set, then @c NULL is returned.
17348 * @see elm_list_item_cursor_style_set() for more details
17352 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17355 * Set if the (custom)cursor for a given list item should be
17356 * searched in its theme, also, or should only rely on the
17357 * rendering engine.
17359 * @param item item with custom (custom) cursor already set on
17360 * @param engine_only Use @c EINA_TRUE to have cursors looked for
17361 * only on those provided by the rendering engine, @c EINA_FALSE to
17362 * have them searched on the widget's theme, as well.
17364 * @note This call is of use only if you've set a custom cursor
17365 * for list items, with elm_list_item_cursor_set().
17367 * @note By default, cursors will only be looked for between those
17368 * provided by the rendering engine.
17372 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
17375 * Get if the (custom) cursor for a given list item is being
17376 * searched in its theme, also, or is only relying on the rendering
17379 * @param item a list item
17380 * @return @c EINA_TRUE, if cursors are being looked for only on
17381 * those provided by the rendering engine, @c EINA_FALSE if they
17382 * are being searched on the widget's theme, as well.
17384 * @see elm_list_item_cursor_engine_only_set(), for more details
17388 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17395 * @defgroup Slider Slider
17396 * @ingroup Elementary
17398 * @image html img/widget/slider/preview-00.png
17399 * @image latex img/widget/slider/preview-00.eps width=\textwidth
17401 * The slider adds a dragable āsliderā widget for selecting the value of
17402 * something within a range.
17404 * A slider can be horizontal or vertical. It can contain an Icon and has a
17405 * primary label as well as a units label (that is formatted with floating
17406 * point values and thus accepts a printf-style format string, like
17407 * ā%1.2f unitsā. There is also an indicator string that may be somewhere
17408 * else (like on the slider itself) that also accepts a format string like
17409 * units. Label, Icon Unit and Indicator strings/objects are optional.
17411 * A slider may be inverted which means values invert, with high vales being
17412 * on the left or top and low values on the right or bottom (as opposed to
17413 * normally being low on the left or top and high on the bottom and right).
17415 * The slider should have its minimum and maximum values set by the
17416 * application with elm_slider_min_max_set() and value should also be set by
17417 * the application before use with elm_slider_value_set(). The span of the
17418 * slider is its length (horizontally or vertically). This will be scaled by
17419 * the object or applications scaling factor. At any point code can query the
17420 * slider for its value with elm_slider_value_get().
17422 * Smart callbacks one can listen to:
17423 * - "changed" - Whenever the slider value is changed by the user.
17424 * - "slider,drag,start" - dragging the slider indicator around has started.
17425 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
17426 * - "delay,changed" - A short time after the value is changed by the user.
17427 * This will be called only when the user stops dragging for
17428 * a very short period or when they release their
17429 * finger/mouse, so it avoids possibly expensive reactions to
17430 * the value change.
17432 * Available styles for it:
17435 * Default contents parts of the slider widget that you can use for are:
17436 * @li "elm.swallow.icon" - A icon of the slider
17437 * @li "elm.swallow.end" - A end part content of the slider
17439 * Here is an example on its usage:
17440 * @li @ref slider_example
17443 #define ELM_SLIDER_CONTENT_ICON "elm.swallow.icon"
17444 #define ELM_SLIDER_CONTENT_END "elm.swallow.end"
17447 * @addtogroup Slider
17452 * Add a new slider widget to the given parent Elementary
17453 * (container) object.
17455 * @param parent The parent object.
17456 * @return a new slider widget handle or @c NULL, on errors.
17458 * This function inserts a new slider widget on the canvas.
17462 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17465 * Set the label of a given slider widget
17467 * @param obj The progress bar object
17468 * @param label The text label string, in UTF-8
17471 * @deprecated use elm_object_text_set() instead.
17473 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17476 * Get the label of a given slider widget
17478 * @param obj The progressbar object
17479 * @return The text label string, in UTF-8
17482 * @deprecated use elm_object_text_get() instead.
17484 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17487 * Set the icon object of the slider object.
17489 * @param obj The slider object.
17490 * @param icon The icon object.
17492 * On horizontal mode, icon is placed at left, and on vertical mode,
17495 * @note Once the icon object is set, a previously set one will be deleted.
17496 * If you want to keep that old content object, use the
17497 * elm_slider_icon_unset() function.
17499 * @warning If the object being set does not have minimum size hints set,
17500 * it won't get properly displayed.
17503 * @deprecated use elm_object_content_set() instead.
17505 EINA_DEPRECATED EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17508 * Unset an icon set on a given slider widget.
17510 * @param obj The slider object.
17511 * @return The icon object that was being used, if any was set, or
17512 * @c NULL, otherwise (and on errors).
17514 * On horizontal mode, icon is placed at left, and on vertical mode,
17517 * This call will unparent and return the icon object which was set
17518 * for this widget, previously, on success.
17520 * @see elm_slider_icon_set() for more details
17521 * @see elm_slider_icon_get()
17522 * @deprecated use elm_object_content_unset() instead.
17526 EINA_DEPRECATED EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17529 * Retrieve the icon object set for a given slider widget.
17531 * @param obj The slider object.
17532 * @return The icon object's handle, if @p obj had one set, or @c NULL,
17533 * otherwise (and on errors).
17535 * On horizontal mode, icon is placed at left, and on vertical mode,
17538 * @see elm_slider_icon_set() for more details
17539 * @see elm_slider_icon_unset()
17541 * @deprecated use elm_object_content_get() instead.
17545 EINA_DEPRECATED EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17548 * Set the end object of the slider object.
17550 * @param obj The slider object.
17551 * @param end The end object.
17553 * On horizontal mode, end is placed at left, and on vertical mode,
17554 * placed at bottom.
17556 * @note Once the icon object is set, a previously set one will be deleted.
17557 * If you want to keep that old content object, use the
17558 * elm_slider_end_unset() function.
17560 * @warning If the object being set does not have minimum size hints set,
17561 * it won't get properly displayed.
17563 * @deprecated use elm_object_content_part_set(obj, "elm.swallow.end", end) instead.
17567 EINA_DEPRECATED EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
17570 * Unset an end object set on a given slider widget.
17572 * @param obj The slider object.
17573 * @return The end object that was being used, if any was set, or
17574 * @c NULL, otherwise (and on errors).
17576 * On horizontal mode, end is placed at left, and on vertical mode,
17577 * placed at bottom.
17579 * This call will unparent and return the icon object which was set
17580 * for this widget, previously, on success.
17582 * @see elm_slider_end_set() for more details.
17583 * @see elm_slider_end_get()
17585 * @deprecated use elm_object_content_part_unset(obj, "elm.swallow.end")
17590 EINA_DEPRECATED EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17593 * Retrieve the end object set for a given slider widget.
17595 * @param obj The slider object.
17596 * @return The end object's handle, if @p obj had one set, or @c NULL,
17597 * otherwise (and on errors).
17599 * On horizontal mode, icon is placed at right, and on vertical mode,
17600 * placed at bottom.
17602 * @see elm_slider_end_set() for more details.
17603 * @see elm_slider_end_unset()
17606 * @deprecated use elm_object_content_part_unset(obj, "elm.swallow.end")
17611 EINA_DEPRECATED EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17614 * Set the (exact) length of the bar region of a given slider widget.
17616 * @param obj The slider object.
17617 * @param size The length of the slider's bar region.
17619 * This sets the minimum width (when in horizontal mode) or height
17620 * (when in vertical mode) of the actual bar area of the slider
17621 * @p obj. This in turn affects the object's minimum size. Use
17622 * this when you're not setting other size hints expanding on the
17623 * given direction (like weight and alignment hints) and you would
17624 * like it to have a specific size.
17626 * @note Icon, end, label, indicator and unit text around @p obj
17627 * will require their
17628 * own space, which will make @p obj to require more the @p size,
17631 * @see elm_slider_span_size_get()
17635 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17638 * Get the length set for the bar region of a given slider widget
17640 * @param obj The slider object.
17641 * @return The length of the slider's bar region.
17643 * If that size was not set previously, with
17644 * elm_slider_span_size_set(), this call will return @c 0.
17648 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17651 * Set the format string for the unit label.
17653 * @param obj The slider object.
17654 * @param format The format string for the unit display.
17656 * Unit label is displayed all the time, if set, after slider's bar.
17657 * In horizontal mode, at right and in vertical mode, at bottom.
17659 * If @c NULL, unit label won't be visible. If not it sets the format
17660 * string for the label text. To the label text is provided a floating point
17661 * value, so the label text can display up to 1 floating point value.
17662 * Note that this is optional.
17664 * Use a format string such as "%1.2f meters" for example, and it will
17665 * display values like: "3.14 meters" for a value equal to 3.14159.
17667 * Default is unit label disabled.
17669 * @see elm_slider_indicator_format_get()
17673 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17676 * Get the unit label format of the slider.
17678 * @param obj The slider object.
17679 * @return The unit label format string in UTF-8.
17681 * Unit label is displayed all the time, if set, after slider's bar.
17682 * In horizontal mode, at right and in vertical mode, at bottom.
17684 * @see elm_slider_unit_format_set() for more
17685 * information on how this works.
17689 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17692 * Set the format string for the indicator label.
17694 * @param obj The slider object.
17695 * @param indicator The format string for the indicator display.
17697 * The slider may display its value somewhere else then unit label,
17698 * for example, above the slider knob that is dragged around. This function
17699 * sets the format string used for this.
17701 * If @c NULL, indicator label won't be visible. If not it sets the format
17702 * string for the label text. To the label text is provided a floating point
17703 * value, so the label text can display up to 1 floating point value.
17704 * Note that this is optional.
17706 * Use a format string such as "%1.2f meters" for example, and it will
17707 * display values like: "3.14 meters" for a value equal to 3.14159.
17709 * Default is indicator label disabled.
17711 * @see elm_slider_indicator_format_get()
17715 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
17718 * Get the indicator label format of the slider.
17720 * @param obj The slider object.
17721 * @return The indicator label format string in UTF-8.
17723 * The slider may display its value somewhere else then unit label,
17724 * for example, above the slider knob that is dragged around. This function
17725 * gets the format string used for this.
17727 * @see elm_slider_indicator_format_set() for more
17728 * information on how this works.
17732 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17735 * Set the format function pointer for the indicator label
17737 * @param obj The slider object.
17738 * @param func The indicator format function.
17739 * @param free_func The freeing function for the format string.
17741 * Set the callback function to format the indicator string.
17743 * @see elm_slider_indicator_format_set() for more info on how this works.
17747 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);
17750 * Set the format function pointer for the units label
17752 * @param obj The slider object.
17753 * @param func The units format function.
17754 * @param free_func The freeing function for the format string.
17756 * Set the callback function to format the indicator string.
17758 * @see elm_slider_units_format_set() for more info on how this works.
17762 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);
17765 * Set the orientation of a given slider widget.
17767 * @param obj The slider object.
17768 * @param horizontal Use @c EINA_TRUE to make @p obj to be
17769 * @b horizontal, @c EINA_FALSE to make it @b vertical.
17771 * Use this function to change how your slider is to be
17772 * disposed: vertically or horizontally.
17774 * By default it's displayed horizontally.
17776 * @see elm_slider_horizontal_get()
17780 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17783 * Retrieve the orientation of a given slider widget
17785 * @param obj The slider object.
17786 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17787 * @c EINA_FALSE if it's @b vertical (and on errors).
17789 * @see elm_slider_horizontal_set() for more details.
17793 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17796 * Set the minimum and maximum values for the slider.
17798 * @param obj The slider object.
17799 * @param min The minimum value.
17800 * @param max The maximum value.
17802 * Define the allowed range of values to be selected by the user.
17804 * If actual value is less than @p min, it will be updated to @p min. If it
17805 * is bigger then @p max, will be updated to @p max. Actual value can be
17806 * get with elm_slider_value_get().
17808 * By default, min is equal to 0.0, and max is equal to 1.0.
17810 * @warning Maximum must be greater than minimum, otherwise behavior
17813 * @see elm_slider_min_max_get()
17817 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17820 * Get the minimum and maximum values of the slider.
17822 * @param obj The slider object.
17823 * @param min Pointer where to store the minimum value.
17824 * @param max Pointer where to store the maximum value.
17826 * @note If only one value is needed, the other pointer can be passed
17829 * @see elm_slider_min_max_set() for details.
17833 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17836 * Set the value the slider displays.
17838 * @param obj The slider object.
17839 * @param val The value to be displayed.
17841 * Value will be presented on the unit label following format specified with
17842 * elm_slider_unit_format_set() and on indicator with
17843 * elm_slider_indicator_format_set().
17845 * @warning The value must to be between min and max values. This values
17846 * are set by elm_slider_min_max_set().
17848 * @see elm_slider_value_get()
17849 * @see elm_slider_unit_format_set()
17850 * @see elm_slider_indicator_format_set()
17851 * @see elm_slider_min_max_set()
17855 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17858 * Get the value displayed by the spinner.
17860 * @param obj The spinner object.
17861 * @return The value displayed.
17863 * @see elm_spinner_value_set() for details.
17867 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17870 * Invert a given slider widget's displaying values order
17872 * @param obj The slider object.
17873 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17874 * @c EINA_FALSE to bring it back to default, non-inverted values.
17876 * A slider may be @b inverted, in which state it gets its
17877 * values inverted, with high vales being on the left or top and
17878 * low values on the right or bottom, as opposed to normally have
17879 * the low values on the former and high values on the latter,
17880 * respectively, for horizontal and vertical modes.
17882 * @see elm_slider_inverted_get()
17886 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
17889 * Get whether a given slider widget's displaying values are
17892 * @param obj The slider object.
17893 * @return @c EINA_TRUE, if @p obj has inverted values,
17894 * @c EINA_FALSE otherwise (and on errors).
17896 * @see elm_slider_inverted_set() for more details.
17900 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17903 * Set whether to enlarge slider indicator (augmented knob) or not.
17905 * @param obj The slider object.
17906 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
17907 * let the knob always at default size.
17909 * By default, indicator will be bigger while dragged by the user.
17911 * @warning It won't display values set with
17912 * elm_slider_indicator_format_set() if you disable indicator.
17916 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
17919 * Get whether a given slider widget's enlarging indicator or not.
17921 * @param obj The slider object.
17922 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
17923 * @c EINA_FALSE otherwise (and on errors).
17925 * @see elm_slider_indicator_show_set() for details.
17929 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17936 * @addtogroup Actionslider Actionslider
17938 * @image html img/widget/actionslider/preview-00.png
17939 * @image latex img/widget/actionslider/preview-00.eps
17941 * An actionslider is a switcher for 2 or 3 labels with customizable magnet
17942 * properties. The user drags and releases the indicator, to choose a label.
17944 * Labels occupy the following positions.
17949 * Positions can be enabled or disabled.
17951 * Magnets can be set on the above positions.
17953 * When the indicator is released, it will move to its nearest "enabled and magnetized" position.
17955 * @note By default all positions are set as enabled.
17957 * Signals that you can add callbacks for are:
17959 * "selected" - when user selects an enabled position (the label is passed
17962 * "pos_changed" - when the indicator reaches any of the positions("left",
17963 * "right" or "center").
17965 * See an example of actionslider usage @ref actionslider_example_page "here"
17968 typedef enum _Elm_Actionslider_Pos
17970 ELM_ACTIONSLIDER_NONE = 0,
17971 ELM_ACTIONSLIDER_LEFT = 1 << 0,
17972 ELM_ACTIONSLIDER_CENTER = 1 << 1,
17973 ELM_ACTIONSLIDER_RIGHT = 1 << 2,
17974 ELM_ACTIONSLIDER_ALL = (1 << 3) -1
17975 } Elm_Actionslider_Pos;
17978 * Add a new actionslider to the parent.
17980 * @param parent The parent object
17981 * @return The new actionslider object or NULL if it cannot be created
17983 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17985 * Set actionslider labels.
17987 * @param obj The actionslider object
17988 * @param left_label The label to be set on the left.
17989 * @param center_label The label to be set on the center.
17990 * @param right_label The label to be set on the right.
17991 * @deprecated use elm_object_text_set() instead.
17993 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);
17995 * Get actionslider labels.
17997 * @param obj The actionslider object
17998 * @param left_label A char** to place the left_label of @p obj into.
17999 * @param center_label A char** to place the center_label of @p obj into.
18000 * @param right_label A char** to place the right_label of @p obj into.
18001 * @deprecated use elm_object_text_set() instead.
18003 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);
18005 * Get actionslider selected label.
18007 * @param obj The actionslider object
18008 * @return The selected label
18010 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18012 * Set actionslider indicator position.
18014 * @param obj The actionslider object.
18015 * @param pos The position of the indicator.
18017 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
18019 * Get actionslider indicator position.
18021 * @param obj The actionslider object.
18022 * @return The position of the indicator.
18024 EAPI Elm_Actionslider_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18026 * Set actionslider magnet position. To make multiple positions magnets @c or
18027 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
18029 * @param obj The actionslider object.
18030 * @param pos Bit mask indicating the magnet positions.
18032 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
18034 * Get actionslider magnet position.
18036 * @param obj The actionslider object.
18037 * @return The positions with magnet property.
18039 EAPI Elm_Actionslider_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18041 * Set actionslider enabled position. To set multiple positions as enabled @c or
18042 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
18044 * @note All the positions are enabled by default.
18046 * @param obj The actionslider object.
18047 * @param pos Bit mask indicating the enabled positions.
18049 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
18051 * Get actionslider enabled position.
18053 * @param obj The actionslider object.
18054 * @return The enabled positions.
18056 EAPI Elm_Actionslider_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18058 * Set the label used on the indicator.
18060 * @param obj The actionslider object
18061 * @param label The label to be set on the indicator.
18062 * @deprecated use elm_object_text_set() instead.
18064 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18066 * Get the label used on the indicator object.
18068 * @param obj The actionslider object
18069 * @return The indicator label
18070 * @deprecated use elm_object_text_get() instead.
18072 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
18078 * @defgroup Genlist Genlist
18080 * @image html img/widget/genlist/preview-00.png
18081 * @image latex img/widget/genlist/preview-00.eps
18082 * @image html img/genlist.png
18083 * @image latex img/genlist.eps
18085 * This widget aims to have more expansive list than the simple list in
18086 * Elementary that could have more flexible items and allow many more entries
18087 * while still being fast and low on memory usage. At the same time it was
18088 * also made to be able to do tree structures. But the price to pay is more
18089 * complexity when it comes to usage. If all you want is a simple list with
18090 * icons and a single label, use the normal @ref List object.
18092 * Genlist has a fairly large API, mostly because it's relatively complex,
18093 * trying to be both expansive, powerful and efficient. First we will begin
18094 * an overview on the theory behind genlist.
18096 * @section Genlist_Item_Class Genlist item classes - creating items
18098 * In order to have the ability to add and delete items on the fly, genlist
18099 * implements a class (callback) system where the application provides a
18100 * structure with information about that type of item (genlist may contain
18101 * multiple different items with different classes, states and styles).
18102 * Genlist will call the functions in this struct (methods) when an item is
18103 * "realized" (i.e., created dynamically, while the user is scrolling the
18104 * grid). All objects will simply be deleted when no longer needed with
18105 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
18106 * following members:
18107 * - @c item_style - This is a constant string and simply defines the name
18108 * of the item style. It @b must be specified and the default should be @c
18111 * - @c func - A struct with pointers to functions that will be called when
18112 * an item is going to be actually created. All of them receive a @c data
18113 * parameter that will point to the same data passed to
18114 * elm_genlist_item_append() and related item creation functions, and a @c
18115 * obj parameter that points to the genlist object itself.
18117 * The function pointers inside @c func are @c label_get, @c icon_get, @c
18118 * state_get and @c del. The 3 first functions also receive a @c part
18119 * parameter described below. A brief description of these functions follows:
18121 * - @c label_get - The @c part parameter is the name string of one of the
18122 * existing text parts in the Edje group implementing the item's theme.
18123 * This function @b must return a strdup'()ed string, as the caller will
18124 * free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
18125 * - @c content_get - The @c part parameter is the name string of one of the
18126 * existing (content) swallow parts in the Edje group implementing the item's
18127 * theme. It must return @c NULL, when no content is desired, or a valid
18128 * object handle, otherwise. The object will be deleted by the genlist on
18129 * its deletion or when the item is "unrealized". See
18130 * #Elm_Genlist_Item_Icon_Get_Cb.
18131 * - @c func.state_get - The @c part parameter is the name string of one of
18132 * the state parts in the Edje group implementing the item's theme. Return
18133 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
18134 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
18135 * and @c "elm" as "emission" and "source" arguments, respectively, when
18136 * the state is true (the default is false), where @c XXX is the name of
18137 * the (state) part. See #Elm_Genlist_Item_State_Get_Cb.
18138 * - @c func.del - This is intended for use when genlist items are deleted,
18139 * so any data attached to the item (e.g. its data parameter on creation)
18140 * can be deleted. See #Elm_Genlist_Item_Del_Cb.
18142 * available item styles:
18144 * - default_style - The text part is a textblock
18146 * @image html img/widget/genlist/preview-04.png
18147 * @image latex img/widget/genlist/preview-04.eps
18151 * @image html img/widget/genlist/preview-01.png
18152 * @image latex img/widget/genlist/preview-01.eps
18154 * - icon_top_text_bottom
18156 * @image html img/widget/genlist/preview-02.png
18157 * @image latex img/widget/genlist/preview-02.eps
18161 * @image html img/widget/genlist/preview-03.png
18162 * @image latex img/widget/genlist/preview-03.eps
18164 * @section Genlist_Items Structure of items
18166 * An item in a genlist can have 0 or more text labels (they can be regular
18167 * text or textblock Evas objects - that's up to the style to determine), 0
18168 * or more contents (which are simply objects swallowed into the genlist item's
18169 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
18170 * behavior left to the user to define. The Edje part names for each of
18171 * these properties will be looked up, in the theme file for the genlist,
18172 * under the Edje (string) data items named @c "labels", @c "contents" and @c
18173 * "states", respectively. For each of those properties, if more than one
18174 * part is provided, they must have names listed separated by spaces in the
18175 * data fields. For the default genlist item theme, we have @b one label
18176 * part (@c "elm.text"), @b two content parts (@c "elm.swalllow.icon" and @c
18177 * "elm.swallow.end") and @b no state parts.
18179 * A genlist item may be at one of several styles. Elementary provides one
18180 * by default - "default", but this can be extended by system or application
18181 * custom themes/overlays/extensions (see @ref Theme "themes" for more
18184 * @section Genlist_Manipulation Editing and Navigating
18186 * Items can be added by several calls. All of them return a @ref
18187 * Elm_Genlist_Item handle that is an internal member inside the genlist.
18188 * They all take a data parameter that is meant to be used for a handle to
18189 * the applications internal data (eg the struct with the original item
18190 * data). The parent parameter is the parent genlist item this belongs to if
18191 * it is a tree or an indexed group, and NULL if there is no parent. The
18192 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
18193 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
18194 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
18195 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
18196 * is set then this item is group index item that is displayed at the top
18197 * until the next group comes. The func parameter is a convenience callback
18198 * that is called when the item is selected and the data parameter will be
18199 * the func_data parameter, obj be the genlist object and event_info will be
18200 * the genlist item.
18202 * elm_genlist_item_append() adds an item to the end of the list, or if
18203 * there is a parent, to the end of all the child items of the parent.
18204 * elm_genlist_item_prepend() is the same but adds to the beginning of
18205 * the list or children list. elm_genlist_item_insert_before() inserts at
18206 * item before another item and elm_genlist_item_insert_after() inserts after
18207 * the indicated item.
18209 * The application can clear the list with elm_genlist_clear() which deletes
18210 * all the items in the list and elm_genlist_item_del() will delete a specific
18211 * item. elm_genlist_item_subitems_clear() will clear all items that are
18212 * children of the indicated parent item.
18214 * To help inspect list items you can jump to the item at the top of the list
18215 * with elm_genlist_first_item_get() which will return the item pointer, and
18216 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
18217 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
18218 * and previous items respectively relative to the indicated item. Using
18219 * these calls you can walk the entire item list/tree. Note that as a tree
18220 * the items are flattened in the list, so elm_genlist_item_parent_get() will
18221 * let you know which item is the parent (and thus know how to skip them if
18224 * @section Genlist_Muti_Selection Multi-selection
18226 * If the application wants multiple items to be able to be selected,
18227 * elm_genlist_multi_select_set() can enable this. If the list is
18228 * single-selection only (the default), then elm_genlist_selected_item_get()
18229 * will return the selected item, if any, or NULL I none is selected. If the
18230 * list is multi-select then elm_genlist_selected_items_get() will return a
18231 * list (that is only valid as long as no items are modified (added, deleted,
18232 * selected or unselected)).
18234 * @section Genlist_Usage_Hints Usage hints
18236 * There are also convenience functions. elm_genlist_item_genlist_get() will
18237 * return the genlist object the item belongs to. elm_genlist_item_show()
18238 * will make the scroller scroll to show that specific item so its visible.
18239 * elm_genlist_item_data_get() returns the data pointer set by the item
18240 * creation functions.
18242 * If an item changes (state of boolean changes, label or contents change),
18243 * then use elm_genlist_item_update() to have genlist update the item with
18244 * the new state. Genlist will re-realize the item thus call the functions
18245 * in the _Elm_Genlist_Item_Class for that item.
18247 * To programmatically (un)select an item use elm_genlist_item_selected_set().
18248 * To get its selected state use elm_genlist_item_selected_get(). Similarly
18249 * to expand/contract an item and get its expanded state, use
18250 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
18251 * again to make an item disabled (unable to be selected and appear
18252 * differently) use elm_genlist_item_disabled_set() to set this and
18253 * elm_genlist_item_disabled_get() to get the disabled state.
18255 * In general to indicate how the genlist should expand items horizontally to
18256 * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
18257 * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
18258 * mode means that if items are too wide to fit, the scroller will scroll
18259 * horizontally. Otherwise items are expanded to fill the width of the
18260 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
18261 * to the viewport width and limited to that size. This can be combined with
18262 * a different style that uses edjes' ellipsis feature (cutting text off like
18265 * Items will only call their selection func and callback when first becoming
18266 * selected. Any further clicks will do nothing, unless you enable always
18267 * select with elm_genlist_always_select_mode_set(). This means even if
18268 * selected, every click will make the selected callbacks be called.
18269 * elm_genlist_no_select_mode_set() will turn off the ability to select
18270 * items entirely and they will neither appear selected nor call selected
18271 * callback functions.
18273 * Remember that you can create new styles and add your own theme augmentation
18274 * per application with elm_theme_extension_add(). If you absolutely must
18275 * have a specific style that overrides any theme the user or system sets up
18276 * you can use elm_theme_overlay_add() to add such a file.
18278 * @section Genlist_Implementation Implementation
18280 * Evas tracks every object you create. Every time it processes an event
18281 * (mouse move, down, up etc.) it needs to walk through objects and find out
18282 * what event that affects. Even worse every time it renders display updates,
18283 * in order to just calculate what to re-draw, it needs to walk through many
18284 * many many objects. Thus, the more objects you keep active, the more
18285 * overhead Evas has in just doing its work. It is advisable to keep your
18286 * active objects to the minimum working set you need. Also remember that
18287 * object creation and deletion carries an overhead, so there is a
18288 * middle-ground, which is not easily determined. But don't keep massive lists
18289 * of objects you can't see or use. Genlist does this with list objects. It
18290 * creates and destroys them dynamically as you scroll around. It groups them
18291 * into blocks so it can determine the visibility etc. of a whole block at
18292 * once as opposed to having to walk the whole list. This 2-level list allows
18293 * for very large numbers of items to be in the list (tests have used up to
18294 * 2,000,000 items). Also genlist employs a queue for adding items. As items
18295 * may be different sizes, every item added needs to be calculated as to its
18296 * size and thus this presents a lot of overhead on populating the list, this
18297 * genlist employs a queue. Any item added is queued and spooled off over
18298 * time, actually appearing some time later, so if your list has many members
18299 * you may find it takes a while for them to all appear, with your process
18300 * consuming a lot of CPU while it is busy spooling.
18302 * Genlist also implements a tree structure, but it does so with callbacks to
18303 * the application, with the application filling in tree structures when
18304 * requested (allowing for efficient building of a very deep tree that could
18305 * even be used for file-management). See the above smart signal callbacks for
18308 * @section Genlist_Smart_Events Genlist smart events
18310 * Signals that you can add callbacks for are:
18311 * - @c "activated" - The user has double-clicked or pressed
18312 * (enter|return|spacebar) on an item. The @c event_info parameter is the
18313 * item that was activated.
18314 * - @c "clicked,double" - The user has double-clicked an item. The @c
18315 * event_info parameter is the item that was double-clicked.
18316 * - @c "selected" - This is called when a user has made an item selected.
18317 * The event_info parameter is the genlist item that was selected.
18318 * - @c "unselected" - This is called when a user has made an item
18319 * unselected. The event_info parameter is the genlist item that was
18321 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
18322 * called and the item is now meant to be expanded. The event_info
18323 * parameter is the genlist item that was indicated to expand. It is the
18324 * job of this callback to then fill in the child items.
18325 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
18326 * called and the item is now meant to be contracted. The event_info
18327 * parameter is the genlist item that was indicated to contract. It is the
18328 * job of this callback to then delete the child items.
18329 * - @c "expand,request" - This is called when a user has indicated they want
18330 * to expand a tree branch item. The callback should decide if the item can
18331 * expand (has any children) and then call elm_genlist_item_expanded_set()
18332 * appropriately to set the state. The event_info parameter is the genlist
18333 * item that was indicated to expand.
18334 * - @c "contract,request" - This is called when a user has indicated they
18335 * want to contract a tree branch item. The callback should decide if the
18336 * item can contract (has any children) and then call
18337 * elm_genlist_item_expanded_set() appropriately to set the state. The
18338 * event_info parameter is the genlist item that was indicated to contract.
18339 * - @c "realized" - This is called when the item in the list is created as a
18340 * real evas object. event_info parameter is the genlist item that was
18341 * created. The object may be deleted at any time, so it is up to the
18342 * caller to not use the object pointer from elm_genlist_item_object_get()
18343 * in a way where it may point to freed objects.
18344 * - @c "unrealized" - This is called just before an item is unrealized.
18345 * After this call content objects provided will be deleted and the item
18346 * object itself delete or be put into a floating cache.
18347 * - @c "drag,start,up" - This is called when the item in the list has been
18348 * dragged (not scrolled) up.
18349 * - @c "drag,start,down" - This is called when the item in the list has been
18350 * dragged (not scrolled) down.
18351 * - @c "drag,start,left" - This is called when the item in the list has been
18352 * dragged (not scrolled) left.
18353 * - @c "drag,start,right" - This is called when the item in the list has
18354 * been dragged (not scrolled) right.
18355 * - @c "drag,stop" - This is called when the item in the list has stopped
18357 * - @c "drag" - This is called when the item in the list is being dragged.
18358 * - @c "longpressed" - This is called when the item is pressed for a certain
18359 * amount of time. By default it's 1 second.
18360 * - @c "scroll,anim,start" - This is called when scrolling animation has
18362 * - @c "scroll,anim,stop" - This is called when scrolling animation has
18364 * - @c "scroll,drag,start" - This is called when dragging the content has
18366 * - @c "scroll,drag,stop" - This is called when dragging the content has
18368 * - @c "edge,top" - This is called when the genlist is scrolled until
18370 * - @c "edge,bottom" - This is called when the genlist is scrolled
18371 * until the bottom edge.
18372 * - @c "edge,left" - This is called when the genlist is scrolled
18373 * until the left edge.
18374 * - @c "edge,right" - This is called when the genlist is scrolled
18375 * until the right edge.
18376 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
18378 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
18380 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
18382 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
18384 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
18385 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
18386 * multi-touch pinched in.
18387 * - @c "swipe" - This is called when the genlist is swiped.
18388 * - @c "moved" - This is called when a genlist item is moved.
18389 * - @c "language,changed" - This is called when the program's language is
18392 * @section Genlist_Examples Examples
18394 * Here is a list of examples that use the genlist, trying to show some of
18395 * its capabilities:
18396 * - @ref genlist_example_01
18397 * - @ref genlist_example_02
18398 * - @ref genlist_example_03
18399 * - @ref genlist_example_04
18400 * - @ref genlist_example_05
18404 * @addtogroup Genlist
18409 * @enum _Elm_Genlist_Item_Flags
18410 * @typedef Elm_Genlist_Item_Flags
18412 * Defines if the item is of any special type (has subitems or it's the
18413 * index of a group), or is just a simple item.
18417 typedef enum _Elm_Genlist_Item_Flags
18419 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
18420 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
18421 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
18422 } Elm_Genlist_Item_Flags;
18423 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
18424 #define Elm_Genlist_Item_Class Elm_Gen_Item_Class
18425 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18426 #define Elm_Genlist_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18427 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
18428 typedef char *(*Elm_Genlist_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
18429 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. */
18430 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. */
18431 typedef void (*Elm_Genlist_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
18434 * @struct _Elm_Genlist_Item_Class
18436 * Genlist item class definition structs.
18438 * This struct contains the style and fetching functions that will define the
18439 * contents of each item.
18441 * @see @ref Genlist_Item_Class
18443 struct _Elm_Genlist_Item_Class
18445 const char *item_style; /**< style of this class. */
18446 struct Elm_Genlist_Item_Class_Func
18448 Elm_Genlist_Item_Label_Get_Cb label_get; /**< Label fetching class function for genlist item classes.*/
18449 Elm_Genlist_Item_Content_Get_Cb content_get; /**< Content fetching class function for genlist item classes. */
18450 Elm_Genlist_Item_State_Get_Cb state_get; /**< State fetching class function for genlist item classes. */
18451 Elm_Genlist_Item_Del_Cb del; /**< Deletion class function for genlist item classes. */
18454 #define Elm_Genlist_Item_Class_Func Elm_Gen_Item_Class_Func
18456 * Add a new genlist widget to the given parent Elementary
18457 * (container) object
18459 * @param parent The parent object
18460 * @return a new genlist widget handle or @c NULL, on errors
18462 * This function inserts a new genlist widget on the canvas.
18464 * @see elm_genlist_item_append()
18465 * @see elm_genlist_item_del()
18466 * @see elm_genlist_clear()
18470 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18472 * Remove all items from a given genlist widget.
18474 * @param obj The genlist object
18476 * This removes (and deletes) all items in @p obj, leaving it empty.
18478 * @see elm_genlist_item_del(), to remove just one item.
18482 EINA_DEPRECATED EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18484 * Enable or disable multi-selection in the genlist
18486 * @param obj The genlist object
18487 * @param multi Multi-select enable/disable. Default is disabled.
18489 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
18490 * the list. This allows more than 1 item to be selected. To retrieve the list
18491 * of selected items, use elm_genlist_selected_items_get().
18493 * @see elm_genlist_selected_items_get()
18494 * @see elm_genlist_multi_select_get()
18498 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
18500 * Gets if multi-selection in genlist is enabled or disabled.
18502 * @param obj The genlist object
18503 * @return Multi-select enabled/disabled
18504 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
18506 * @see elm_genlist_multi_select_set()
18510 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18512 * This sets the horizontal stretching mode.
18514 * @param obj The genlist object
18515 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
18517 * This sets the mode used for sizing items horizontally. Valid modes
18518 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
18519 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
18520 * the scroller will scroll horizontally. Otherwise items are expanded
18521 * to fill the width of the viewport of the scroller. If it is
18522 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
18523 * limited to that size.
18525 * @see elm_genlist_horizontal_get()
18529 EAPI void elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18530 EINA_DEPRECATED EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18532 * Gets the horizontal stretching mode.
18534 * @param obj The genlist object
18535 * @return The mode to use
18536 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
18538 * @see elm_genlist_horizontal_set()
18542 EAPI Elm_List_Mode elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18543 EINA_DEPRECATED EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18545 * Set the always select mode.
18547 * @param obj The genlist object
18548 * @param always_select The always select mode (@c EINA_TRUE = on, @c
18549 * EINA_FALSE = off). Default is @c EINA_FALSE.
18551 * Items will only call their selection func and callback when first
18552 * becoming selected. Any further clicks will do nothing, unless you
18553 * enable always select with elm_genlist_always_select_mode_set().
18554 * This means that, even if selected, every click will make the selected
18555 * callbacks be called.
18557 * @see elm_genlist_always_select_mode_get()
18561 EINA_DEPRECATED EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
18563 * Get the always select mode.
18565 * @param obj The genlist object
18566 * @return The always select mode
18567 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18569 * @see elm_genlist_always_select_mode_set()
18573 EINA_DEPRECATED EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18575 * Enable/disable the no select mode.
18577 * @param obj The genlist object
18578 * @param no_select The no select mode
18579 * (EINA_TRUE = on, EINA_FALSE = off)
18581 * This will turn off the ability to select items entirely and they
18582 * will neither appear selected nor call selected callback functions.
18584 * @see elm_genlist_no_select_mode_get()
18588 EINA_DEPRECATED EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
18590 * Gets whether the no select mode is enabled.
18592 * @param obj The genlist object
18593 * @return The no select mode
18594 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18596 * @see elm_genlist_no_select_mode_set()
18600 EINA_DEPRECATED EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18602 * Enable/disable compress mode.
18604 * @param obj The genlist object
18605 * @param compress The compress mode
18606 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
18608 * This will enable the compress mode where items are "compressed"
18609 * horizontally to fit the genlist scrollable viewport width. This is
18610 * special for genlist. Do not rely on
18611 * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
18612 * work as genlist needs to handle it specially.
18614 * @see elm_genlist_compress_mode_get()
18618 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
18620 * Get whether the compress mode is enabled.
18622 * @param obj The genlist object
18623 * @return The compress mode
18624 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18626 * @see elm_genlist_compress_mode_set()
18630 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18632 * Enable/disable height-for-width mode.
18634 * @param obj The genlist object
18635 * @param setting The height-for-width mode (@c EINA_TRUE = on,
18636 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
18638 * With height-for-width mode the item width will be fixed (restricted
18639 * to a minimum of) to the list width when calculating its size in
18640 * order to allow the height to be calculated based on it. This allows,
18641 * for instance, text block to wrap lines if the Edje part is
18642 * configured with "text.min: 0 1".
18644 * @note This mode will make list resize slower as it will have to
18645 * recalculate every item height again whenever the list width
18648 * @note When height-for-width mode is enabled, it also enables
18649 * compress mode (see elm_genlist_compress_mode_set()) and
18650 * disables homogeneous (see elm_genlist_homogeneous_set()).
18654 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
18656 * Get whether the height-for-width mode is enabled.
18658 * @param obj The genlist object
18659 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
18664 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18666 * Enable/disable horizontal and vertical bouncing effect.
18668 * @param obj The genlist object
18669 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
18670 * EINA_FALSE = off). Default is @c EINA_FALSE.
18671 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
18672 * EINA_FALSE = off). Default is @c EINA_TRUE.
18674 * This will enable or disable the scroller bouncing effect for the
18675 * genlist. See elm_scroller_bounce_set() for details.
18677 * @see elm_scroller_bounce_set()
18678 * @see elm_genlist_bounce_get()
18682 EINA_DEPRECATED EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18684 * Get whether the horizontal and vertical bouncing effect is enabled.
18686 * @param obj The genlist object
18687 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
18689 * @param v_bounce Pointer to a bool to receive if the bounce vertically
18692 * @see elm_genlist_bounce_set()
18696 EINA_DEPRECATED EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18698 * Enable/disable homogenous mode.
18700 * @param obj The genlist object
18701 * @param homogeneous Assume the items within the genlist are of the
18702 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
18705 * This will enable the homogeneous mode where items are of the same
18706 * height and width so that genlist may do the lazy-loading at its
18707 * maximum (which increases the performance for scrolling the list). This
18708 * implies 'compressed' mode.
18710 * @see elm_genlist_compress_mode_set()
18711 * @see elm_genlist_homogeneous_get()
18715 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
18717 * Get whether the homogenous mode is enabled.
18719 * @param obj The genlist object
18720 * @return Assume the items within the genlist are of the same height
18721 * and width (EINA_TRUE = on, EINA_FALSE = off)
18723 * @see elm_genlist_homogeneous_set()
18727 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18729 * Set the maximum number of items within an item block
18731 * @param obj The genlist object
18732 * @param n Maximum number of items within an item block. Default is 32.
18734 * This will configure the block count to tune to the target with
18735 * particular performance matrix.
18737 * A block of objects will be used to reduce the number of operations due to
18738 * many objects in the screen. It can determine the visibility, or if the
18739 * object has changed, it theme needs to be updated, etc. doing this kind of
18740 * calculation to the entire block, instead of per object.
18742 * The default value for the block count is enough for most lists, so unless
18743 * you know you will have a lot of objects visible in the screen at the same
18744 * time, don't try to change this.
18746 * @see elm_genlist_block_count_get()
18747 * @see @ref Genlist_Implementation
18751 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
18753 * Get the maximum number of items within an item block
18755 * @param obj The genlist object
18756 * @return Maximum number of items within an item block
18758 * @see elm_genlist_block_count_set()
18762 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18764 * Set the timeout in seconds for the longpress event.
18766 * @param obj The genlist object
18767 * @param timeout timeout in seconds. Default is 1.
18769 * This option will change how long it takes to send an event "longpressed"
18770 * after the mouse down signal is sent to the list. If this event occurs, no
18771 * "clicked" event will be sent.
18773 * @see elm_genlist_longpress_timeout_set()
18777 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18779 * Get the timeout in seconds for the longpress event.
18781 * @param obj The genlist object
18782 * @return timeout in seconds
18784 * @see elm_genlist_longpress_timeout_get()
18788 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18790 * Append a new item in a given genlist widget.
18792 * @param obj The genlist object
18793 * @param itc The item class for the item
18794 * @param data The item data
18795 * @param parent The parent item, or NULL if none
18796 * @param flags Item flags
18797 * @param func Convenience function called when the item is selected
18798 * @param func_data Data passed to @p func above.
18799 * @return A handle to the item added or @c NULL if not possible
18801 * This adds the given item to the end of the list or the end of
18802 * the children list if the @p parent is given.
18804 * @see elm_genlist_item_prepend()
18805 * @see elm_genlist_item_insert_before()
18806 * @see elm_genlist_item_insert_after()
18807 * @see elm_genlist_item_del()
18811 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);
18813 * Prepend a new item in a given genlist widget.
18815 * @param obj The genlist object
18816 * @param itc The item class for the item
18817 * @param data The item data
18818 * @param parent The parent item, or NULL if none
18819 * @param flags Item flags
18820 * @param func Convenience function called when the item is selected
18821 * @param func_data Data passed to @p func above.
18822 * @return A handle to the item added or NULL if not possible
18824 * This adds an item to the beginning of the list or beginning of the
18825 * children of the parent if given.
18827 * @see elm_genlist_item_append()
18828 * @see elm_genlist_item_insert_before()
18829 * @see elm_genlist_item_insert_after()
18830 * @see elm_genlist_item_del()
18834 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);
18836 * Insert an item before another in a genlist widget
18838 * @param obj The genlist object
18839 * @param itc The item class for the item
18840 * @param data The item data
18841 * @param before The item to place this new one before.
18842 * @param flags Item flags
18843 * @param func Convenience function called when the item is selected
18844 * @param func_data Data passed to @p func above.
18845 * @return A handle to the item added or @c NULL if not possible
18847 * This inserts an item before another in the list. It will be in the
18848 * same tree level or group as the item it is inserted before.
18850 * @see elm_genlist_item_append()
18851 * @see elm_genlist_item_prepend()
18852 * @see elm_genlist_item_insert_after()
18853 * @see elm_genlist_item_del()
18857 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);
18859 * Insert an item after another in a genlist widget
18861 * @param obj The genlist object
18862 * @param itc The item class for the item
18863 * @param data The item data
18864 * @param after The item to place this new one after.
18865 * @param flags Item flags
18866 * @param func Convenience function called when the item is selected
18867 * @param func_data Data passed to @p func above.
18868 * @return A handle to the item added or @c NULL if not possible
18870 * This inserts an item after another in the list. It will be in the
18871 * same tree level or group as the item it is inserted after.
18873 * @see elm_genlist_item_append()
18874 * @see elm_genlist_item_prepend()
18875 * @see elm_genlist_item_insert_before()
18876 * @see elm_genlist_item_del()
18880 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);
18882 * Insert a new item into the sorted genlist object
18884 * @param obj The genlist object
18885 * @param itc The item class for the item
18886 * @param data The item data
18887 * @param parent The parent item, or NULL if none
18888 * @param flags Item flags
18889 * @param comp The function called for the sort
18890 * @param func Convenience function called when item selected
18891 * @param func_data Data passed to @p func above.
18892 * @return A handle to the item added or NULL if not possible
18896 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);
18897 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);
18898 /* operations to retrieve existing items */
18900 * Get the selectd item in the genlist.
18902 * @param obj The genlist object
18903 * @return The selected item, or NULL if none is selected.
18905 * This gets the selected item in the list (if multi-selection is enabled, only
18906 * the item that was first selected in the list is returned - which is not very
18907 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
18910 * If no item is selected, NULL is returned.
18912 * @see elm_genlist_selected_items_get()
18916 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18918 * Get a list of selected items in the genlist.
18920 * @param obj The genlist object
18921 * @return The list of selected items, or NULL if none are selected.
18923 * It returns a list of the selected items. This list pointer is only valid so
18924 * long as the selection doesn't change (no items are selected or unselected, or
18925 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
18926 * pointers. The order of the items in this list is the order which they were
18927 * selected, i.e. the first item in this list is the first item that was
18928 * selected, and so on.
18930 * @note If not in multi-select mode, consider using function
18931 * elm_genlist_selected_item_get() instead.
18933 * @see elm_genlist_multi_select_set()
18934 * @see elm_genlist_selected_item_get()
18938 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18940 * Get the mode item style of items in the genlist
18941 * @param obj The genlist object
18942 * @return The mode item style string, or NULL if none is specified
18944 * This is a constant string and simply defines the name of the
18945 * style that will be used for mode animations. It can be
18946 * @c NULL if you don't plan to use Genlist mode. See
18947 * elm_genlist_item_mode_set() for more info.
18951 EAPI const char *elm_genlist_mode_item_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18953 * Set the mode item style of items in the genlist
18954 * @param obj The genlist object
18955 * @param style The mode item style string, or NULL if none is desired
18957 * This is a constant string and simply defines the name of the
18958 * style that will be used for mode animations. It can be
18959 * @c NULL if you don't plan to use Genlist mode. See
18960 * elm_genlist_item_mode_set() for more info.
18964 EAPI void elm_genlist_mode_item_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
18966 * Get a list of realized items in genlist
18968 * @param obj The genlist object
18969 * @return The list of realized items, nor NULL if none are realized.
18971 * This returns a list of the realized items in the genlist. The list
18972 * contains Elm_Genlist_Item pointers. The list must be freed by the
18973 * caller when done with eina_list_free(). The item pointers in the
18974 * list are only valid so long as those items are not deleted or the
18975 * genlist is not deleted.
18977 * @see elm_genlist_realized_items_update()
18981 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18983 * Get the item that is at the x, y canvas coords.
18985 * @param obj The gelinst object.
18986 * @param x The input x coordinate
18987 * @param y The input y coordinate
18988 * @param posret The position relative to the item returned here
18989 * @return The item at the coordinates or NULL if none
18991 * This returns the item at the given coordinates (which are canvas
18992 * relative, not object-relative). If an item is at that coordinate,
18993 * that item handle is returned, and if @p posret is not NULL, the
18994 * integer pointed to is set to a value of -1, 0 or 1, depending if
18995 * the coordinate is on the upper portion of that item (-1), on the
18996 * middle section (0) or on the lower part (1). If NULL is returned as
18997 * an item (no item found there), then posret may indicate -1 or 1
18998 * based if the coordinate is above or below all items respectively in
19003 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);
19005 * Get the first item in the genlist
19007 * This returns the first item in the list.
19009 * @param obj The genlist object
19010 * @return The first item, or NULL if none
19014 EINA_DEPRECATED EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19016 * Get the last item in the genlist
19018 * This returns the last item in the list.
19020 * @return The last item, or NULL if none
19024 EINA_DEPRECATED EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19026 * Set the scrollbar policy
19028 * @param obj The genlist object
19029 * @param policy_h Horizontal scrollbar policy.
19030 * @param policy_v Vertical scrollbar policy.
19032 * This sets the scrollbar visibility policy for the given genlist
19033 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
19034 * made visible if it is needed, and otherwise kept hidden.
19035 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
19036 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
19037 * respectively for the horizontal and vertical scrollbars. Default is
19038 * #ELM_SMART_SCROLLER_POLICY_AUTO
19040 * @see elm_genlist_scroller_policy_get()
19044 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
19046 * Get the scrollbar policy
19048 * @param obj The genlist object
19049 * @param policy_h Pointer to store the horizontal scrollbar policy.
19050 * @param policy_v Pointer to store the vertical scrollbar policy.
19052 * @see elm_genlist_scroller_policy_set()
19056 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);
19058 * Get the @b next item in a genlist widget's internal list of items,
19059 * given a handle to one of those items.
19061 * @param item The genlist item to fetch next from
19062 * @return The item after @p item, or @c NULL if there's none (and
19065 * This returns the item placed after the @p item, on the container
19068 * @see elm_genlist_item_prev_get()
19072 EINA_DEPRECATED EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19074 * Get the @b previous item in a genlist widget's internal list of items,
19075 * given a handle to one of those items.
19077 * @param item The genlist item to fetch previous from
19078 * @return The item before @p item, or @c NULL if there's none (and
19081 * This returns the item placed before the @p item, on the container
19084 * @see elm_genlist_item_next_get()
19088 EINA_DEPRECATED EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19090 * Get the genlist object's handle which contains a given genlist
19093 * @param item The item to fetch the container from
19094 * @return The genlist (parent) object
19096 * This returns the genlist object itself that an item belongs to.
19100 EINA_DEPRECATED EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19102 * Get the parent item of the given item
19104 * @param it The item
19105 * @return The parent of the item or @c NULL if it has no parent.
19107 * This returns the item that was specified as parent of the item @p it on
19108 * elm_genlist_item_append() and insertion related functions.
19112 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19114 * Remove all sub-items (children) of the given item
19116 * @param it The item
19118 * This removes all items that are children (and their descendants) of the
19119 * given item @p it.
19121 * @see elm_genlist_clear()
19122 * @see elm_genlist_item_del()
19126 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19128 * Set whether a given genlist item is selected or not
19130 * @param it The item
19131 * @param selected Use @c EINA_TRUE, to make it selected, @c
19132 * EINA_FALSE to make it unselected
19134 * This sets the selected state of an item. If multi selection is
19135 * not enabled on the containing genlist and @p selected is @c
19136 * EINA_TRUE, any other previously selected items will get
19137 * unselected in favor of this new one.
19139 * @see elm_genlist_item_selected_get()
19143 EINA_DEPRECATED EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
19145 * Get whether a given genlist item is selected or not
19147 * @param it The item
19148 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
19150 * @see elm_genlist_item_selected_set() for more details
19154 EINA_DEPRECATED EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19156 * Sets the expanded state of an item.
19158 * @param it The item
19159 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
19161 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
19164 * The theme will respond to this change visually, and a signal "expanded" or
19165 * "contracted" will be sent from the genlist with a pointer to the item that
19166 * has been expanded/contracted.
19168 * Calling this function won't show or hide any child of this item (if it is
19169 * a parent). You must manually delete and create them on the callbacks fo
19170 * the "expanded" or "contracted" signals.
19172 * @see elm_genlist_item_expanded_get()
19176 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
19178 * Get the expanded state of an item
19180 * @param it The item
19181 * @return The expanded state
19183 * This gets the expanded state of an item.
19185 * @see elm_genlist_item_expanded_set()
19189 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19191 * Get the depth of expanded item
19193 * @param it The genlist item object
19194 * @return The depth of expanded item
19198 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19200 * Set whether a given genlist item is disabled or not.
19202 * @param it The item
19203 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
19204 * to enable it back.
19206 * A disabled item cannot be selected or unselected. It will also
19207 * change its appearance, to signal the user it's disabled.
19209 * @see elm_genlist_item_disabled_get()
19213 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
19215 * Get whether a given genlist item is disabled or not.
19217 * @param it The item
19218 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
19221 * @see elm_genlist_item_disabled_set() for more details
19225 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19227 * Sets the display only state of an item.
19229 * @param it The item
19230 * @param display_only @c EINA_TRUE if the item is display only, @c
19231 * EINA_FALSE otherwise.
19233 * A display only item cannot be selected or unselected. It is for
19234 * display only and not selecting or otherwise clicking, dragging
19235 * etc. by the user, thus finger size rules will not be applied to
19238 * It's good to set group index items to display only state.
19240 * @see elm_genlist_item_display_only_get()
19244 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
19246 * Get the display only state of an item
19248 * @param it The item
19249 * @return @c EINA_TRUE if the item is display only, @c
19250 * EINA_FALSE otherwise.
19252 * @see elm_genlist_item_display_only_set()
19256 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19258 * Show the portion of a genlist's internal list containing a given
19259 * item, immediately.
19261 * @param it The item to display
19263 * This causes genlist to jump to the given item @p it and show it (by
19264 * immediately scrolling to that position), if it is not fully visible.
19266 * @see elm_genlist_item_bring_in()
19267 * @see elm_genlist_item_top_show()
19268 * @see elm_genlist_item_middle_show()
19272 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19274 * Animatedly bring in, to the visible are of a genlist, a given
19277 * @param it The item to display
19279 * This causes genlist to jump to the given item @p it and show it (by
19280 * animatedly scrolling), if it is not fully visible. This may use animation
19281 * to do so and take a period of time
19283 * @see elm_genlist_item_show()
19284 * @see elm_genlist_item_top_bring_in()
19285 * @see elm_genlist_item_middle_bring_in()
19289 EAPI void elm_genlist_item_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 top of the genlist viewport.
19301 * @see elm_genlist_item_show()
19302 * @see elm_genlist_item_top_bring_in()
19306 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) 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 top of the genlist viewport.
19319 * @see elm_genlist_item_bring_in()
19320 * @see elm_genlist_item_top_show()
19324 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19326 * Show the portion of a genlist's internal list containing a given
19327 * item, immediately.
19329 * @param it The item to display
19331 * This causes genlist to jump to the given item @p it and show it (by
19332 * immediately scrolling to that position), if it is not fully visible.
19334 * The item will be positioned at the middle of the genlist viewport.
19336 * @see elm_genlist_item_show()
19337 * @see elm_genlist_item_middle_bring_in()
19341 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19343 * Animatedly bring in, to the visible are of a genlist, a given
19346 * @param it The item
19348 * This causes genlist to jump to the given item @p it and show it (by
19349 * animatedly scrolling), if it is not fully visible. This may use animation
19350 * to do so and take a period of time
19352 * The item will be positioned at the middle of the genlist viewport.
19354 * @see elm_genlist_item_bring_in()
19355 * @see elm_genlist_item_middle_show()
19359 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19361 * Remove a genlist item from the its parent, deleting it.
19363 * @param item The item to be removed.
19364 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
19366 * @see elm_genlist_clear(), to remove all items in a genlist at
19371 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19373 * Return the data associated to a given genlist item
19375 * @param item The genlist item.
19376 * @return the data associated to this item.
19378 * This returns the @c data value passed on the
19379 * elm_genlist_item_append() and related item addition calls.
19381 * @see elm_genlist_item_append()
19382 * @see elm_genlist_item_data_set()
19386 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19388 * Set the data associated to a given genlist item
19390 * @param item The genlist item
19391 * @param data The new data pointer to set on it
19393 * This @b overrides the @c data value passed on the
19394 * elm_genlist_item_append() and related item addition calls. This
19395 * function @b won't call elm_genlist_item_update() automatically,
19396 * so you'd issue it afterwards if you want to hove the item
19397 * updated to reflect the that new data.
19399 * @see elm_genlist_item_data_get()
19403 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
19405 * Tells genlist to "orphan" icons fetchs by the item class
19407 * @param it The item
19409 * This instructs genlist to release references to icons in the item,
19410 * meaning that they will no longer be managed by genlist and are
19411 * floating "orphans" that can be re-used elsewhere if the user wants
19416 EAPI void elm_genlist_item_contents_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19417 EINA_DEPRECATED EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19419 * Get the real Evas object created to implement the view of a
19420 * given genlist item
19422 * @param item The genlist item.
19423 * @return the Evas object implementing this item's view.
19425 * This returns the actual Evas object used to implement the
19426 * specified genlist item's view. This may be @c NULL, as it may
19427 * not have been created or may have been deleted, at any time, by
19428 * the genlist. <b>Do not modify this object</b> (move, resize,
19429 * show, hide, etc.), as the genlist is controlling it. This
19430 * function is for querying, emitting custom signals or hooking
19431 * lower level callbacks for events on that object. Do not delete
19432 * this object under any circumstances.
19434 * @see elm_genlist_item_data_get()
19438 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19440 * Update the contents of an item
19442 * @param it The item
19444 * This updates an item by calling all the item class functions again
19445 * to get the icons, labels and states. Use this when the original
19446 * item data has changed and the changes are desired to be reflected.
19448 * Use elm_genlist_realized_items_update() to update all already realized
19451 * @see elm_genlist_realized_items_update()
19455 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19457 * Update the item class of an item
19459 * @param it The item
19460 * @param itc The item class for the item
19462 * This sets another class fo the item, changing the way that it is
19463 * displayed. After changing the item class, elm_genlist_item_update() is
19464 * called on the item @p it.
19468 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
19469 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19471 * Set the text to be shown in a given genlist item's tooltips.
19473 * @param item The genlist item
19474 * @param text The text to set in the content
19476 * This call will setup the text to be used as tooltip to that item
19477 * (analogous to elm_object_tooltip_text_set(), but being item
19478 * tooltips with higher precedence than object tooltips). It can
19479 * have only one tooltip at a time, so any previous tooltip data
19480 * will get removed.
19482 * In order to set an icon or something else as a tooltip, look at
19483 * elm_genlist_item_tooltip_content_cb_set().
19487 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
19489 * Set the content to be shown in a given genlist item's tooltips
19491 * @param item The genlist item.
19492 * @param func The function returning the tooltip contents.
19493 * @param data What to provide to @a func as callback data/context.
19494 * @param del_cb Called when data is not needed anymore, either when
19495 * another callback replaces @p func, the tooltip is unset with
19496 * elm_genlist_item_tooltip_unset() or the owner @p item
19497 * dies. This callback receives as its first parameter the
19498 * given @p data, being @c event_info the item handle.
19500 * This call will setup the tooltip's contents to @p item
19501 * (analogous to elm_object_tooltip_content_cb_set(), but being
19502 * item tooltips with higher precedence than object tooltips). It
19503 * can have only one tooltip at a time, so any previous tooltip
19504 * content will get removed. @p func (with @p data) will be called
19505 * every time Elementary needs to show the tooltip and it should
19506 * return a valid Evas object, which will be fully managed by the
19507 * tooltip system, getting deleted when the tooltip is gone.
19509 * In order to set just a text as a tooltip, look at
19510 * elm_genlist_item_tooltip_text_set().
19514 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);
19516 * Unset a tooltip from a given genlist item
19518 * @param item genlist item to remove a previously set tooltip from.
19520 * This call removes any tooltip set on @p item. The callback
19521 * provided as @c del_cb to
19522 * elm_genlist_item_tooltip_content_cb_set() will be called to
19523 * notify it is not used anymore (and have resources cleaned, if
19526 * @see elm_genlist_item_tooltip_content_cb_set()
19530 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19532 * Set a different @b style for a given genlist item's tooltip.
19534 * @param item genlist item with tooltip set
19535 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
19536 * "default", @c "transparent", etc)
19538 * Tooltips can have <b>alternate styles</b> to be displayed on,
19539 * which are defined by the theme set on Elementary. This function
19540 * works analogously as elm_object_tooltip_style_set(), but here
19541 * applied only to genlist item objects. The default style for
19542 * tooltips is @c "default".
19544 * @note before you set a style you should define a tooltip with
19545 * elm_genlist_item_tooltip_content_cb_set() or
19546 * elm_genlist_item_tooltip_text_set()
19548 * @see elm_genlist_item_tooltip_style_get()
19552 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19554 * Get the style set a given genlist item's tooltip.
19556 * @param item genlist item with tooltip already set on.
19557 * @return style the theme style in use, which defaults to
19558 * "default". If the object does not have a tooltip set,
19559 * then @c NULL is returned.
19561 * @see elm_genlist_item_tooltip_style_set() for more details
19565 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19567 * @brief Disable size restrictions on an object's tooltip
19568 * @param item The tooltip's anchor object
19569 * @param disable If EINA_TRUE, size restrictions are disabled
19570 * @return EINA_FALSE on failure, EINA_TRUE on success
19572 * This function allows a tooltip to expand beyond its parant window's canvas.
19573 * It will instead be limited only by the size of the display.
19575 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
19577 * @brief Retrieve size restriction state of an object's tooltip
19578 * @param item The tooltip's anchor object
19579 * @return If EINA_TRUE, size restrictions are disabled
19581 * This function returns whether a tooltip is allowed to expand beyond
19582 * its parant window's canvas.
19583 * It will instead be limited only by the size of the display.
19585 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
19587 * Set the type of mouse pointer/cursor decoration to be shown,
19588 * when the mouse pointer is over the given genlist widget item
19590 * @param item genlist item to customize cursor on
19591 * @param cursor the cursor type's name
19593 * This function works analogously as elm_object_cursor_set(), but
19594 * here the cursor's changing area is restricted to the item's
19595 * area, and not the whole widget's. Note that that item cursors
19596 * have precedence over widget cursors, so that a mouse over @p
19597 * item will always show cursor @p type.
19599 * If this function is called twice for an object, a previously set
19600 * cursor will be unset on the second call.
19602 * @see elm_object_cursor_set()
19603 * @see elm_genlist_item_cursor_get()
19604 * @see elm_genlist_item_cursor_unset()
19608 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
19610 * Get the type of mouse pointer/cursor decoration set to be shown,
19611 * when the mouse pointer is over the given genlist widget item
19613 * @param item genlist item with custom cursor set
19614 * @return the cursor type's name or @c NULL, if no custom cursors
19615 * were set to @p item (and on errors)
19617 * @see elm_object_cursor_get()
19618 * @see elm_genlist_item_cursor_set() for more details
19619 * @see elm_genlist_item_cursor_unset()
19623 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19625 * Unset any custom mouse pointer/cursor decoration set to be
19626 * shown, when the mouse pointer is over the given genlist widget
19627 * item, thus making it show the @b default cursor again.
19629 * @param item a genlist item
19631 * Use this call to undo any custom settings on this item's cursor
19632 * decoration, bringing it back to defaults (no custom style set).
19634 * @see elm_object_cursor_unset()
19635 * @see elm_genlist_item_cursor_set() for more details
19639 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19641 * Set a different @b style for a given custom cursor set for a
19644 * @param item genlist item with custom cursor set
19645 * @param style the <b>theme style</b> to use (e.g. @c "default",
19646 * @c "transparent", etc)
19648 * This function only makes sense when one is using custom mouse
19649 * cursor decorations <b>defined in a theme file</b> , which can
19650 * have, given a cursor name/type, <b>alternate styles</b> on
19651 * it. It works analogously as elm_object_cursor_style_set(), but
19652 * here applied only to genlist item objects.
19654 * @warning Before you set a cursor style you should have defined a
19655 * custom cursor previously on the item, with
19656 * elm_genlist_item_cursor_set()
19658 * @see elm_genlist_item_cursor_engine_only_set()
19659 * @see elm_genlist_item_cursor_style_get()
19663 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19665 * Get the current @b style set for a given genlist item's custom
19668 * @param item genlist item with custom cursor set.
19669 * @return style the cursor style in use. If the object does not
19670 * have a cursor set, then @c NULL is returned.
19672 * @see elm_genlist_item_cursor_style_set() for more details
19676 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19678 * Set if the (custom) cursor for a given genlist item should be
19679 * searched in its theme, also, or should only rely on the
19680 * rendering engine.
19682 * @param item item with custom (custom) cursor already set on
19683 * @param engine_only Use @c EINA_TRUE to have cursors looked for
19684 * only on those provided by the rendering engine, @c EINA_FALSE to
19685 * have them searched on the widget's theme, as well.
19687 * @note This call is of use only if you've set a custom cursor
19688 * for genlist items, with elm_genlist_item_cursor_set().
19690 * @note By default, cursors will only be looked for between those
19691 * provided by the rendering engine.
19695 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
19697 * Get if the (custom) cursor for a given genlist item is being
19698 * searched in its theme, also, or is only relying on the rendering
19701 * @param item a genlist item
19702 * @return @c EINA_TRUE, if cursors are being looked for only on
19703 * those provided by the rendering engine, @c EINA_FALSE if they
19704 * are being searched on the widget's theme, as well.
19706 * @see elm_genlist_item_cursor_engine_only_set(), for more details
19710 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19712 * Update the contents of all realized items.
19714 * @param obj The genlist object.
19716 * This updates all realized items by calling all the item class functions again
19717 * to get the icons, labels and states. Use this when the original
19718 * item data has changed and the changes are desired to be reflected.
19720 * To update just one item, use elm_genlist_item_update().
19722 * @see elm_genlist_realized_items_get()
19723 * @see elm_genlist_item_update()
19727 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
19729 * Activate a genlist mode on an item
19731 * @param item The genlist item
19732 * @param mode Mode name
19733 * @param mode_set Boolean to define set or unset mode.
19735 * A genlist mode is a different way of selecting an item. Once a mode is
19736 * activated on an item, any other selected item is immediately unselected.
19737 * This feature provides an easy way of implementing a new kind of animation
19738 * for selecting an item, without having to entirely rewrite the item style
19739 * theme. However, the elm_genlist_selected_* API can't be used to get what
19740 * item is activate for a mode.
19742 * The current item style will still be used, but applying a genlist mode to
19743 * an item will select it using a different kind of animation.
19745 * The current active item for a mode can be found by
19746 * elm_genlist_mode_item_get().
19748 * The characteristics of genlist mode are:
19749 * - Only one mode can be active at any time, and for only one item.
19750 * - Genlist handles deactivating other items when one item is activated.
19751 * - A mode is defined in the genlist theme (edc), and more modes can easily
19753 * - A mode style and the genlist item style are different things. They
19754 * can be combined to provide a default style to the item, with some kind
19755 * of animation for that item when the mode is activated.
19757 * When a mode is activated on an item, a new view for that item is created.
19758 * The theme of this mode defines the animation that will be used to transit
19759 * the item from the old view to the new view. This second (new) view will be
19760 * active for that item while the mode is active on the item, and will be
19761 * destroyed after the mode is totally deactivated from that item.
19763 * @see elm_genlist_mode_get()
19764 * @see elm_genlist_mode_item_get()
19768 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
19770 * Get the last (or current) genlist mode used.
19772 * @param obj The genlist object
19774 * This function just returns the name of the last used genlist mode. It will
19775 * be the current mode if it's still active.
19777 * @see elm_genlist_item_mode_set()
19778 * @see elm_genlist_mode_item_get()
19782 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19784 * Get active genlist mode item
19786 * @param obj The genlist object
19787 * @return The active item for that current mode. Or @c NULL if no item is
19788 * activated with any mode.
19790 * This function returns the item that was activated with a mode, by the
19791 * function elm_genlist_item_mode_set().
19793 * @see elm_genlist_item_mode_set()
19794 * @see elm_genlist_mode_get()
19798 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19803 * @param obj The genlist object
19804 * @param reorder_mode The reorder mode
19805 * (EINA_TRUE = on, EINA_FALSE = off)
19809 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
19812 * Get the reorder mode
19814 * @param obj The genlist object
19815 * @return The reorder mode
19816 * (EINA_TRUE = on, EINA_FALSE = off)
19820 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19827 * @defgroup Check Check
19829 * @image html img/widget/check/preview-00.png
19830 * @image latex img/widget/check/preview-00.eps
19831 * @image html img/widget/check/preview-01.png
19832 * @image latex img/widget/check/preview-01.eps
19833 * @image html img/widget/check/preview-02.png
19834 * @image latex img/widget/check/preview-02.eps
19836 * @brief The check widget allows for toggling a value between true and
19839 * Check objects are a lot like radio objects in layout and functionality
19840 * except they do not work as a group, but independently and only toggle the
19841 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
19842 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
19843 * returns the current state. For convenience, like the radio objects, you
19844 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
19845 * for it to modify.
19847 * Signals that you can add callbacks for are:
19848 * "changed" - This is called whenever the user changes the state of one of
19849 * the check object(event_info is NULL).
19851 * Default contents parts of the check widget that you can use for are:
19852 * @li "elm.swallow.content" - A icon of the check
19854 * Default text parts of the check widget that you can use for are:
19855 * @li "elm.text" - Label of the check
19857 * @ref tutorial_check should give you a firm grasp of how to use this widget
19862 * @brief Add a new Check object
19864 * @param parent The parent object
19865 * @return The new object or NULL if it cannot be created
19867 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19869 * @brief Set the text label of the check object
19871 * @param obj The check object
19872 * @param label The text label string in UTF-8
19874 * @deprecated use elm_object_text_set() instead.
19876 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19878 * @brief Get the text label of the check object
19880 * @param obj The check object
19881 * @return The text label string in UTF-8
19883 * @deprecated use elm_object_text_get() instead.
19885 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19887 * @brief Set the icon object of the check object
19889 * @param obj The check object
19890 * @param icon The icon object
19892 * Once the icon object is set, a previously set one will be deleted.
19893 * If you want to keep that old content object, use the
19894 * elm_object_content_unset() function.
19896 * @deprecated use elm_object_content_set() instead.
19899 EINA_DEPRECATED EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19901 * @brief Get the icon object of the check object
19903 * @param obj The check object
19904 * @return The icon object
19906 * @deprecated use elm_object_content_get() instead.
19909 EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19911 * @brief Unset the icon used for the check object
19913 * @param obj The check object
19914 * @return The icon object that was being used
19916 * Unparent and return the icon object which was set for this widget.
19918 * @deprecated use elm_object_content_unset() instead.
19921 EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19923 * @brief Set the on/off state of the check object
19925 * @param obj The check object
19926 * @param state The state to use (1 == on, 0 == off)
19928 * This sets the state of the check. If set
19929 * with elm_check_state_pointer_set() the state of that variable is also
19930 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
19932 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
19934 * @brief Get the state of the check object
19936 * @param obj The check object
19937 * @return The boolean state
19939 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19941 * @brief Set a convenience pointer to a boolean to change
19943 * @param obj The check object
19944 * @param statep Pointer to the boolean to modify
19946 * This sets a pointer to a boolean, that, in addition to the check objects
19947 * state will also be modified directly. To stop setting the object pointed
19948 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
19949 * then when this is called, the check objects state will also be modified to
19950 * reflect the value of the boolean @p statep points to, just like calling
19951 * elm_check_state_set().
19953 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
19954 EINA_DEPRECATED EAPI void elm_check_states_labels_set(Evas_Object *obj, const char *ontext, const char *offtext) EINA_ARG_NONNULL(1,2,3);
19955 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);
19962 * @defgroup Radio Radio
19964 * @image html img/widget/radio/preview-00.png
19965 * @image latex img/widget/radio/preview-00.eps
19967 * @brief Radio is a widget that allows for 1 or more options to be displayed
19968 * and have the user choose only 1 of them.
19970 * A radio object contains an indicator, an optional Label and an optional
19971 * icon object. While it's possible to have a group of only one radio they,
19972 * are normally used in groups of 2 or more. To add a radio to a group use
19973 * elm_radio_group_add(). The radio object(s) will select from one of a set
19974 * of integer values, so any value they are configuring needs to be mapped to
19975 * a set of integers. To configure what value that radio object represents,
19976 * use elm_radio_state_value_set() to set the integer it represents. To set
19977 * the value the whole group(which one is currently selected) is to indicate
19978 * use elm_radio_value_set() on any group member, and to get the groups value
19979 * use elm_radio_value_get(). For convenience the radio objects are also able
19980 * to directly set an integer(int) to the value that is selected. To specify
19981 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
19982 * The radio objects will modify this directly. That implies the pointer must
19983 * point to valid memory for as long as the radio objects exist.
19985 * Signals that you can add callbacks for are:
19986 * @li changed - This is called whenever the user changes the state of one of
19987 * the radio objects within the group of radio objects that work together.
19989 * Default contents parts of the radio widget that you can use for are:
19990 * @li "elm.swallow.content" - A icon of the radio
19992 * @ref tutorial_radio show most of this API in action.
19996 * @brief Add a new radio to the parent
19998 * @param parent The parent object
19999 * @return The new object or NULL if it cannot be created
20001 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20003 * @brief Set the text label of the radio object
20005 * @param obj The radio object
20006 * @param label The text label string in UTF-8
20008 * @deprecated use elm_object_text_set() instead.
20010 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
20012 * @brief Get the text label of the radio object
20014 * @param obj The radio object
20015 * @return The text label string in UTF-8
20017 * @deprecated use elm_object_text_set() instead.
20019 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20021 * @brief Set the icon object of the radio object
20023 * @param obj The radio object
20024 * @param icon The icon object
20026 * Once the icon object is set, a previously set one will be deleted. If you
20027 * want to keep that old content object, use the elm_radio_icon_unset()
20030 * @deprecated use elm_object_content_set() instead.
20033 EINA_DEPRECATED EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
20035 * @brief Get the icon object of the radio object
20037 * @param obj The radio object
20038 * @return The icon object
20040 * @see elm_radio_icon_set()
20042 * @deprecated use elm_object_content_get() instead.
20045 EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20047 * @brief Unset the icon used for the radio object
20049 * @param obj The radio object
20050 * @return The icon object that was being used
20052 * Unparent and return the icon object which was set for this widget.
20054 * @see elm_radio_icon_set()
20055 * @deprecated use elm_object_content_unset() instead.
20058 EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20060 * @brief Add this radio to a group of other radio objects
20062 * @param obj The radio object
20063 * @param group Any object whose group the @p obj is to join.
20065 * Radio objects work in groups. Each member should have a different integer
20066 * value assigned. In order to have them work as a group, they need to know
20067 * about each other. This adds the given radio object to the group of which
20068 * the group object indicated is a member.
20070 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
20072 * @brief Set the integer value that this radio object represents
20074 * @param obj The radio object
20075 * @param value The value to use if this radio object is selected
20077 * This sets the value of the radio.
20079 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
20081 * @brief Get the integer value that this radio object represents
20083 * @param obj The radio object
20084 * @return The value used if this radio object is selected
20086 * This gets the value of the radio.
20088 * @see elm_radio_value_set()
20090 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20092 * @brief Set the value of the radio.
20094 * @param obj The radio object
20095 * @param value The value to use for the group
20097 * This sets the value of the radio group and will also set the value if
20098 * pointed to, to the value supplied, but will not call any callbacks.
20100 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
20102 * @brief Get the state of the radio object
20104 * @param obj The radio object
20105 * @return The integer state
20107 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20109 * @brief Set a convenience pointer to a integer to change
20111 * @param obj The radio object
20112 * @param valuep Pointer to the integer to modify
20114 * This sets a pointer to a integer, that, in addition to the radio objects
20115 * state will also be modified directly. To stop setting the object pointed
20116 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
20117 * when this is called, the radio objects state will also be modified to
20118 * reflect the value of the integer valuep points to, just like calling
20119 * elm_radio_value_set().
20121 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
20127 * @defgroup Pager Pager
20129 * @image html img/widget/pager/preview-00.png
20130 * @image latex img/widget/pager/preview-00.eps
20132 * @brief Widget that allows flipping between 1 or more āpagesā of objects.
20134 * The flipping between āpagesā of objects is animated. All content in pager
20135 * is kept in a stack, the last content to be added will be on the top of the
20136 * stack(be visible).
20138 * Objects can be pushed or popped from the stack or deleted as normal.
20139 * Pushes and pops will animate (and a pop will delete the object once the
20140 * animation is finished). Any object already in the pager can be promoted to
20141 * the top(from its current stacking position) through the use of
20142 * elm_pager_content_promote(). Objects are pushed to the top with
20143 * elm_pager_content_push() and when the top item is no longer wanted, simply
20144 * pop it with elm_pager_content_pop() and it will also be deleted. If an
20145 * object is no longer needed and is not the top item, just delete it as
20146 * normal. You can query which objects are the top and bottom with
20147 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
20149 * Signals that you can add callbacks for are:
20150 * "hide,finished" - when the previous page is hided
20152 * This widget has the following styles available:
20155 * @li fade_translucide
20156 * @li fade_invisible
20157 * @note This styles affect only the flipping animations, the appearance when
20158 * not animating is unaffected by styles.
20160 * @ref tutorial_pager gives a good overview of the usage of the API.
20164 * Add a new pager to the parent
20166 * @param parent The parent object
20167 * @return The new object or NULL if it cannot be created
20171 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20173 * @brief Push an object to the top of the pager stack (and show it).
20175 * @param obj The pager object
20176 * @param content The object to push
20178 * The object pushed becomes a child of the pager, it will be controlled and
20179 * deleted when the pager is deleted.
20181 * @note If the content is already in the stack use
20182 * elm_pager_content_promote().
20183 * @warning Using this function on @p content already in the stack results in
20184 * undefined behavior.
20186 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20188 * @brief Pop the object that is on top of the stack
20190 * @param obj The pager object
20192 * This pops the object that is on the top(visible) of the pager, makes it
20193 * disappear, then deletes the object. The object that was underneath it on
20194 * the stack will become visible.
20196 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
20198 * @brief Moves an object already in the pager stack to the top of the stack.
20200 * @param obj The pager object
20201 * @param content The object to promote
20203 * This will take the @p content and move it to the top of the stack as
20204 * if it had been pushed there.
20206 * @note If the content isn't already in the stack use
20207 * elm_pager_content_push().
20208 * @warning Using this function on @p content not already in the stack
20209 * results in undefined behavior.
20211 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20213 * @brief Return the object at the bottom of the pager stack
20215 * @param obj The pager object
20216 * @return The bottom object or NULL if none
20218 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20220 * @brief Return the object at the top of the pager stack
20222 * @param obj The pager object
20223 * @return The top object or NULL if none
20225 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20232 * @defgroup Slideshow Slideshow
20234 * @image html img/widget/slideshow/preview-00.png
20235 * @image latex img/widget/slideshow/preview-00.eps
20237 * This widget, as the name indicates, is a pre-made image
20238 * slideshow panel, with API functions acting on (child) image
20239 * items presentation. Between those actions, are:
20240 * - advance to next/previous image
20241 * - select the style of image transition animation
20242 * - set the exhibition time for each image
20243 * - start/stop the slideshow
20245 * The transition animations are defined in the widget's theme,
20246 * consequently new animations can be added without having to
20247 * update the widget's code.
20249 * @section Slideshow_Items Slideshow items
20251 * For slideshow items, just like for @ref Genlist "genlist" ones,
20252 * the user defines a @b classes, specifying functions that will be
20253 * called on the item's creation and deletion times.
20255 * The #Elm_Slideshow_Item_Class structure contains the following
20258 * - @c func.get - When an item is displayed, this function is
20259 * called, and it's where one should create the item object, de
20260 * facto. For example, the object can be a pure Evas image object
20261 * or an Elementary @ref Photocam "photocam" widget. See
20262 * #SlideshowItemGetFunc.
20263 * - @c func.del - When an item is no more displayed, this function
20264 * is called, where the user must delete any data associated to
20265 * the item. See #SlideshowItemDelFunc.
20267 * @section Slideshow_Caching Slideshow caching
20269 * The slideshow provides facilities to have items adjacent to the
20270 * one being displayed <b>already "realized"</b> (i.e. loaded) for
20271 * you, so that the system does not have to decode image data
20272 * anymore at the time it has to actually switch images on its
20273 * viewport. The user is able to set the numbers of items to be
20274 * cached @b before and @b after the current item, in the widget's
20277 * Smart events one can add callbacks for are:
20279 * - @c "changed" - when the slideshow switches its view to a new
20282 * List of examples for the slideshow widget:
20283 * @li @ref slideshow_example
20287 * @addtogroup Slideshow
20291 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
20292 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
20293 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Slideshow item handle */
20294 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
20295 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
20298 * @struct _Elm_Slideshow_Item_Class
20300 * Slideshow item class definition. See @ref Slideshow_Items for
20303 struct _Elm_Slideshow_Item_Class
20305 struct _Elm_Slideshow_Item_Class_Func
20307 SlideshowItemGetFunc get;
20308 SlideshowItemDelFunc del;
20310 }; /**< #Elm_Slideshow_Item_Class member definitions */
20313 * Add a new slideshow widget to the given parent Elementary
20314 * (container) object
20316 * @param parent The parent object
20317 * @return A new slideshow widget handle or @c NULL, on errors
20319 * This function inserts a new slideshow widget on the canvas.
20321 * @ingroup Slideshow
20323 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20326 * Add (append) a new item in a given slideshow widget.
20328 * @param obj The slideshow object
20329 * @param itc The item class for the item
20330 * @param data The item's data
20331 * @return A handle to the item added or @c NULL, on errors
20333 * Add a new item to @p obj's internal list of items, appending it.
20334 * The item's class must contain the function really fetching the
20335 * image object to show for this item, which could be an Evas image
20336 * object or an Elementary photo, for example. The @p data
20337 * parameter is going to be passed to both class functions of the
20340 * @see #Elm_Slideshow_Item_Class
20341 * @see elm_slideshow_item_sorted_insert()
20343 * @ingroup Slideshow
20345 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
20348 * Insert a new item into the given slideshow widget, using the @p func
20349 * function to sort items (by item handles).
20351 * @param obj The slideshow object
20352 * @param itc The item class for the item
20353 * @param data The item's data
20354 * @param func The comparing function to be used to sort slideshow
20355 * items <b>by #Elm_Slideshow_Item item handles</b>
20356 * @return Returns The slideshow item handle, on success, or
20357 * @c NULL, on errors
20359 * Add a new item to @p obj's internal list of items, in a position
20360 * determined by the @p func comparing function. The item's class
20361 * must contain the function really fetching the image object to
20362 * show for this item, which could be an Evas image object or an
20363 * Elementary photo, for example. The @p data parameter is going to
20364 * be passed to both class functions of the item.
20366 * @see #Elm_Slideshow_Item_Class
20367 * @see elm_slideshow_item_add()
20369 * @ingroup Slideshow
20371 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);
20374 * Display a given slideshow widget's item, programmatically.
20376 * @param obj The slideshow object
20377 * @param item The item to display on @p obj's viewport
20379 * The change between the current item and @p item will use the
20380 * transition @p obj is set to use (@see
20381 * elm_slideshow_transition_set()).
20383 * @ingroup Slideshow
20385 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20388 * Slide to the @b next item, in a given slideshow widget
20390 * @param obj The slideshow object
20392 * The sliding animation @p obj is set to use will be the
20393 * transition effect used, after this call is issued.
20395 * @note If the end of the slideshow's internal list of items is
20396 * reached, it'll wrap around to the list's beginning, again.
20398 * @ingroup Slideshow
20400 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20403 * Slide to the @b previous item, in a given slideshow widget
20405 * @param obj The slideshow object
20407 * The sliding animation @p obj is set to use will be the
20408 * transition effect used, after this call is issued.
20410 * @note If the beginning of the slideshow's internal list of items
20411 * is reached, it'll wrap around to the list's end, again.
20413 * @ingroup Slideshow
20415 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
20418 * Returns the list of sliding transition/effect names available, for a
20419 * given slideshow widget.
20421 * @param obj The slideshow object
20422 * @return The list of transitions (list of @b stringshared strings
20425 * The transitions, which come from @p obj's theme, must be an EDC
20426 * data item named @c "transitions" on the theme file, with (prefix)
20427 * names of EDC programs actually implementing them.
20429 * The available transitions for slideshows on the default theme are:
20430 * - @c "fade" - the current item fades out, while the new one
20431 * fades in to the slideshow's viewport.
20432 * - @c "black_fade" - the current item fades to black, and just
20433 * then, the new item will fade in.
20434 * - @c "horizontal" - the current item slides horizontally, until
20435 * it gets out of the slideshow's viewport, while the new item
20436 * comes from the left to take its place.
20437 * - @c "vertical" - the current item slides vertically, until it
20438 * gets out of the slideshow's viewport, while the new item comes
20439 * from the bottom to take its place.
20440 * - @c "square" - the new item starts to appear from the middle of
20441 * the current one, but with a tiny size, growing until its
20442 * target (full) size and covering the old one.
20444 * @warning The stringshared strings get no new references
20445 * exclusive to the user grabbing the list, here, so if you'd like
20446 * to use them out of this call's context, you'd better @c
20447 * eina_stringshare_ref() them.
20449 * @see elm_slideshow_transition_set()
20451 * @ingroup Slideshow
20453 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20456 * Set the current slide transition/effect in use for a given
20459 * @param obj The slideshow object
20460 * @param transition The new transition's name string
20462 * If @p transition is implemented in @p obj's theme (i.e., is
20463 * contained in the list returned by
20464 * elm_slideshow_transitions_get()), this new sliding effect will
20465 * be used on the widget.
20467 * @see elm_slideshow_transitions_get() for more details
20469 * @ingroup Slideshow
20471 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
20474 * Get the current slide transition/effect in use for a given
20477 * @param obj The slideshow object
20478 * @return The current transition's name
20480 * @see elm_slideshow_transition_set() for more details
20482 * @ingroup Slideshow
20484 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20487 * Set the interval between each image transition on a given
20488 * slideshow widget, <b>and start the slideshow, itself</b>
20490 * @param obj The slideshow object
20491 * @param timeout The new displaying timeout for images
20493 * After this call, the slideshow widget will start cycling its
20494 * view, sequentially and automatically, with the images of the
20495 * items it has. The time between each new image displayed is going
20496 * to be @p timeout, in @b seconds. If a different timeout was set
20497 * previously and an slideshow was in progress, it will continue
20498 * with the new time between transitions, after this call.
20500 * @note A value less than or equal to 0 on @p timeout will disable
20501 * the widget's internal timer, thus halting any slideshow which
20502 * could be happening on @p obj.
20504 * @see elm_slideshow_timeout_get()
20506 * @ingroup Slideshow
20508 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
20511 * Get the interval set for image transitions on a given slideshow
20514 * @param obj The slideshow object
20515 * @return Returns the timeout set on it
20517 * @see elm_slideshow_timeout_set() for more details
20519 * @ingroup Slideshow
20521 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20524 * Set if, after a slideshow is started, for a given slideshow
20525 * widget, its items should be displayed cyclically or not.
20527 * @param obj The slideshow object
20528 * @param loop Use @c EINA_TRUE to make it cycle through items or
20529 * @c EINA_FALSE for it to stop at the end of @p obj's internal
20532 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
20533 * ignore what is set by this functions, i.e., they'll @b always
20534 * cycle through items. This affects only the "automatic"
20535 * slideshow, as set by elm_slideshow_timeout_set().
20537 * @see elm_slideshow_loop_get()
20539 * @ingroup Slideshow
20541 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
20544 * Get if, after a slideshow is started, for a given slideshow
20545 * widget, its items are to be displayed cyclically or not.
20547 * @param obj The slideshow object
20548 * @return @c EINA_TRUE, if the items in @p obj will be cycled
20549 * through or @c EINA_FALSE, otherwise
20551 * @see elm_slideshow_loop_set() for more details
20553 * @ingroup Slideshow
20555 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20558 * Remove all items from a given slideshow widget
20560 * @param obj The slideshow object
20562 * This removes (and deletes) all items in @p obj, leaving it
20565 * @see elm_slideshow_item_del(), to remove just one item.
20567 * @ingroup Slideshow
20569 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20572 * Get the internal list of items in a given slideshow widget.
20574 * @param obj The slideshow object
20575 * @return The list of items (#Elm_Slideshow_Item as data) or
20576 * @c NULL on errors.
20578 * This list is @b not to be modified in any way and must not be
20579 * freed. Use the list members with functions like
20580 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
20582 * @warning This list is only valid until @p obj object's internal
20583 * items list is changed. It should be fetched again with another
20584 * call to this function when changes happen.
20586 * @ingroup Slideshow
20588 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20591 * Delete a given item from a slideshow widget.
20593 * @param item The slideshow item
20595 * @ingroup Slideshow
20597 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20600 * Return the data associated with a given slideshow item
20602 * @param item The slideshow item
20603 * @return Returns the data associated to this item
20605 * @ingroup Slideshow
20607 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20610 * Returns the currently displayed item, in a given slideshow widget
20612 * @param obj The slideshow object
20613 * @return A handle to the item being displayed in @p obj or
20614 * @c NULL, if none is (and on errors)
20616 * @ingroup Slideshow
20618 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20621 * Get the real Evas object created to implement the view of a
20622 * given slideshow item
20624 * @param item The slideshow item.
20625 * @return the Evas object implementing this item's view.
20627 * This returns the actual Evas object used to implement the
20628 * specified slideshow item's view. This may be @c NULL, as it may
20629 * not have been created or may have been deleted, at any time, by
20630 * the slideshow. <b>Do not modify this object</b> (move, resize,
20631 * show, hide, etc.), as the slideshow is controlling it. This
20632 * function is for querying, emitting custom signals or hooking
20633 * lower level callbacks for events on that object. Do not delete
20634 * this object under any circumstances.
20636 * @see elm_slideshow_item_data_get()
20638 * @ingroup Slideshow
20640 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
20643 * Get the the item, in a given slideshow widget, placed at
20644 * position @p nth, in its internal items list
20646 * @param obj The slideshow object
20647 * @param nth The number of the item to grab a handle to (0 being
20649 * @return The item stored in @p obj at position @p nth or @c NULL,
20650 * if there's no item with that index (and on errors)
20652 * @ingroup Slideshow
20654 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
20657 * Set the current slide layout in use for a given slideshow widget
20659 * @param obj The slideshow object
20660 * @param layout The new layout's name string
20662 * If @p layout is implemented in @p obj's theme (i.e., is contained
20663 * in the list returned by elm_slideshow_layouts_get()), this new
20664 * images layout will be used on the widget.
20666 * @see elm_slideshow_layouts_get() for more details
20668 * @ingroup Slideshow
20670 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
20673 * Get the current slide layout in use for a given slideshow widget
20675 * @param obj The slideshow object
20676 * @return The current layout's name
20678 * @see elm_slideshow_layout_set() for more details
20680 * @ingroup Slideshow
20682 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20685 * Returns the list of @b layout names available, for a given
20686 * slideshow widget.
20688 * @param obj The slideshow object
20689 * @return The list of layouts (list of @b stringshared strings
20692 * Slideshow layouts will change how the widget is to dispose each
20693 * image item in its viewport, with regard to cropping, scaling,
20696 * The layouts, which come from @p obj's theme, must be an EDC
20697 * data item name @c "layouts" on the theme file, with (prefix)
20698 * names of EDC programs actually implementing them.
20700 * The available layouts for slideshows on the default theme are:
20701 * - @c "fullscreen" - item images with original aspect, scaled to
20702 * touch top and down slideshow borders or, if the image's heigh
20703 * is not enough, left and right slideshow borders.
20704 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
20705 * one, but always leaving 10% of the slideshow's dimensions of
20706 * distance between the item image's borders and the slideshow
20707 * borders, for each axis.
20709 * @warning The stringshared strings get no new references
20710 * exclusive to the user grabbing the list, here, so if you'd like
20711 * to use them out of this call's context, you'd better @c
20712 * eina_stringshare_ref() them.
20714 * @see elm_slideshow_layout_set()
20716 * @ingroup Slideshow
20718 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20721 * Set the number of items to cache, on a given slideshow widget,
20722 * <b>before the current item</b>
20724 * @param obj The slideshow object
20725 * @param count Number of items to cache before the current one
20727 * The default value for this property is @c 2. See
20728 * @ref Slideshow_Caching "slideshow caching" for more details.
20730 * @see elm_slideshow_cache_before_get()
20732 * @ingroup Slideshow
20734 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20737 * Retrieve the number of items to cache, on a given slideshow widget,
20738 * <b>before the current item</b>
20740 * @param obj The slideshow object
20741 * @return The number of items set to be cached before the current one
20743 * @see elm_slideshow_cache_before_set() for more details
20745 * @ingroup Slideshow
20747 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20750 * Set the number of items to cache, on a given slideshow widget,
20751 * <b>after the current item</b>
20753 * @param obj The slideshow object
20754 * @param count Number of items to cache after the current one
20756 * The default value for this property is @c 2. See
20757 * @ref Slideshow_Caching "slideshow caching" for more details.
20759 * @see elm_slideshow_cache_after_get()
20761 * @ingroup Slideshow
20763 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20766 * Retrieve the number of items to cache, on a given slideshow widget,
20767 * <b>after the current item</b>
20769 * @param obj The slideshow object
20770 * @return The number of items set to be cached after the current one
20772 * @see elm_slideshow_cache_after_set() for more details
20774 * @ingroup Slideshow
20776 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20779 * Get the number of items stored in a given slideshow widget
20781 * @param obj The slideshow object
20782 * @return The number of items on @p obj, at the moment of this call
20784 * @ingroup Slideshow
20786 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20793 * @defgroup Fileselector File Selector
20795 * @image html img/widget/fileselector/preview-00.png
20796 * @image latex img/widget/fileselector/preview-00.eps
20798 * A file selector is a widget that allows a user to navigate
20799 * through a file system, reporting file selections back via its
20802 * It contains shortcut buttons for home directory (@c ~) and to
20803 * jump one directory upwards (..), as well as cancel/ok buttons to
20804 * confirm/cancel a given selection. After either one of those two
20805 * former actions, the file selector will issue its @c "done" smart
20808 * There's a text entry on it, too, showing the name of the current
20809 * selection. There's the possibility of making it editable, so it
20810 * is useful on file saving dialogs on applications, where one
20811 * gives a file name to save contents to, in a given directory in
20812 * the system. This custom file name will be reported on the @c
20813 * "done" smart callback (explained in sequence).
20815 * Finally, it has a view to display file system items into in two
20820 * If Elementary is built with support of the Ethumb thumbnailing
20821 * library, the second form of view will display preview thumbnails
20822 * of files which it supports.
20824 * Smart callbacks one can register to:
20826 * - @c "selected" - the user has clicked on a file (when not in
20827 * folders-only mode) or directory (when in folders-only mode)
20828 * - @c "directory,open" - the list has been populated with new
20829 * content (@c event_info is a pointer to the directory's
20830 * path, a @b stringshared string)
20831 * - @c "done" - the user has clicked on the "ok" or "cancel"
20832 * buttons (@c event_info is a pointer to the selection's
20833 * path, a @b stringshared string)
20835 * Here is an example on its usage:
20836 * @li @ref fileselector_example
20840 * @addtogroup Fileselector
20845 * Defines how a file selector widget is to layout its contents
20846 * (file system entries).
20848 typedef enum _Elm_Fileselector_Mode
20850 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
20851 ELM_FILESELECTOR_GRID, /**< layout as a grid */
20852 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
20853 } Elm_Fileselector_Mode;
20856 * Add a new file selector widget to the given parent Elementary
20857 * (container) object
20859 * @param parent The parent object
20860 * @return a new file selector widget handle or @c NULL, on errors
20862 * This function inserts a new file selector widget on the canvas.
20864 * @ingroup Fileselector
20866 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20869 * Enable/disable the file name entry box where the user can type
20870 * in a name for a file, in a given file selector widget
20872 * @param obj The file selector object
20873 * @param is_save @c EINA_TRUE to make the file selector a "saving
20874 * dialog", @c EINA_FALSE otherwise
20876 * Having the entry editable is useful on file saving dialogs on
20877 * applications, where one gives a file name to save contents to,
20878 * in a given directory in the system. This custom file name will
20879 * be reported on the @c "done" smart callback.
20881 * @see elm_fileselector_is_save_get()
20883 * @ingroup Fileselector
20885 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
20888 * Get whether the given file selector is in "saving dialog" mode
20890 * @param obj The file selector object
20891 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
20892 * mode, @c EINA_FALSE otherwise (and on errors)
20894 * @see elm_fileselector_is_save_set() for more details
20896 * @ingroup Fileselector
20898 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20901 * Enable/disable folder-only view for a given file selector widget
20903 * @param obj The file selector object
20904 * @param only @c EINA_TRUE to make @p obj only display
20905 * directories, @c EINA_FALSE to make files to be displayed in it
20908 * If enabled, the widget's view will only display folder items,
20911 * @see elm_fileselector_folder_only_get()
20913 * @ingroup Fileselector
20915 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
20918 * Get whether folder-only view is set for a given file selector
20921 * @param obj The file selector object
20922 * @return only @c EINA_TRUE if @p obj is only displaying
20923 * directories, @c EINA_FALSE if files are being displayed in it
20924 * too (and on errors)
20926 * @see elm_fileselector_folder_only_get()
20928 * @ingroup Fileselector
20930 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20933 * Enable/disable the "ok" and "cancel" buttons on a given file
20936 * @param obj The file selector object
20937 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
20939 * @note A file selector without those buttons will never emit the
20940 * @c "done" smart event, and is only usable if one is just hooking
20941 * to the other two events.
20943 * @see elm_fileselector_buttons_ok_cancel_get()
20945 * @ingroup Fileselector
20947 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
20950 * Get whether the "ok" and "cancel" buttons on a given file
20951 * selector widget are being shown.
20953 * @param obj The file selector object
20954 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
20955 * otherwise (and on errors)
20957 * @see elm_fileselector_buttons_ok_cancel_set() for more details
20959 * @ingroup Fileselector
20961 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20964 * Enable/disable a tree view in the given file selector widget,
20965 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
20967 * @param obj The file selector object
20968 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
20971 * In a tree view, arrows are created on the sides of directories,
20972 * allowing them to expand in place.
20974 * @note If it's in other mode, the changes made by this function
20975 * will only be visible when one switches back to "list" mode.
20977 * @see elm_fileselector_expandable_get()
20979 * @ingroup Fileselector
20981 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
20984 * Get whether tree view is enabled for the given file selector
20987 * @param obj The file selector object
20988 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
20989 * otherwise (and or errors)
20991 * @see elm_fileselector_expandable_set() for more details
20993 * @ingroup Fileselector
20995 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20998 * Set, programmatically, the @b directory that a given file
20999 * selector widget will display contents from
21001 * @param obj The file selector object
21002 * @param path The path to display in @p obj
21004 * This will change the @b directory that @p obj is displaying. It
21005 * will also clear the text entry area on the @p obj object, which
21006 * displays select files' names.
21008 * @see elm_fileselector_path_get()
21010 * @ingroup Fileselector
21012 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
21015 * Get the parent directory's path that a given file selector
21016 * widget is displaying
21018 * @param obj The file selector object
21019 * @return The (full) path of the directory the file selector is
21020 * displaying, a @b stringshared string
21022 * @see elm_fileselector_path_set()
21024 * @ingroup Fileselector
21026 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21029 * Set, programmatically, the currently selected file/directory in
21030 * the given file selector widget
21032 * @param obj The file selector object
21033 * @param path The (full) path to a file or directory
21034 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
21035 * latter case occurs if the directory or file pointed to do not
21038 * @see elm_fileselector_selected_get()
21040 * @ingroup Fileselector
21042 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
21045 * Get the currently selected item's (full) path, in the given file
21048 * @param obj The file selector object
21049 * @return The absolute path of the selected item, a @b
21050 * stringshared string
21052 * @note Custom editions on @p obj object's text entry, if made,
21053 * will appear on the return string of this function, naturally.
21055 * @see elm_fileselector_selected_set() for more details
21057 * @ingroup Fileselector
21059 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21062 * Set the mode in which a given file selector widget will display
21063 * (layout) file system entries in its view
21065 * @param obj The file selector object
21066 * @param mode The mode of the fileselector, being it one of
21067 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
21068 * first one, naturally, will display the files in a list. The
21069 * latter will make the widget to display its entries in a grid
21072 * @note By using elm_fileselector_expandable_set(), the user may
21073 * trigger a tree view for that list.
21075 * @note If Elementary is built with support of the Ethumb
21076 * thumbnailing library, the second form of view will display
21077 * preview thumbnails of files which it supports. You must have
21078 * elm_need_ethumb() called in your Elementary for thumbnailing to
21081 * @see elm_fileselector_expandable_set().
21082 * @see elm_fileselector_mode_get().
21084 * @ingroup Fileselector
21086 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
21089 * Get the mode in which a given file selector widget is displaying
21090 * (layouting) file system entries in its view
21092 * @param obj The fileselector object
21093 * @return The mode in which the fileselector is at
21095 * @see elm_fileselector_mode_set() for more details
21097 * @ingroup Fileselector
21099 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21106 * @defgroup Progressbar Progress bar
21108 * The progress bar is a widget for visually representing the
21109 * progress status of a given job/task.
21111 * A progress bar may be horizontal or vertical. It may display an
21112 * icon besides it, as well as primary and @b units labels. The
21113 * former is meant to label the widget as a whole, while the
21114 * latter, which is formatted with floating point values (and thus
21115 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
21116 * units"</c>), is meant to label the widget's <b>progress
21117 * value</b>. Label, icon and unit strings/objects are @b optional
21118 * for progress bars.
21120 * A progress bar may be @b inverted, in which state it gets its
21121 * values inverted, with high values being on the left or top and
21122 * low values on the right or bottom, as opposed to normally have
21123 * the low values on the former and high values on the latter,
21124 * respectively, for horizontal and vertical modes.
21126 * The @b span of the progress, as set by
21127 * elm_progressbar_span_size_set(), is its length (horizontally or
21128 * vertically), unless one puts size hints on the widget to expand
21129 * on desired directions, by any container. That length will be
21130 * scaled by the object or applications scaling factor. At any
21131 * point code can query the progress bar for its value with
21132 * elm_progressbar_value_get().
21134 * Available widget styles for progress bars:
21136 * - @c "wheel" (simple style, no text, no progression, only
21137 * "pulse" effect is available)
21139 * Default contents parts of the progressbar widget that you can use for are:
21140 * @li "elm.swallow.content" - A icon of the progressbar
21142 * Here is an example on its usage:
21143 * @li @ref progressbar_example
21147 * Add a new progress bar widget to the given parent Elementary
21148 * (container) object
21150 * @param parent The parent object
21151 * @return a new progress bar widget handle or @c NULL, on errors
21153 * This function inserts a new progress bar widget on the canvas.
21155 * @ingroup Progressbar
21157 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21160 * Set whether a given progress bar widget is at "pulsing mode" or
21163 * @param obj The progress bar object
21164 * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
21165 * @c EINA_FALSE to put it back to its default one
21167 * By default, progress bars will display values from the low to
21168 * high value boundaries. There are, though, contexts in which the
21169 * state of progression of a given task is @b unknown. For those,
21170 * one can set a progress bar widget to a "pulsing state", to give
21171 * the user an idea that some computation is being held, but
21172 * without exact progress values. In the default theme it will
21173 * animate its bar with the contents filling in constantly and back
21174 * to non-filled, in a loop. To start and stop this pulsing
21175 * animation, one has to explicitly call elm_progressbar_pulse().
21177 * @see elm_progressbar_pulse_get()
21178 * @see elm_progressbar_pulse()
21180 * @ingroup Progressbar
21182 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
21185 * Get whether a given progress bar widget is at "pulsing mode" or
21188 * @param obj The progress bar object
21189 * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
21190 * if it's in the default one (and on errors)
21192 * @ingroup Progressbar
21194 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21197 * Start/stop a given progress bar "pulsing" animation, if its
21200 * @param obj The progress bar object
21201 * @param state @c EINA_TRUE, to @b start the pulsing animation,
21202 * @c EINA_FALSE to @b stop it
21204 * @note This call won't do anything if @p obj is not under "pulsing mode".
21206 * @see elm_progressbar_pulse_set() for more details.
21208 * @ingroup Progressbar
21210 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
21213 * Set the progress value (in percentage) on a given progress bar
21216 * @param obj The progress bar object
21217 * @param val The progress value (@b must be between @c 0.0 and @c
21220 * Use this call to set progress bar levels.
21222 * @note If you passes a value out of the specified range for @p
21223 * val, it will be interpreted as the @b closest of the @b boundary
21224 * values in the range.
21226 * @ingroup Progressbar
21228 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21231 * Get the progress value (in percentage) on a given progress bar
21234 * @param obj The progress bar object
21235 * @return The value of the progressbar
21237 * @see elm_progressbar_value_set() for more details
21239 * @ingroup Progressbar
21241 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21244 * Set the label of a given progress bar widget
21246 * @param obj The progress bar object
21247 * @param label The text label string, in UTF-8
21249 * @ingroup Progressbar
21250 * @deprecated use elm_object_text_set() instead.
21252 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
21255 * Get the label of a given progress bar widget
21257 * @param obj The progressbar object
21258 * @return The text label string, in UTF-8
21260 * @ingroup Progressbar
21261 * @deprecated use elm_object_text_set() instead.
21263 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21266 * Set the icon object of a given progress bar widget
21268 * @param obj The progress bar object
21269 * @param icon The icon object
21271 * Use this call to decorate @p obj with an icon next to it.
21273 * @note Once the icon object is set, a previously set one will be
21274 * deleted. If you want to keep that old content object, use the
21275 * elm_progressbar_icon_unset() function.
21277 * @see elm_progressbar_icon_get()
21278 * @deprecated use elm_object_content_set() instead.
21280 * @ingroup Progressbar
21282 EINA_DEPRECATED EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
21285 * Retrieve the icon object set for a given progress bar widget
21287 * @param obj The progress bar object
21288 * @return The icon object's handle, if @p obj had one set, or @c NULL,
21289 * otherwise (and on errors)
21291 * @see elm_progressbar_icon_set() for more details
21292 * @deprecated use elm_object_content_get() instead.
21294 * @ingroup Progressbar
21296 EINA_DEPRECATED EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21299 * Unset an icon set on a given progress bar widget
21301 * @param obj The progress bar object
21302 * @return The icon object that was being used, if any was set, or
21303 * @c NULL, otherwise (and on errors)
21305 * This call will unparent and return the icon object which was set
21306 * for this widget, previously, on success.
21308 * @see elm_progressbar_icon_set() for more details
21309 * @deprecated use elm_object_content_unset() instead.
21311 * @ingroup Progressbar
21313 EINA_DEPRECATED EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
21316 * Set the (exact) length of the bar region of a given progress bar
21319 * @param obj The progress bar object
21320 * @param size The length of the progress bar's bar region
21322 * This sets the minimum width (when in horizontal mode) or height
21323 * (when in vertical mode) of the actual bar area of the progress
21324 * bar @p obj. This in turn affects the object's minimum size. Use
21325 * this when you're not setting other size hints expanding on the
21326 * given direction (like weight and alignment hints) and you would
21327 * like it to have a specific size.
21329 * @note Icon, label and unit text around @p obj will require their
21330 * own space, which will make @p obj to require more the @p size,
21333 * @see elm_progressbar_span_size_get()
21335 * @ingroup Progressbar
21337 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
21340 * Get the length set for the bar region of a given progress bar
21343 * @param obj The progress bar object
21344 * @return The length of the progress bar's bar region
21346 * If that size was not set previously, with
21347 * elm_progressbar_span_size_set(), this call will return @c 0.
21349 * @ingroup Progressbar
21351 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21354 * Set the format string for a given progress bar widget's units
21357 * @param obj The progress bar object
21358 * @param format The format string for @p obj's units label
21360 * If @c NULL is passed on @p format, it will make @p obj's units
21361 * area to be hidden completely. If not, it'll set the <b>format
21362 * string</b> for the units label's @b text. The units label is
21363 * provided a floating point value, so the units text is up display
21364 * at most one floating point falue. Note that the units label is
21365 * optional. Use a format string such as "%1.2f meters" for
21368 * @note The default format string for a progress bar is an integer
21369 * percentage, as in @c "%.0f %%".
21371 * @see elm_progressbar_unit_format_get()
21373 * @ingroup Progressbar
21375 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
21378 * Retrieve the format string set for a given progress bar widget's
21381 * @param obj The progress bar object
21382 * @return The format set string for @p obj's units label or
21383 * @c NULL, if none was set (and on errors)
21385 * @see elm_progressbar_unit_format_set() for more details
21387 * @ingroup Progressbar
21389 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21392 * Set the orientation of a given progress bar widget
21394 * @param obj The progress bar object
21395 * @param horizontal Use @c EINA_TRUE to make @p obj to be
21396 * @b horizontal, @c EINA_FALSE to make it @b vertical
21398 * Use this function to change how your progress bar is to be
21399 * disposed: vertically or horizontally.
21401 * @see elm_progressbar_horizontal_get()
21403 * @ingroup Progressbar
21405 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21408 * Retrieve the orientation of a given progress bar widget
21410 * @param obj The progress bar object
21411 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
21412 * @c EINA_FALSE if it's @b vertical (and on errors)
21414 * @see elm_progressbar_horizontal_set() for more details
21416 * @ingroup Progressbar
21418 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21421 * Invert a given progress bar widget's displaying values order
21423 * @param obj The progress bar object
21424 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
21425 * @c EINA_FALSE to bring it back to default, non-inverted values.
21427 * A progress bar may be @b inverted, in which state it gets its
21428 * values inverted, with high values being on the left or top and
21429 * low values on the right or bottom, as opposed to normally have
21430 * the low values on the former and high values on the latter,
21431 * respectively, for horizontal and vertical modes.
21433 * @see elm_progressbar_inverted_get()
21435 * @ingroup Progressbar
21437 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
21440 * Get whether a given progress bar widget's displaying values are
21443 * @param obj The progress bar object
21444 * @return @c EINA_TRUE, if @p obj has inverted values,
21445 * @c EINA_FALSE otherwise (and on errors)
21447 * @see elm_progressbar_inverted_set() for more details
21449 * @ingroup Progressbar
21451 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21454 * @defgroup Separator Separator
21456 * @brief Separator is a very thin object used to separate other objects.
21458 * A separator can be vertical or horizontal.
21460 * @ref tutorial_separator is a good example of how to use a separator.
21464 * @brief Add a separator object to @p parent
21466 * @param parent The parent object
21468 * @return The separator object, or NULL upon failure
21470 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21472 * @brief Set the horizontal mode of a separator object
21474 * @param obj The separator object
21475 * @param horizontal If true, the separator is horizontal
21477 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21479 * @brief Get the horizontal mode of a separator object
21481 * @param obj The separator object
21482 * @return If true, the separator is horizontal
21484 * @see elm_separator_horizontal_set()
21486 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21492 * @defgroup Spinner Spinner
21493 * @ingroup Elementary
21495 * @image html img/widget/spinner/preview-00.png
21496 * @image latex img/widget/spinner/preview-00.eps
21498 * A spinner is a widget which allows the user to increase or decrease
21499 * numeric values using arrow buttons, or edit values directly, clicking
21500 * over it and typing the new value.
21502 * By default the spinner will not wrap and has a label
21503 * of "%.0f" (just showing the integer value of the double).
21505 * A spinner has a label that is formatted with floating
21506 * point values and thus accepts a printf-style format string, like
21507 * ā%1.2f unitsā.
21509 * It also allows specific values to be replaced by pre-defined labels.
21511 * Smart callbacks one can register to:
21513 * - "changed" - Whenever the spinner value is changed.
21514 * - "delay,changed" - A short time after the value is changed by the user.
21515 * This will be called only when the user stops dragging for a very short
21516 * period or when they release their finger/mouse, so it avoids possibly
21517 * expensive reactions to the value change.
21519 * Available styles for it:
21521 * - @c "vertical": up/down buttons at the right side and text left aligned.
21523 * Here is an example on its usage:
21524 * @ref spinner_example
21528 * @addtogroup Spinner
21533 * Add a new spinner widget to the given parent Elementary
21534 * (container) object.
21536 * @param parent The parent object.
21537 * @return a new spinner widget handle or @c NULL, on errors.
21539 * This function inserts a new spinner widget on the canvas.
21544 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21547 * Set the format string of the displayed label.
21549 * @param obj The spinner object.
21550 * @param fmt The format string for the label display.
21552 * If @c NULL, this sets the format to "%.0f". If not it sets the format
21553 * string for the label text. The label text is provided a floating point
21554 * value, so the label text can display up to 1 floating point value.
21555 * Note that this is optional.
21557 * Use a format string such as "%1.2f meters" for example, and it will
21558 * display values like: "3.14 meters" for a value equal to 3.14159.
21560 * Default is "%0.f".
21562 * @see elm_spinner_label_format_get()
21566 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
21569 * Get the label format of the spinner.
21571 * @param obj The spinner object.
21572 * @return The text label format string in UTF-8.
21574 * @see elm_spinner_label_format_set() for details.
21578 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21581 * Set the minimum and maximum values for the spinner.
21583 * @param obj The spinner object.
21584 * @param min The minimum value.
21585 * @param max The maximum value.
21587 * Define the allowed range of values to be selected by the user.
21589 * If actual value is less than @p min, it will be updated to @p min. If it
21590 * is bigger then @p max, will be updated to @p max. Actual value can be
21591 * get with elm_spinner_value_get().
21593 * By default, min is equal to 0, and max is equal to 100.
21595 * @warning Maximum must be greater than minimum.
21597 * @see elm_spinner_min_max_get()
21601 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
21604 * Get the minimum and maximum values of the spinner.
21606 * @param obj The spinner object.
21607 * @param min Pointer where to store the minimum value.
21608 * @param max Pointer where to store the maximum value.
21610 * @note If only one value is needed, the other pointer can be passed
21613 * @see elm_spinner_min_max_set() for details.
21617 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
21620 * Set the step used to increment or decrement the spinner value.
21622 * @param obj The spinner object.
21623 * @param step The step value.
21625 * This value will be incremented or decremented to the displayed value.
21626 * It will be incremented while the user keep right or top arrow pressed,
21627 * and will be decremented while the user keep left or bottom arrow pressed.
21629 * The interval to increment / decrement can be set with
21630 * elm_spinner_interval_set().
21632 * By default step value is equal to 1.
21634 * @see elm_spinner_step_get()
21638 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
21641 * Get the step used to increment or decrement the spinner value.
21643 * @param obj The spinner object.
21644 * @return The step value.
21646 * @see elm_spinner_step_get() for more details.
21650 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21653 * Set the value the spinner displays.
21655 * @param obj The spinner object.
21656 * @param val The value to be displayed.
21658 * Value will be presented on the label following format specified with
21659 * elm_spinner_format_set().
21661 * @warning The value must to be between min and max values. This values
21662 * are set by elm_spinner_min_max_set().
21664 * @see elm_spinner_value_get().
21665 * @see elm_spinner_format_set().
21666 * @see elm_spinner_min_max_set().
21670 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21673 * Get the value displayed by the spinner.
21675 * @param obj The spinner object.
21676 * @return The value displayed.
21678 * @see elm_spinner_value_set() for details.
21682 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21685 * Set whether the spinner should wrap when it reaches its
21686 * minimum or maximum value.
21688 * @param obj The spinner object.
21689 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
21692 * Disabled by default. If disabled, when the user tries to increment the
21694 * but displayed value plus step value is bigger than maximum value,
21696 * won't allow it. The same happens when the user tries to decrement it,
21697 * but the value less step is less than minimum value.
21699 * When wrap is enabled, in such situations it will allow these changes,
21700 * but will get the value that would be less than minimum and subtracts
21701 * from maximum. Or add the value that would be more than maximum to
21705 * @li min value = 10
21706 * @li max value = 50
21707 * @li step value = 20
21708 * @li displayed value = 20
21710 * When the user decrement value (using left or bottom arrow), it will
21711 * displays @c 40, because max - (min - (displayed - step)) is
21712 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
21714 * @see elm_spinner_wrap_get().
21718 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
21721 * Get whether the spinner should wrap when it reaches its
21722 * minimum or maximum value.
21724 * @param obj The spinner object
21725 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
21726 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21728 * @see elm_spinner_wrap_set() for details.
21732 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21735 * Set whether the spinner can be directly edited by the user or not.
21737 * @param obj The spinner object.
21738 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
21739 * don't allow users to edit it directly.
21741 * Spinner objects can have edition @b disabled, in which state they will
21742 * be changed only by arrows.
21743 * Useful for contexts
21744 * where you don't want your users to interact with it writting the value.
21746 * when using special values, the user can see real value instead
21747 * of special label on edition.
21749 * It's enabled by default.
21751 * @see elm_spinner_editable_get()
21755 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
21758 * Get whether the spinner can be directly edited by the user or not.
21760 * @param obj The spinner object.
21761 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
21762 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21764 * @see elm_spinner_editable_set() for details.
21768 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21771 * Set a special string to display in the place of the numerical value.
21773 * @param obj The spinner object.
21774 * @param value The value to be replaced.
21775 * @param label The label to be used.
21777 * It's useful for cases when a user should select an item that is
21778 * better indicated by a label than a value. For example, weekdays or months.
21782 * sp = elm_spinner_add(win);
21783 * elm_spinner_min_max_set(sp, 1, 3);
21784 * elm_spinner_special_value_add(sp, 1, "January");
21785 * elm_spinner_special_value_add(sp, 2, "February");
21786 * elm_spinner_special_value_add(sp, 3, "March");
21787 * evas_object_show(sp);
21792 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
21795 * Set the interval on time updates for an user mouse button hold
21796 * on spinner widgets' arrows.
21798 * @param obj The spinner object.
21799 * @param interval The (first) interval value in seconds.
21801 * This interval value is @b decreased while the user holds the
21802 * mouse pointer either incrementing or decrementing spinner's value.
21804 * This helps the user to get to a given value distant from the
21805 * current one easier/faster, as it will start to change quicker and
21806 * quicker on mouse button holds.
21808 * The calculation for the next change interval value, starting from
21809 * the one set with this call, is the previous interval divided by
21810 * @c 1.05, so it decreases a little bit.
21812 * The default starting interval value for automatic changes is
21815 * @see elm_spinner_interval_get()
21819 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21822 * Get the interval on time updates for an user mouse button hold
21823 * on spinner widgets' arrows.
21825 * @param obj The spinner object.
21826 * @return The (first) interval value, in seconds, set on it.
21828 * @see elm_spinner_interval_set() for more details.
21832 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21839 * @defgroup Index Index
21841 * @image html img/widget/index/preview-00.png
21842 * @image latex img/widget/index/preview-00.eps
21844 * An index widget gives you an index for fast access to whichever
21845 * group of other UI items one might have. It's a list of text
21846 * items (usually letters, for alphabetically ordered access).
21848 * Index widgets are by default hidden and just appear when the
21849 * user clicks over it's reserved area in the canvas. In its
21850 * default theme, it's an area one @ref Fingers "finger" wide on
21851 * the right side of the index widget's container.
21853 * When items on the index are selected, smart callbacks get
21854 * called, so that its user can make other container objects to
21855 * show a given area or child object depending on the index item
21856 * selected. You'd probably be using an index together with @ref
21857 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
21860 * Smart events one can add callbacks for are:
21861 * - @c "changed" - When the selected index item changes. @c
21862 * event_info is the selected item's data pointer.
21863 * - @c "delay,changed" - When the selected index item changes, but
21864 * after a small idling period. @c event_info is the selected
21865 * item's data pointer.
21866 * - @c "selected" - When the user releases a mouse button and
21867 * selects an item. @c event_info is the selected item's data
21869 * - @c "level,up" - when the user moves a finger from the first
21870 * level to the second level
21871 * - @c "level,down" - when the user moves a finger from the second
21872 * level to the first level
21874 * The @c "delay,changed" event is so that it'll wait a small time
21875 * before actually reporting those events and, moreover, just the
21876 * last event happening on those time frames will actually be
21879 * Here are some examples on its usage:
21880 * @li @ref index_example_01
21881 * @li @ref index_example_02
21885 * @addtogroup Index
21889 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
21892 * Add a new index widget to the given parent Elementary
21893 * (container) object
21895 * @param parent The parent object
21896 * @return a new index widget handle or @c NULL, on errors
21898 * This function inserts a new index widget on the canvas.
21902 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21905 * Set whether a given index widget is or not visible,
21908 * @param obj The index object
21909 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
21911 * Not to be confused with visible as in @c evas_object_show() --
21912 * visible with regard to the widget's auto hiding feature.
21914 * @see elm_index_active_get()
21918 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
21921 * Get whether a given index widget is currently visible or not.
21923 * @param obj The index object
21924 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
21926 * @see elm_index_active_set() for more details
21930 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21933 * Set the items level for a given index widget.
21935 * @param obj The index object.
21936 * @param level @c 0 or @c 1, the currently implemented levels.
21938 * @see elm_index_item_level_get()
21942 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21945 * Get the items level set for a given index widget.
21947 * @param obj The index object.
21948 * @return @c 0 or @c 1, which are the levels @p obj might be at.
21950 * @see elm_index_item_level_set() for more information
21954 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21957 * Returns the last selected item's data, for a given index widget.
21959 * @param obj The index object.
21960 * @return The item @b data associated to the last selected item on
21961 * @p obj (or @c NULL, on errors).
21963 * @warning The returned value is @b not an #Elm_Index_Item item
21964 * handle, but the data associated to it (see the @c item parameter
21965 * in elm_index_item_append(), as an example).
21969 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21972 * Append a new item on a given index widget.
21974 * @param obj The index object.
21975 * @param letter Letter under which the item should be indexed
21976 * @param item The item data to set for the index's item
21978 * Despite the most common usage of the @p letter argument is for
21979 * single char strings, one could use arbitrary strings as index
21982 * @c item will be the pointer returned back on @c "changed", @c
21983 * "delay,changed" and @c "selected" smart events.
21987 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21990 * Prepend a new item on a given index widget.
21992 * @param obj The index object.
21993 * @param letter Letter under which the item should be indexed
21994 * @param item The item data to set for the index's item
21996 * Despite the most common usage of the @p letter argument is for
21997 * single char strings, one could use arbitrary strings as index
22000 * @c item will be the pointer returned back on @c "changed", @c
22001 * "delay,changed" and @c "selected" smart events.
22005 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
22008 * Append a new item, on a given index widget, <b>after the item
22009 * having @p relative as data</b>.
22011 * @param obj The index object.
22012 * @param letter Letter under which the item should be indexed
22013 * @param item The item data to set for the index's item
22014 * @param relative The item data of the index item to be the
22015 * predecessor of this new one
22017 * Despite the most common usage of the @p letter argument is for
22018 * single char strings, one could use arbitrary strings as index
22021 * @c item will be the pointer returned back on @c "changed", @c
22022 * "delay,changed" and @c "selected" smart events.
22024 * @note If @p relative is @c NULL or if it's not found to be data
22025 * set on any previous item on @p obj, this function will behave as
22026 * elm_index_item_append().
22030 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
22033 * Prepend a new item, on a given index widget, <b>after the item
22034 * having @p relative as data</b>.
22036 * @param obj The index object.
22037 * @param letter Letter under which the item should be indexed
22038 * @param item The item data to set for the index's item
22039 * @param relative The item data of the index item to be the
22040 * successor of this new one
22042 * Despite the most common usage of the @p letter argument is for
22043 * single char strings, one could use arbitrary strings as index
22046 * @c item will be the pointer returned back on @c "changed", @c
22047 * "delay,changed" and @c "selected" smart events.
22049 * @note If @p relative is @c NULL or if it's not found to be data
22050 * set on any previous item on @p obj, this function will behave as
22051 * elm_index_item_prepend().
22055 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
22058 * Insert a new item into the given index widget, using @p cmp_func
22059 * function to sort items (by item handles).
22061 * @param obj The index object.
22062 * @param letter Letter under which the item should be indexed
22063 * @param item The item data to set for the index's item
22064 * @param cmp_func The comparing function to be used to sort index
22065 * items <b>by #Elm_Index_Item item handles</b>
22066 * @param cmp_data_func A @b fallback function to be called for the
22067 * sorting of index items <b>by item data</b>). It will be used
22068 * when @p cmp_func returns @c 0 (equality), which means an index
22069 * item with provided item data already exists. To decide which
22070 * data item should be pointed to by the index item in question, @p
22071 * cmp_data_func will be used. If @p cmp_data_func returns a
22072 * non-negative value, the previous index item data will be
22073 * replaced by the given @p item pointer. If the previous data need
22074 * to be freed, it should be done by the @p cmp_data_func function,
22075 * because all references to it will be lost. If this function is
22076 * not provided (@c NULL is given), index items will be @b
22077 * duplicated, if @p cmp_func returns @c 0.
22079 * Despite the most common usage of the @p letter argument is for
22080 * single char strings, one could use arbitrary strings as index
22083 * @c item will be the pointer returned back on @c "changed", @c
22084 * "delay,changed" and @c "selected" smart events.
22088 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);
22091 * Remove an item from a given index widget, <b>to be referenced by
22092 * it's data value</b>.
22094 * @param obj The index object
22095 * @param item The item's data pointer for the item to be removed
22098 * If a deletion callback is set, via elm_index_item_del_cb_set(),
22099 * that callback function will be called by this one.
22101 * @warning The item to be removed from @p obj will be found via
22102 * its item data pointer, and not by an #Elm_Index_Item handle.
22106 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22109 * Find a given index widget's item, <b>using item data</b>.
22111 * @param obj The index object
22112 * @param item The item data pointed to by the desired index item
22113 * @return The index item handle, if found, or @c NULL otherwise
22117 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22120 * Removes @b all items from a given index widget.
22122 * @param obj The index object.
22124 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
22125 * that callback function will be called for each item in @p obj.
22129 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22132 * Go to a given items level on a index widget
22134 * @param obj The index object
22135 * @param level The index level (one of @c 0 or @c 1)
22139 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22142 * Return the data associated with a given index widget item
22144 * @param it The index widget item handle
22145 * @return The data associated with @p it
22147 * @see elm_index_item_data_set()
22151 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22154 * Set the data associated with a given index widget item
22156 * @param it The index widget item handle
22157 * @param data The new data pointer to set to @p it
22159 * This sets new item data on @p it.
22161 * @warning The old data pointer won't be touched by this function, so
22162 * the user had better to free that old data himself/herself.
22166 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
22169 * Set the function to be called when a given index widget item is freed.
22171 * @param it The item to set the callback on
22172 * @param func The function to call on the item's deletion
22174 * When called, @p func will have both @c data and @c event_info
22175 * arguments with the @p it item's data value and, naturally, the
22176 * @c obj argument with a handle to the parent index widget.
22180 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
22183 * Get the letter (string) set on a given index widget item.
22185 * @param it The index item handle
22186 * @return The letter string set on @p it
22190 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22197 * @defgroup Photocam Photocam
22199 * @image html img/widget/photocam/preview-00.png
22200 * @image latex img/widget/photocam/preview-00.eps
22202 * This is a widget specifically for displaying high-resolution digital
22203 * camera photos giving speedy feedback (fast load), low memory footprint
22204 * and zooming and panning as well as fitting logic. It is entirely focused
22205 * on jpeg images, and takes advantage of properties of the jpeg format (via
22206 * evas loader features in the jpeg loader).
22208 * Signals that you can add callbacks for are:
22209 * @li "clicked" - This is called when a user has clicked the photo without
22211 * @li "press" - This is called when a user has pressed down on the photo.
22212 * @li "longpressed" - This is called when a user has pressed down on the
22213 * photo for a long time without dragging around.
22214 * @li "clicked,double" - This is called when a user has double-clicked the
22216 * @li "load" - Photo load begins.
22217 * @li "loaded" - This is called when the image file load is complete for the
22218 * first view (low resolution blurry version).
22219 * @li "load,detail" - Photo detailed data load begins.
22220 * @li "loaded,detail" - This is called when the image file load is complete
22221 * for the detailed image data (full resolution needed).
22222 * @li "zoom,start" - Zoom animation started.
22223 * @li "zoom,stop" - Zoom animation stopped.
22224 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
22225 * @li "scroll" - the content has been scrolled (moved)
22226 * @li "scroll,anim,start" - scrolling animation has started
22227 * @li "scroll,anim,stop" - scrolling animation has stopped
22228 * @li "scroll,drag,start" - dragging the contents around has started
22229 * @li "scroll,drag,stop" - dragging the contents around has stopped
22231 * @ref tutorial_photocam shows the API in action.
22235 * @brief Types of zoom available.
22237 typedef enum _Elm_Photocam_Zoom_Mode
22239 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
22240 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
22241 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
22242 ELM_PHOTOCAM_ZOOM_MODE_LAST
22243 } Elm_Photocam_Zoom_Mode;
22245 * @brief Add a new Photocam object
22247 * @param parent The parent object
22248 * @return The new object or NULL if it cannot be created
22250 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22252 * @brief Set the photo file to be shown
22254 * @param obj The photocam object
22255 * @param file The photo file
22256 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
22258 * This sets (and shows) the specified file (with a relative or absolute
22259 * path) and will return a load error (same error that
22260 * evas_object_image_load_error_get() will return). The image will change and
22261 * adjust its size at this point and begin a background load process for this
22262 * photo that at some time in the future will be displayed at the full
22265 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
22267 * @brief Returns the path of the current image file
22269 * @param obj The photocam object
22270 * @return Returns the path
22272 * @see elm_photocam_file_set()
22274 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22276 * @brief Set the zoom level of the photo
22278 * @param obj The photocam object
22279 * @param zoom The zoom level to set
22281 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
22282 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
22283 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
22284 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
22287 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
22289 * @brief Get the zoom level of the photo
22291 * @param obj The photocam object
22292 * @return The current zoom level
22294 * This returns the current zoom level of the photocam object. Note that if
22295 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
22296 * (which is the default), the zoom level may be changed at any time by the
22297 * photocam object itself to account for photo size and photocam viewpoer
22300 * @see elm_photocam_zoom_set()
22301 * @see elm_photocam_zoom_mode_set()
22303 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22305 * @brief Set the zoom mode
22307 * @param obj The photocam object
22308 * @param mode The desired mode
22310 * This sets the zoom mode to manual or one of several automatic levels.
22311 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
22312 * elm_photocam_zoom_set() and will stay at that level until changed by code
22313 * or until zoom mode is changed. This is the default mode. The Automatic
22314 * modes will allow the photocam object to automatically adjust zoom mode
22315 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
22316 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
22317 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
22318 * pixels within the frame are left unfilled.
22320 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22322 * @brief Get the zoom mode
22324 * @param obj The photocam object
22325 * @return The current zoom mode
22327 * This gets the current zoom mode of the photocam object.
22329 * @see elm_photocam_zoom_mode_set()
22331 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22333 * @brief Get the current image pixel width and height
22335 * @param obj The photocam object
22336 * @param w A pointer to the width return
22337 * @param h A pointer to the height return
22339 * This gets the current photo pixel width and height (for the original).
22340 * The size will be returned in the integers @p w and @p h that are pointed
22343 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
22345 * @brief Get the area of the image that is currently shown
22348 * @param x A pointer to the X-coordinate of region
22349 * @param y A pointer to the Y-coordinate of region
22350 * @param w A pointer to the width
22351 * @param h A pointer to the height
22353 * @see elm_photocam_image_region_show()
22354 * @see elm_photocam_image_region_bring_in()
22356 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
22358 * @brief Set the viewed portion of the image
22360 * @param obj The photocam object
22361 * @param x X-coordinate of region in image original pixels
22362 * @param y Y-coordinate of region in image original pixels
22363 * @param w Width of region in image original pixels
22364 * @param h Height of region in image original pixels
22366 * This shows the region of the image without using animation.
22368 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22370 * @brief Bring in the viewed portion of the image
22372 * @param obj The photocam object
22373 * @param x X-coordinate of region in image original pixels
22374 * @param y Y-coordinate of region in image original pixels
22375 * @param w Width of region in image original pixels
22376 * @param h Height of region in image original pixels
22378 * This shows the region of the image using animation.
22380 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22382 * @brief Set the paused state for photocam
22384 * @param obj The photocam object
22385 * @param paused The pause state to set
22387 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
22388 * photocam. The default is off. This will stop zooming using animation on
22389 * zoom levels changes and change instantly. This will stop any existing
22390 * animations that are running.
22392 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22394 * @brief Get the paused state for photocam
22396 * @param obj The photocam object
22397 * @return The current paused state
22399 * This gets the current paused state for the photocam object.
22401 * @see elm_photocam_paused_set()
22403 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22405 * @brief Get the internal low-res image used for photocam
22407 * @param obj The photocam object
22408 * @return The internal image object handle, or NULL if none exists
22410 * This gets the internal image object inside photocam. Do not modify it. It
22411 * is for inspection only, and hooking callbacks to. Nothing else. It may be
22412 * deleted at any time as well.
22414 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22416 * @brief Set the photocam scrolling bouncing.
22418 * @param obj The photocam object
22419 * @param h_bounce bouncing for horizontal
22420 * @param v_bounce bouncing for vertical
22422 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22424 * @brief Get the photocam scrolling bouncing.
22426 * @param obj The photocam object
22427 * @param h_bounce bouncing for horizontal
22428 * @param v_bounce bouncing for vertical
22430 * @see elm_photocam_bounce_set()
22432 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
22438 * @defgroup Map Map
22439 * @ingroup Elementary
22441 * @image html img/widget/map/preview-00.png
22442 * @image latex img/widget/map/preview-00.eps
22444 * This is a widget specifically for displaying a map. It uses basically
22445 * OpenStreetMap provider http://www.openstreetmap.org/,
22446 * but custom providers can be added.
22448 * It supports some basic but yet nice features:
22449 * @li zoom and scroll
22450 * @li markers with content to be displayed when user clicks over it
22451 * @li group of markers
22454 * Smart callbacks one can listen to:
22456 * - "clicked" - This is called when a user has clicked the map without
22458 * - "press" - This is called when a user has pressed down on the map.
22459 * - "longpressed" - This is called when a user has pressed down on the map
22460 * for a long time without dragging around.
22461 * - "clicked,double" - This is called when a user has double-clicked
22463 * - "load,detail" - Map detailed data load begins.
22464 * - "loaded,detail" - This is called when all currently visible parts of
22465 * the map are loaded.
22466 * - "zoom,start" - Zoom animation started.
22467 * - "zoom,stop" - Zoom animation stopped.
22468 * - "zoom,change" - Zoom changed when using an auto zoom mode.
22469 * - "scroll" - the content has been scrolled (moved).
22470 * - "scroll,anim,start" - scrolling animation has started.
22471 * - "scroll,anim,stop" - scrolling animation has stopped.
22472 * - "scroll,drag,start" - dragging the contents around has started.
22473 * - "scroll,drag,stop" - dragging the contents around has stopped.
22474 * - "downloaded" - This is called when all currently required map images
22476 * - "route,load" - This is called when route request begins.
22477 * - "route,loaded" - This is called when route request ends.
22478 * - "name,load" - This is called when name request begins.
22479 * - "name,loaded- This is called when name request ends.
22481 * Available style for map widget:
22484 * Available style for markers:
22489 * Available style for marker bubble:
22492 * List of examples:
22493 * @li @ref map_example_01
22494 * @li @ref map_example_02
22495 * @li @ref map_example_03
22504 * @enum _Elm_Map_Zoom_Mode
22505 * @typedef Elm_Map_Zoom_Mode
22507 * Set map's zoom behavior. It can be set to manual or automatic.
22509 * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
22511 * Values <b> don't </b> work as bitmask, only one can be choosen.
22513 * @note Valid sizes are 2^zoom, consequently the map may be smaller
22514 * than the scroller view.
22516 * @see elm_map_zoom_mode_set()
22517 * @see elm_map_zoom_mode_get()
22521 typedef enum _Elm_Map_Zoom_Mode
22523 ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
22524 ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
22525 ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
22526 ELM_MAP_ZOOM_MODE_LAST
22527 } Elm_Map_Zoom_Mode;
22530 * @enum _Elm_Map_Route_Sources
22531 * @typedef Elm_Map_Route_Sources
22533 * Set route service to be used. By default used source is
22534 * #ELM_MAP_ROUTE_SOURCE_YOURS.
22536 * @see elm_map_route_source_set()
22537 * @see elm_map_route_source_get()
22541 typedef enum _Elm_Map_Route_Sources
22543 ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
22544 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. */
22545 ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
22546 ELM_MAP_ROUTE_SOURCE_LAST
22547 } Elm_Map_Route_Sources;
22549 typedef enum _Elm_Map_Name_Sources
22551 ELM_MAP_NAME_SOURCE_NOMINATIM,
22552 ELM_MAP_NAME_SOURCE_LAST
22553 } Elm_Map_Name_Sources;
22556 * @enum _Elm_Map_Route_Type
22557 * @typedef Elm_Map_Route_Type
22559 * Set type of transport used on route.
22561 * @see elm_map_route_add()
22565 typedef enum _Elm_Map_Route_Type
22567 ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
22568 ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
22569 ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
22570 ELM_MAP_ROUTE_TYPE_LAST
22571 } Elm_Map_Route_Type;
22574 * @enum _Elm_Map_Route_Method
22575 * @typedef Elm_Map_Route_Method
22577 * Set the routing method, what should be priorized, time or distance.
22579 * @see elm_map_route_add()
22583 typedef enum _Elm_Map_Route_Method
22585 ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
22586 ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
22587 ELM_MAP_ROUTE_METHOD_LAST
22588 } Elm_Map_Route_Method;
22590 typedef enum _Elm_Map_Name_Method
22592 ELM_MAP_NAME_METHOD_SEARCH,
22593 ELM_MAP_NAME_METHOD_REVERSE,
22594 ELM_MAP_NAME_METHOD_LAST
22595 } Elm_Map_Name_Method;
22597 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(). */
22598 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(). */
22599 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(). */
22600 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(). */
22601 typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
22602 typedef struct _Elm_Map_Track Elm_Map_Track;
22604 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. */
22605 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
22606 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
22607 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
22609 typedef char *(*ElmMapModuleSourceFunc) (void);
22610 typedef int (*ElmMapModuleZoomMinFunc) (void);
22611 typedef int (*ElmMapModuleZoomMaxFunc) (void);
22612 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
22613 typedef int (*ElmMapModuleRouteSourceFunc) (void);
22614 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
22615 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
22616 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
22617 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
22620 * Add a new map widget to the given parent Elementary (container) object.
22622 * @param parent The parent object.
22623 * @return a new map widget handle or @c NULL, on errors.
22625 * This function inserts a new map widget on the canvas.
22629 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22632 * Set the zoom level of the map.
22634 * @param obj The map object.
22635 * @param zoom The zoom level to set.
22637 * This sets the zoom level.
22639 * It will respect limits defined by elm_map_source_zoom_min_set() and
22640 * elm_map_source_zoom_max_set().
22642 * By default these values are 0 (world map) and 18 (maximum zoom).
22644 * This function should be used when zoom mode is set to
22645 * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
22646 * with elm_map_zoom_mode_set().
22648 * @see elm_map_zoom_mode_set().
22649 * @see elm_map_zoom_get().
22653 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22656 * Get the zoom level of the map.
22658 * @param obj The map object.
22659 * @return The current zoom level.
22661 * This returns the current zoom level of the map object.
22663 * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
22664 * (which is the default), the zoom level may be changed at any time by the
22665 * map object itself to account for map size and map viewport size.
22667 * @see elm_map_zoom_set() for details.
22671 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22674 * Set the zoom mode used by the map object.
22676 * @param obj The map object.
22677 * @param mode The zoom mode of the map, being it one of
22678 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22679 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22681 * This sets the zoom mode to manual or one of the automatic levels.
22682 * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
22683 * elm_map_zoom_set() and will stay at that level until changed by code
22684 * or until zoom mode is changed. This is the default mode.
22686 * The Automatic modes will allow the map object to automatically
22687 * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
22688 * adjust zoom so the map fits inside the scroll frame with no pixels
22689 * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
22690 * ensure no pixels within the frame are left unfilled. Do not forget that
22691 * the valid sizes are 2^zoom, consequently the map may be smaller than
22692 * the scroller view.
22694 * @see elm_map_zoom_set()
22698 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22701 * Get the zoom mode used by the map object.
22703 * @param obj The map object.
22704 * @return The zoom mode of the map, being it one of
22705 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22706 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22708 * This function returns the current zoom mode used by the map object.
22710 * @see elm_map_zoom_mode_set() for more details.
22714 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22717 * Get the current coordinates of the map.
22719 * @param obj The map object.
22720 * @param lon Pointer where to store longitude.
22721 * @param lat Pointer where to store latitude.
22723 * This gets the current center coordinates of the map object. It can be
22724 * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
22726 * @see elm_map_geo_region_bring_in()
22727 * @see elm_map_geo_region_show()
22731 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
22734 * Animatedly bring in given coordinates to the center of the map.
22736 * @param obj The map object.
22737 * @param lon Longitude to center at.
22738 * @param lat Latitude to center at.
22740 * This causes map to jump to the given @p lat and @p lon coordinates
22741 * and show it (by scrolling) in the center of the viewport, if it is not
22742 * already centered. This will use animation to do so and take a period
22743 * of time to complete.
22745 * @see elm_map_geo_region_show() for a function to avoid animation.
22746 * @see elm_map_geo_region_get()
22750 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22753 * Show the given coordinates at the center of the map, @b immediately.
22755 * @param obj The map object.
22756 * @param lon Longitude to center at.
22757 * @param lat Latitude to center at.
22759 * This causes map to @b redraw its viewport's contents to the
22760 * region contining the given @p lat and @p lon, that will be moved to the
22761 * center of the map.
22763 * @see elm_map_geo_region_bring_in() for a function to move with animation.
22764 * @see elm_map_geo_region_get()
22768 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22771 * Pause or unpause the map.
22773 * @param obj The map object.
22774 * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
22777 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22780 * The default is off.
22782 * This will stop zooming using animation, changing zoom levels will
22783 * change instantly. This will stop any existing animations that are running.
22785 * @see elm_map_paused_get()
22789 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22792 * Get a value whether map is paused or not.
22794 * @param obj The map object.
22795 * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
22796 * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
22798 * This gets the current paused state for the map object.
22800 * @see elm_map_paused_set() for details.
22804 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22807 * Set to show markers during zoom level changes or not.
22809 * @param obj The map object.
22810 * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
22813 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22816 * The default is off.
22818 * This will stop zooming using animation, changing zoom levels will
22819 * change instantly. This will stop any existing animations that are running.
22821 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22824 * The default is off.
22826 * Enabling it will force the map to stop displaying the markers during
22827 * zoom level changes. Set to on if you have a large number of markers.
22829 * @see elm_map_paused_markers_get()
22833 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22836 * Get a value whether markers will be displayed on zoom level changes or not
22838 * @param obj The map object.
22839 * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
22840 * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
22842 * This gets the current markers paused state for the map object.
22844 * @see elm_map_paused_markers_set() for details.
22848 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22851 * Get the information of downloading status.
22853 * @param obj The map object.
22854 * @param try_num Pointer where to store number of tiles being downloaded.
22855 * @param finish_num Pointer where to store number of tiles successfully
22858 * This gets the current downloading status for the map object, the number
22859 * of tiles being downloaded and the number of tiles already downloaded.
22863 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
22866 * Convert a pixel coordinate (x,y) into a geographic coordinate
22867 * (longitude, latitude).
22869 * @param obj The map object.
22870 * @param x the coordinate.
22871 * @param y the coordinate.
22872 * @param size the size in pixels of the map.
22873 * The map is a square and generally his size is : pow(2.0, zoom)*256.
22874 * @param lon Pointer where to store the longitude that correspond to x.
22875 * @param lat Pointer where to store the latitude that correspond to y.
22877 * @note Origin pixel point is the top left corner of the viewport.
22878 * Map zoom and size are taken on account.
22880 * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
22884 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);
22887 * Convert a geographic coordinate (longitude, latitude) into a pixel
22888 * coordinate (x, y).
22890 * @param obj The map object.
22891 * @param lon the longitude.
22892 * @param lat the latitude.
22893 * @param size the size in pixels of the map. The map is a square
22894 * and generally his size is : pow(2.0, zoom)*256.
22895 * @param x Pointer where to store the horizontal pixel coordinate that
22896 * correspond to the longitude.
22897 * @param y Pointer where to store the vertical pixel coordinate that
22898 * correspond to the latitude.
22900 * @note Origin pixel point is the top left corner of the viewport.
22901 * Map zoom and size are taken on account.
22903 * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
22907 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);
22910 * Convert a geographic coordinate (longitude, latitude) into a name
22913 * @param obj The map object.
22914 * @param lon the longitude.
22915 * @param lat the latitude.
22916 * @return name A #Elm_Map_Name handle for this coordinate.
22918 * To get the string for this address, elm_map_name_address_get()
22921 * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
22925 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22928 * Convert a name (address) into a geographic coordinate
22929 * (longitude, latitude).
22931 * @param obj The map object.
22932 * @param name The address.
22933 * @return name A #Elm_Map_Name handle for this address.
22935 * To get the longitude and latitude, elm_map_name_region_get()
22938 * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
22942 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
22945 * Convert a pixel coordinate into a rotated pixel coordinate.
22947 * @param obj The map object.
22948 * @param x horizontal coordinate of the point to rotate.
22949 * @param y vertical coordinate of the point to rotate.
22950 * @param cx rotation's center horizontal position.
22951 * @param cy rotation's center vertical position.
22952 * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
22953 * @param xx Pointer where to store rotated x.
22954 * @param yy Pointer where to store rotated y.
22958 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);
22961 * Add a new marker to the map object.
22963 * @param obj The map object.
22964 * @param lon The longitude of the marker.
22965 * @param lat The latitude of the marker.
22966 * @param clas The class, to use when marker @b isn't grouped to others.
22967 * @param clas_group The class group, to use when marker is grouped to others
22968 * @param data The data passed to the callbacks.
22970 * @return The created marker or @c NULL upon failure.
22972 * A marker will be created and shown in a specific point of the map, defined
22973 * by @p lon and @p lat.
22975 * It will be displayed using style defined by @p class when this marker
22976 * is displayed alone (not grouped). A new class can be created with
22977 * elm_map_marker_class_new().
22979 * If the marker is grouped to other markers, it will be displayed with
22980 * style defined by @p class_group. Markers with the same group are grouped
22981 * if they are close. A new group class can be created with
22982 * elm_map_marker_group_class_new().
22984 * Markers created with this method can be deleted with
22985 * elm_map_marker_remove().
22987 * A marker can have associated content to be displayed by a bubble,
22988 * when a user click over it, as well as an icon. These objects will
22989 * be fetch using class' callback functions.
22991 * @see elm_map_marker_class_new()
22992 * @see elm_map_marker_group_class_new()
22993 * @see elm_map_marker_remove()
22997 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);
23000 * Set the maximum numbers of markers' content to be displayed in a group.
23002 * @param obj The map object.
23003 * @param max The maximum numbers of items displayed in a bubble.
23005 * A bubble will be displayed when the user clicks over the group,
23006 * and will place the content of markers that belong to this group
23009 * A group can have a long list of markers, consequently the creation
23010 * of the content of the bubble can be very slow.
23012 * In order to avoid this, a maximum number of items is displayed
23015 * By default this number is 30.
23017 * Marker with the same group class are grouped if they are close.
23019 * @see elm_map_marker_add()
23023 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
23026 * Remove a marker from the map.
23028 * @param marker The marker to remove.
23030 * @see elm_map_marker_add()
23034 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23037 * Get the current coordinates of the marker.
23039 * @param marker marker.
23040 * @param lat Pointer where to store the marker's latitude.
23041 * @param lon Pointer where to store the marker's longitude.
23043 * These values are set when adding markers, with function
23044 * elm_map_marker_add().
23046 * @see elm_map_marker_add()
23050 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
23053 * Animatedly bring in given marker to the center of the map.
23055 * @param marker The marker to center at.
23057 * This causes map to jump to the given @p marker's coordinates
23058 * and show it (by scrolling) in the center of the viewport, if it is not
23059 * already centered. This will use animation to do so and take a period
23060 * of time to complete.
23062 * @see elm_map_marker_show() for a function to avoid animation.
23063 * @see elm_map_marker_region_get()
23067 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23070 * Show the given marker at the center of the map, @b immediately.
23072 * @param marker The marker to center at.
23074 * This causes map to @b redraw its viewport's contents to the
23075 * region contining the given @p marker's coordinates, that will be
23076 * moved to the center of the map.
23078 * @see elm_map_marker_bring_in() for a function to move with animation.
23079 * @see elm_map_markers_list_show() if more than one marker need to be
23081 * @see elm_map_marker_region_get()
23085 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23088 * Move and zoom the map to display a list of markers.
23090 * @param markers A list of #Elm_Map_Marker handles.
23092 * The map will be centered on the center point of the markers in the list.
23093 * Then the map will be zoomed in order to fit the markers using the maximum
23094 * zoom which allows display of all the markers.
23096 * @warning All the markers should belong to the same map object.
23098 * @see elm_map_marker_show() to show a single marker.
23099 * @see elm_map_marker_bring_in()
23103 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
23106 * Get the Evas object returned by the ElmMapMarkerGetFunc callback
23108 * @param marker The marker wich content should be returned.
23109 * @return Return the evas object if it exists, else @c NULL.
23111 * To set callback function #ElmMapMarkerGetFunc for the marker class,
23112 * elm_map_marker_class_get_cb_set() should be used.
23114 * This content is what will be inside the bubble that will be displayed
23115 * when an user clicks over the marker.
23117 * This returns the actual Evas object used to be placed inside
23118 * the bubble. This may be @c NULL, as it may
23119 * not have been created or may have been deleted, at any time, by
23120 * the map. <b>Do not modify this object</b> (move, resize,
23121 * show, hide, etc.), as the map is controlling it. This
23122 * function is for querying, emitting custom signals or hooking
23123 * lower level callbacks for events on that object. Do not delete
23124 * this object under any circumstances.
23128 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23131 * Update the marker
23133 * @param marker The marker to be updated.
23135 * If a content is set to this marker, it will call function to delete it,
23136 * #ElmMapMarkerDelFunc, and then will fetch the content again with
23137 * #ElmMapMarkerGetFunc.
23139 * These functions are set for the marker class with
23140 * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
23144 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23147 * Close all the bubbles opened by the user.
23149 * @param obj The map object.
23151 * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
23152 * when the user clicks on a marker.
23154 * This functions is set for the marker class with
23155 * elm_map_marker_class_get_cb_set().
23159 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
23162 * Create a new group class.
23164 * @param obj The map object.
23165 * @return Returns the new group class.
23167 * Each marker must be associated to a group class. Markers in the same
23168 * group are grouped if they are close.
23170 * The group class defines the style of the marker when a marker is grouped
23171 * to others markers. When it is alone, another class will be used.
23173 * A group class will need to be provided when creating a marker with
23174 * elm_map_marker_add().
23176 * Some properties and functions can be set by class, as:
23177 * - style, with elm_map_group_class_style_set()
23178 * - data - to be associated to the group class. It can be set using
23179 * elm_map_group_class_data_set().
23180 * - min zoom to display markers, set with
23181 * elm_map_group_class_zoom_displayed_set().
23182 * - max zoom to group markers, set using
23183 * elm_map_group_class_zoom_grouped_set().
23184 * - visibility - set if markers will be visible or not, set with
23185 * elm_map_group_class_hide_set().
23186 * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
23187 * It can be set using elm_map_group_class_icon_cb_set().
23189 * @see elm_map_marker_add()
23190 * @see elm_map_group_class_style_set()
23191 * @see elm_map_group_class_data_set()
23192 * @see elm_map_group_class_zoom_displayed_set()
23193 * @see elm_map_group_class_zoom_grouped_set()
23194 * @see elm_map_group_class_hide_set()
23195 * @see elm_map_group_class_icon_cb_set()
23199 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23202 * Set the marker's style of a group class.
23204 * @param clas The group class.
23205 * @param style The style to be used by markers.
23207 * Each marker must be associated to a group class, and will use the style
23208 * defined by such class when grouped to other markers.
23210 * The following styles are provided by default theme:
23211 * @li @c radio - blue circle
23212 * @li @c radio2 - green circle
23215 * @see elm_map_group_class_new() for more details.
23216 * @see elm_map_marker_add()
23220 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23223 * Set the icon callback function of a group class.
23225 * @param clas The group class.
23226 * @param icon_get The callback function that will return the icon.
23228 * Each marker must be associated to a group class, and it can display a
23229 * custom icon. The function @p icon_get must return this icon.
23231 * @see elm_map_group_class_new() for more details.
23232 * @see elm_map_marker_add()
23236 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23239 * Set the data associated to the group class.
23241 * @param clas The group class.
23242 * @param data The new user data.
23244 * This data will be passed for callback functions, like icon get callback,
23245 * that can be set with elm_map_group_class_icon_cb_set().
23247 * If a data was previously set, the object will lose the pointer for it,
23248 * so if needs to be freed, you must do it yourself.
23250 * @see elm_map_group_class_new() for more details.
23251 * @see elm_map_group_class_icon_cb_set()
23252 * @see elm_map_marker_add()
23256 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
23259 * Set the minimum zoom from where the markers are displayed.
23261 * @param clas The group class.
23262 * @param zoom The minimum zoom.
23264 * Markers only will be displayed when the map is displayed at @p zoom
23267 * @see elm_map_group_class_new() for more details.
23268 * @see elm_map_marker_add()
23272 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23275 * Set the zoom from where the markers are no more grouped.
23277 * @param clas The group class.
23278 * @param zoom The maximum zoom.
23280 * Markers only will be grouped when the map is displayed at
23281 * less than @p zoom.
23283 * @see elm_map_group_class_new() for more details.
23284 * @see elm_map_marker_add()
23288 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23291 * Set if the markers associated to the group class @clas are hidden or not.
23293 * @param clas The group class.
23294 * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
23297 * If @p hide is @c EINA_TRUE the markers will be hidden, but default
23302 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
23305 * Create a new marker class.
23307 * @param obj The map object.
23308 * @return Returns the new group class.
23310 * Each marker must be associated to a class.
23312 * The marker class defines the style of the marker when a marker is
23313 * displayed alone, i.e., not grouped to to others markers. When grouped
23314 * it will use group class style.
23316 * A marker class will need to be provided when creating a marker with
23317 * elm_map_marker_add().
23319 * Some properties and functions can be set by class, as:
23320 * - style, with elm_map_marker_class_style_set()
23321 * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
23322 * It can be set using elm_map_marker_class_icon_cb_set().
23323 * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
23324 * Set using elm_map_marker_class_get_cb_set().
23325 * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
23326 * Set using elm_map_marker_class_del_cb_set().
23328 * @see elm_map_marker_add()
23329 * @see elm_map_marker_class_style_set()
23330 * @see elm_map_marker_class_icon_cb_set()
23331 * @see elm_map_marker_class_get_cb_set()
23332 * @see elm_map_marker_class_del_cb_set()
23336 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23339 * Set the marker's style of a marker class.
23341 * @param clas The marker class.
23342 * @param style The style to be used by markers.
23344 * Each marker must be associated to a marker class, and will use the style
23345 * defined by such class when alone, i.e., @b not grouped to other markers.
23347 * The following styles are provided by default theme:
23352 * @see elm_map_marker_class_new() for more details.
23353 * @see elm_map_marker_add()
23357 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23360 * Set the icon callback function of a marker class.
23362 * @param clas The marker class.
23363 * @param icon_get The callback function that will return the icon.
23365 * Each marker must be associated to a marker class, and it can display a
23366 * custom icon. The function @p icon_get must return this icon.
23368 * @see elm_map_marker_class_new() for more details.
23369 * @see elm_map_marker_add()
23373 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23376 * Set the bubble content callback function of a marker class.
23378 * @param clas The marker class.
23379 * @param get The callback function that will return the content.
23381 * Each marker must be associated to a marker class, and it can display a
23382 * a content on a bubble that opens when the user click over the marker.
23383 * The function @p get must return this content object.
23385 * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
23388 * @see elm_map_marker_class_new() for more details.
23389 * @see elm_map_marker_class_del_cb_set()
23390 * @see elm_map_marker_add()
23394 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
23397 * Set the callback function used to delete bubble content of a marker class.
23399 * @param clas The marker class.
23400 * @param del The callback function that will delete the content.
23402 * Each marker must be associated to a marker class, and it can display a
23403 * a content on a bubble that opens when the user click over the marker.
23404 * The function to return such content can be set with
23405 * elm_map_marker_class_get_cb_set().
23407 * If this content must be freed, a callback function need to be
23408 * set for that task with this function.
23410 * If this callback is defined it will have to delete (or not) the
23411 * object inside, but if the callback is not defined the object will be
23412 * destroyed with evas_object_del().
23414 * @see elm_map_marker_class_new() for more details.
23415 * @see elm_map_marker_class_get_cb_set()
23416 * @see elm_map_marker_add()
23420 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
23423 * Get the list of available sources.
23425 * @param obj The map object.
23426 * @return The source names list.
23428 * It will provide a list with all available sources, that can be set as
23429 * current source with elm_map_source_name_set(), or get with
23430 * elm_map_source_name_get().
23432 * Available sources:
23438 * @see elm_map_source_name_set() for more details.
23439 * @see elm_map_source_name_get()
23443 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23446 * Set the source of the map.
23448 * @param obj The map object.
23449 * @param source The source to be used.
23451 * Map widget retrieves images that composes the map from a web service.
23452 * This web service can be set with this method.
23454 * A different service can return a different maps with different
23455 * information and it can use different zoom values.
23457 * The @p source_name need to match one of the names provided by
23458 * elm_map_source_names_get().
23460 * The current source can be get using elm_map_source_name_get().
23462 * @see elm_map_source_names_get()
23463 * @see elm_map_source_name_get()
23468 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
23471 * Get the name of currently used source.
23473 * @param obj The map object.
23474 * @return Returns the name of the source in use.
23476 * @see elm_map_source_name_set() for more details.
23480 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23483 * Set the source of the route service to be used by the map.
23485 * @param obj The map object.
23486 * @param source The route service to be used, being it one of
23487 * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
23488 * and #ELM_MAP_ROUTE_SOURCE_ORS.
23490 * Each one has its own algorithm, so the route retrieved may
23491 * differ depending on the source route. Now, only the default is working.
23493 * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
23494 * http://www.yournavigation.org/.
23496 * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
23497 * assumptions. Its routing core is based on Contraction Hierarchies.
23499 * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
23501 * @see elm_map_route_source_get().
23505 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
23508 * Get the current route source.
23510 * @param obj The map object.
23511 * @return The source of the route service used by the map.
23513 * @see elm_map_route_source_set() for details.
23517 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23520 * Set the minimum zoom of the source.
23522 * @param obj The map object.
23523 * @param zoom New minimum zoom value to be used.
23525 * By default, it's 0.
23529 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23532 * Get the minimum zoom of the source.
23534 * @param obj The map object.
23535 * @return Returns the minimum zoom of the source.
23537 * @see elm_map_source_zoom_min_set() for details.
23541 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23544 * Set the maximum zoom of the source.
23546 * @param obj The map object.
23547 * @param zoom New maximum zoom value to be used.
23549 * By default, it's 18.
23553 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23556 * Get the maximum zoom of the source.
23558 * @param obj The map object.
23559 * @return Returns the maximum zoom of the source.
23561 * @see elm_map_source_zoom_min_set() for details.
23565 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23568 * Set the user agent used by the map object to access routing services.
23570 * @param obj The map object.
23571 * @param user_agent The user agent to be used by the map.
23573 * User agent is a client application implementing a network protocol used
23574 * in communications within a clientāserver distributed computing system
23576 * The @p user_agent identification string will transmitted in a header
23577 * field @c User-Agent.
23579 * @see elm_map_user_agent_get()
23583 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
23586 * Get the user agent used by the map object.
23588 * @param obj The map object.
23589 * @return The user agent identification string used by the map.
23591 * @see elm_map_user_agent_set() for details.
23595 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23598 * Add a new route to the map object.
23600 * @param obj The map object.
23601 * @param type The type of transport to be considered when tracing a route.
23602 * @param method The routing method, what should be priorized.
23603 * @param flon The start longitude.
23604 * @param flat The start latitude.
23605 * @param tlon The destination longitude.
23606 * @param tlat The destination latitude.
23608 * @return The created route or @c NULL upon failure.
23610 * A route will be traced by point on coordinates (@p flat, @p flon)
23611 * to point on coordinates (@p tlat, @p tlon), using the route service
23612 * set with elm_map_route_source_set().
23614 * It will take @p type on consideration to define the route,
23615 * depending if the user will be walking or driving, the route may vary.
23616 * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
23617 * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
23619 * Another parameter is what the route should priorize, the minor distance
23620 * or the less time to be spend on the route. So @p method should be one
23621 * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
23623 * Routes created with this method can be deleted with
23624 * elm_map_route_remove(), colored with elm_map_route_color_set(),
23625 * and distance can be get with elm_map_route_distance_get().
23627 * @see elm_map_route_remove()
23628 * @see elm_map_route_color_set()
23629 * @see elm_map_route_distance_get()
23630 * @see elm_map_route_source_set()
23634 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);
23637 * Remove a route from the map.
23639 * @param route The route to remove.
23641 * @see elm_map_route_add()
23645 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23648 * Set the route color.
23650 * @param route The route object.
23651 * @param r Red channel value, from 0 to 255.
23652 * @param g Green channel value, from 0 to 255.
23653 * @param b Blue channel value, from 0 to 255.
23654 * @param a Alpha channel value, from 0 to 255.
23656 * It uses an additive color model, so each color channel represents
23657 * how much of each primary colors must to be used. 0 represents
23658 * ausence of this color, so if all of the three are set to 0,
23659 * the color will be black.
23661 * These component values should be integers in the range 0 to 255,
23662 * (single 8-bit byte).
23664 * This sets the color used for the route. By default, it is set to
23665 * solid red (r = 255, g = 0, b = 0, a = 255).
23667 * For alpha channel, 0 represents completely transparent, and 255, opaque.
23669 * @see elm_map_route_color_get()
23673 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
23676 * Get the route color.
23678 * @param route The route object.
23679 * @param r Pointer where to store the red channel value.
23680 * @param g Pointer where to store the green channel value.
23681 * @param b Pointer where to store the blue channel value.
23682 * @param a Pointer where to store the alpha channel value.
23684 * @see elm_map_route_color_set() for details.
23688 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
23691 * Get the route distance in kilometers.
23693 * @param route The route object.
23694 * @return The distance of route (unit : km).
23698 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23701 * Get the information of route nodes.
23703 * @param route The route object.
23704 * @return Returns a string with the nodes of route.
23708 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23711 * Get the information of route waypoint.
23713 * @param route the route object.
23714 * @return Returns a string with information about waypoint of route.
23718 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23721 * Get the address of the name.
23723 * @param name The name handle.
23724 * @return Returns the address string of @p name.
23726 * This gets the coordinates of the @p name, created with one of the
23727 * conversion functions.
23729 * @see elm_map_utils_convert_name_into_coord()
23730 * @see elm_map_utils_convert_coord_into_name()
23734 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23737 * Get the current coordinates of the name.
23739 * @param name The name handle.
23740 * @param lat Pointer where to store the latitude.
23741 * @param lon Pointer where to store The longitude.
23743 * This gets the coordinates of the @p name, created with one of the
23744 * conversion functions.
23746 * @see elm_map_utils_convert_name_into_coord()
23747 * @see elm_map_utils_convert_coord_into_name()
23751 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
23754 * Remove a name from the map.
23756 * @param name The name to remove.
23758 * Basically the struct handled by @p name will be freed, so convertions
23759 * between address and coordinates will be lost.
23761 * @see elm_map_utils_convert_name_into_coord()
23762 * @see elm_map_utils_convert_coord_into_name()
23766 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23771 * @param obj The map object.
23772 * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
23773 * @param cx Rotation's center horizontal position.
23774 * @param cy Rotation's center vertical position.
23776 * @see elm_map_rotate_get()
23780 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
23783 * Get the rotate degree of the map
23785 * @param obj The map object
23786 * @param degree Pointer where to store degrees from 0.0 to 360.0
23787 * to rotate arount Z axis.
23788 * @param cx Pointer where to store rotation's center horizontal position.
23789 * @param cy Pointer where to store rotation's center vertical position.
23791 * @see elm_map_rotate_set() to set map rotation.
23795 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);
23798 * Enable or disable mouse wheel to be used to zoom in / out the map.
23800 * @param obj The map object.
23801 * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
23804 * Mouse wheel can be used for the user to zoom in or zoom out the map.
23806 * It's disabled by default.
23808 * @see elm_map_wheel_disabled_get()
23812 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
23815 * Get a value whether mouse wheel is enabled or not.
23817 * @param obj The map object.
23818 * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
23819 * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23821 * Mouse wheel can be used for the user to zoom in or zoom out the map.
23823 * @see elm_map_wheel_disabled_set() for details.
23827 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23831 * Add a track on the map
23833 * @param obj The map object.
23834 * @param emap The emap route object.
23835 * @return The route object. This is an elm object of type Route.
23837 * @see elm_route_add() for details.
23841 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
23845 * Remove a track from the map
23847 * @param obj The map object.
23848 * @param route The track to remove.
23852 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
23859 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
23861 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
23863 EAPI double elm_route_lon_min_get(Evas_Object *obj);
23864 EAPI double elm_route_lat_min_get(Evas_Object *obj);
23865 EAPI double elm_route_lon_max_get(Evas_Object *obj);
23866 EAPI double elm_route_lat_max_get(Evas_Object *obj);
23870 * @defgroup Panel Panel
23872 * @image html img/widget/panel/preview-00.png
23873 * @image latex img/widget/panel/preview-00.eps
23875 * @brief A panel is a type of animated container that contains subobjects.
23876 * It can be expanded or contracted by clicking the button on it's edge.
23878 * Orientations are as follows:
23879 * @li ELM_PANEL_ORIENT_TOP
23880 * @li ELM_PANEL_ORIENT_LEFT
23881 * @li ELM_PANEL_ORIENT_RIGHT
23883 * To set/get/unset the content of the panel, you can use
23884 * elm_object_content_set/get/unset APIs.
23885 * Once the content object is set, a previously set one will be deleted.
23886 * If you want to keep that old content object, use the
23887 * elm_object_content_unset() function
23889 * @ref tutorial_panel shows one way to use this widget.
23892 typedef enum _Elm_Panel_Orient
23894 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
23895 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
23896 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
23897 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
23898 } Elm_Panel_Orient;
23900 * @brief Adds a panel object
23902 * @param parent The parent object
23904 * @return The panel object, or NULL on failure
23906 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23908 * @brief Sets the orientation of the panel
23910 * @param parent The parent object
23911 * @param orient The panel orientation. Can be one of the following:
23912 * @li ELM_PANEL_ORIENT_TOP
23913 * @li ELM_PANEL_ORIENT_LEFT
23914 * @li ELM_PANEL_ORIENT_RIGHT
23916 * Sets from where the panel will (dis)appear.
23918 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
23920 * @brief Get the orientation of the panel.
23922 * @param obj The panel object
23923 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
23925 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23927 * @brief Set the content of the panel.
23929 * @param obj The panel object
23930 * @param content The panel content
23932 * Once the content object is set, a previously set one will be deleted.
23933 * If you want to keep that old content object, use the
23934 * elm_panel_content_unset() function.
23936 * @deprecated use elm_object_content_set() instead
23939 EINA_DEPRECATED EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23941 * @brief Get the content of the panel.
23943 * @param obj The panel object
23944 * @return The content that is being used
23946 * Return the content object which is set for this widget.
23948 * @see elm_panel_content_set()
23950 * @deprecated use elm_object_content_get() instead
23953 EINA_DEPRECATED EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23955 * @brief Unset the content of the panel.
23957 * @param obj The panel object
23958 * @return The content that was being used
23960 * Unparent and return the content object which was set for this widget.
23962 * @see elm_panel_content_set()
23964 * @deprecated use elm_object_content_unset() instead
23967 EINA_DEPRECATED EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23969 * @brief Set the state of the panel.
23971 * @param obj The panel object
23972 * @param hidden If true, the panel will run the animation to contract
23974 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
23976 * @brief Get the state of the panel.
23978 * @param obj The panel object
23979 * @param hidden If true, the panel is in the "hide" state
23981 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23983 * @brief Toggle the hidden state of the panel from code
23985 * @param obj The panel object
23987 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
23993 * @defgroup Panes Panes
23994 * @ingroup Elementary
23996 * @image html img/widget/panes/preview-00.png
23997 * @image latex img/widget/panes/preview-00.eps width=\textwidth
23999 * @image html img/panes.png
24000 * @image latex img/panes.eps width=\textwidth
24002 * The panes adds a dragable bar between two contents. When dragged
24003 * this bar will resize contents size.
24005 * Panes can be displayed vertically or horizontally, and contents
24006 * size proportion can be customized (homogeneous by default).
24008 * Smart callbacks one can listen to:
24009 * - "press" - The panes has been pressed (button wasn't released yet).
24010 * - "unpressed" - The panes was released after being pressed.
24011 * - "clicked" - The panes has been clicked>
24012 * - "clicked,double" - The panes has been double clicked
24014 * Available styles for it:
24017 * Default contents parts of the panes widget that you can use for are:
24018 * @li "elm.swallow.left" - A leftside content of the panes
24019 * @li "elm.swallow.right" - A rightside content of the panes
24021 * If panes is displayed vertically, left content will be displayed at
24024 * Here is an example on its usage:
24025 * @li @ref panes_example
24028 #define ELM_PANES_CONTENT_LEFT "elm.swallow.left"
24029 #define ELM_PANES_CONTENT_RIGHT "elm.swallow.right"
24032 * @addtogroup Panes
24037 * Add a new panes widget to the given parent Elementary
24038 * (container) object.
24040 * @param parent The parent object.
24041 * @return a new panes widget handle or @c NULL, on errors.
24043 * This function inserts a new panes widget on the canvas.
24047 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24050 * Set the left content of the panes widget.
24052 * @param obj The panes object.
24053 * @param content The new left content object.
24055 * Once the content object is set, a previously set one will be deleted.
24056 * If you want to keep that old content object, use the
24057 * elm_panes_content_left_unset() function.
24059 * If panes is displayed vertically, left content will be displayed at
24062 * @see elm_panes_content_left_get()
24063 * @see elm_panes_content_right_set() to set content on the other side.
24065 * @deprecated use elm_object_content_part_set() instead
24069 EINA_DEPRECATED EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24072 * Set the right content of the panes widget.
24074 * @param obj The panes object.
24075 * @param content The new right content object.
24077 * Once the content object is set, a previously set one will be deleted.
24078 * If you want to keep that old content object, use the
24079 * elm_panes_content_right_unset() function.
24081 * If panes is displayed vertically, left content will be displayed at
24084 * @see elm_panes_content_right_get()
24085 * @see elm_panes_content_left_set() to set content on the other side.
24087 * @deprecated use elm_object_content_part_set() instead
24091 EINA_DEPRECATED EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24094 * Get the left content of the panes.
24096 * @param obj The panes object.
24097 * @return The left content object that is being used.
24099 * Return the left content object which is set for this widget.
24101 * @see elm_panes_content_left_set() for details.
24103 * @deprecated use elm_object_content_part_get() instead
24107 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24110 * Get the right content of the panes.
24112 * @param obj The panes object
24113 * @return The right content object that is being used
24115 * Return the right content object which is set for this widget.
24117 * @see elm_panes_content_right_set() for details.
24119 * @deprecated use elm_object_content_part_get() instead
24123 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24126 * Unset the left content used for the panes.
24128 * @param obj The panes object.
24129 * @return The left content object that was being used.
24131 * Unparent and return the left content object which was set for this widget.
24133 * @see elm_panes_content_left_set() for details.
24134 * @see elm_panes_content_left_get().
24136 * @deprecated use elm_object_content_part_unset() instead
24140 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24143 * Unset the right content used for the panes.
24145 * @param obj The panes object.
24146 * @return The right content object that was being used.
24148 * Unparent and return the right content object which was set for this
24151 * @see elm_panes_content_right_set() for details.
24152 * @see elm_panes_content_right_get().
24154 * @deprecated use elm_object_content_part_unset() instead
24158 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24161 * Get the size proportion of panes widget's left side.
24163 * @param obj The panes object.
24164 * @return float value between 0.0 and 1.0 representing size proportion
24167 * @see elm_panes_content_left_size_set() for more details.
24171 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24174 * Set the size proportion of panes widget's left side.
24176 * @param obj The panes object.
24177 * @param size Value between 0.0 and 1.0 representing size proportion
24180 * By default it's homogeneous, i.e., both sides have the same size.
24182 * If something different is required, it can be set with this function.
24183 * For example, if the left content should be displayed over
24184 * 75% of the panes size, @p size should be passed as @c 0.75.
24185 * This way, right content will be resized to 25% of panes size.
24187 * If displayed vertically, left content is displayed at top, and
24188 * right content at bottom.
24190 * @note This proportion will change when user drags the panes bar.
24192 * @see elm_panes_content_left_size_get()
24196 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
24199 * Set the orientation of a given panes widget.
24201 * @param obj The panes object.
24202 * @param horizontal Use @c EINA_TRUE to make @p obj to be
24203 * @b horizontal, @c EINA_FALSE to make it @b vertical.
24205 * Use this function to change how your panes is to be
24206 * disposed: vertically or horizontally.
24208 * By default it's displayed horizontally.
24210 * @see elm_panes_horizontal_get()
24214 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
24217 * Retrieve the orientation of a given panes widget.
24219 * @param obj The panes object.
24220 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
24221 * @c EINA_FALSE if it's @b vertical (and on errors).
24223 * @see elm_panes_horizontal_set() for more details.
24227 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24228 EAPI void elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
24229 EAPI Eina_Bool elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24236 * @defgroup Flip Flip
24238 * @image html img/widget/flip/preview-00.png
24239 * @image latex img/widget/flip/preview-00.eps
24241 * This widget holds 2 content objects(Evas_Object): one on the front and one
24242 * on the back. It allows you to flip from front to back and vice-versa using
24243 * various animations.
24245 * If either the front or back contents are not set the flip will treat that
24246 * as transparent. So if you wore to set the front content but not the back,
24247 * and then call elm_flip_go() you would see whatever is below the flip.
24249 * For a list of supported animations see elm_flip_go().
24251 * Signals that you can add callbacks for are:
24252 * "animate,begin" - when a flip animation was started
24253 * "animate,done" - when a flip animation is finished
24255 * @ref tutorial_flip show how to use most of the API.
24259 typedef enum _Elm_Flip_Mode
24261 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
24262 ELM_FLIP_ROTATE_X_CENTER_AXIS,
24263 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
24264 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
24265 ELM_FLIP_CUBE_LEFT,
24266 ELM_FLIP_CUBE_RIGHT,
24268 ELM_FLIP_CUBE_DOWN,
24269 ELM_FLIP_PAGE_LEFT,
24270 ELM_FLIP_PAGE_RIGHT,
24274 typedef enum _Elm_Flip_Interaction
24276 ELM_FLIP_INTERACTION_NONE,
24277 ELM_FLIP_INTERACTION_ROTATE,
24278 ELM_FLIP_INTERACTION_CUBE,
24279 ELM_FLIP_INTERACTION_PAGE
24280 } Elm_Flip_Interaction;
24281 typedef enum _Elm_Flip_Direction
24283 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
24284 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
24285 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
24286 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
24287 } Elm_Flip_Direction;
24289 * @brief Add a new flip to the parent
24291 * @param parent The parent object
24292 * @return The new object or NULL if it cannot be created
24294 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24296 * @brief Set the front content of the flip widget.
24298 * @param obj The flip object
24299 * @param content The new front content object
24301 * Once the content object is set, a previously set one will be deleted.
24302 * If you want to keep that old content object, use the
24303 * elm_flip_content_front_unset() function.
24305 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24307 * @brief Set the back content of the flip widget.
24309 * @param obj The flip object
24310 * @param content The new back content object
24312 * Once the content object is set, a previously set one will be deleted.
24313 * If you want to keep that old content object, use the
24314 * elm_flip_content_back_unset() function.
24316 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24318 * @brief Get the front content used for the flip
24320 * @param obj The flip object
24321 * @return The front content object that is being used
24323 * Return the front content object which is set for this widget.
24325 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24327 * @brief Get the back content used for the flip
24329 * @param obj The flip object
24330 * @return The back content object that is being used
24332 * Return the back content object which is set for this widget.
24334 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24336 * @brief Unset the front content used for the flip
24338 * @param obj The flip object
24339 * @return The front content object that was being used
24341 * Unparent and return the front content object which was set for this widget.
24343 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24345 * @brief Unset the back content used for the flip
24347 * @param obj The flip object
24348 * @return The back content object that was being used
24350 * Unparent and return the back content object which was set for this widget.
24352 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24354 * @brief Get flip front visibility state
24356 * @param obj The flip objct
24357 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
24360 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24362 * @brief Set flip perspective
24364 * @param obj The flip object
24365 * @param foc The coordinate to set the focus on
24366 * @param x The X coordinate
24367 * @param y The Y coordinate
24369 * @warning This function currently does nothing.
24371 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
24373 * @brief Runs the flip animation
24375 * @param obj The flip object
24376 * @param mode The mode type
24378 * Flips the front and back contents using the @p mode animation. This
24379 * efectively hides the currently visible content and shows the hidden one.
24381 * There a number of possible animations to use for the flipping:
24382 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
24383 * around a horizontal axis in the middle of its height, the other content
24384 * is shown as the other side of the flip.
24385 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
24386 * around a vertical axis in the middle of its width, the other content is
24387 * shown as the other side of the flip.
24388 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
24389 * around a diagonal axis in the middle of its width, the other content is
24390 * shown as the other side of the flip.
24391 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
24392 * around a diagonal axis in the middle of its height, the other content is
24393 * shown as the other side of the flip.
24394 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
24395 * as if the flip was a cube, the other content is show as the right face of
24397 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
24398 * right as if the flip was a cube, the other content is show as the left
24399 * face of the cube.
24400 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
24401 * flip was a cube, the other content is show as the bottom face of the cube.
24402 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
24403 * the flip was a cube, the other content is show as the upper face of the
24405 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
24406 * if the flip was a book, the other content is shown as the page below that.
24407 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
24408 * as if the flip was a book, the other content is shown as the page below
24410 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
24411 * flip was a book, the other content is shown as the page below that.
24412 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
24413 * flip was a book, the other content is shown as the page below that.
24415 * @image html elm_flip.png
24416 * @image latex elm_flip.eps width=\textwidth
24418 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
24420 * @brief Set the interactive flip mode
24422 * @param obj The flip object
24423 * @param mode The interactive flip mode to use
24425 * This sets if the flip should be interactive (allow user to click and
24426 * drag a side of the flip to reveal the back page and cause it to flip).
24427 * By default a flip is not interactive. You may also need to set which
24428 * sides of the flip are "active" for flipping and how much space they use
24429 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
24430 * and elm_flip_interacton_direction_hitsize_set()
24432 * The four avilable mode of interaction are:
24433 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
24434 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
24435 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
24436 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
24438 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
24439 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
24440 * happen, those can only be acheived with elm_flip_go();
24442 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
24444 * @brief Get the interactive flip mode
24446 * @param obj The flip object
24447 * @return The interactive flip mode
24449 * Returns the interactive flip mode set by elm_flip_interaction_set()
24451 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
24453 * @brief Set which directions of the flip respond to interactive flip
24455 * @param obj The flip object
24456 * @param dir The direction to change
24457 * @param enabled If that direction is enabled or not
24459 * By default all directions are disabled, so you may want to enable the
24460 * desired directions for flipping if you need interactive flipping. You must
24461 * call this function once for each direction that should be enabled.
24463 * @see elm_flip_interaction_set()
24465 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
24467 * @brief Get the enabled state of that flip direction
24469 * @param obj The flip object
24470 * @param dir The direction to check
24471 * @return If that direction is enabled or not
24473 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
24475 * @see elm_flip_interaction_set()
24477 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
24479 * @brief Set the amount of the flip that is sensitive to interactive flip
24481 * @param obj The flip object
24482 * @param dir The direction to modify
24483 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
24485 * Set the amount of the flip that is sensitive to interactive flip, with 0
24486 * representing no area in the flip and 1 representing the entire flip. There
24487 * is however a consideration to be made in that the area will never be
24488 * smaller than the finger size set(as set in your Elementary configuration).
24490 * @see elm_flip_interaction_set()
24492 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
24494 * @brief Get the amount of the flip that is sensitive to interactive flip
24496 * @param obj The flip object
24497 * @param dir The direction to check
24498 * @return The size set for that direction
24500 * Returns the amount os sensitive area set by
24501 * elm_flip_interacton_direction_hitsize_set().
24503 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
24508 /* scrolledentry */
24509 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24510 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
24511 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24512 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
24513 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24514 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24515 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24516 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24517 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24518 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24519 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24520 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
24521 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
24522 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24523 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
24524 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
24525 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24526 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24527 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
24528 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
24529 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24530 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24531 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24532 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24533 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
24534 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
24535 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24536 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24537 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24538 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24539 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24540 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
24541 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
24542 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
24543 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24544 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);
24545 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24546 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24547 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);
24548 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24549 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);
24550 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
24551 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24552 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24553 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24554 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
24555 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24556 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24557 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24558 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);
24559 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);
24560 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);
24561 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);
24562 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);
24563 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);
24564 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
24565 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
24566 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
24567 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
24568 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24569 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
24570 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
24573 * @defgroup Conformant Conformant
24574 * @ingroup Elementary
24576 * @image html img/widget/conformant/preview-00.png
24577 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
24579 * @image html img/conformant.png
24580 * @image latex img/conformant.eps width=\textwidth
24582 * The aim is to provide a widget that can be used in elementary apps to
24583 * account for space taken up by the indicator, virtual keypad & softkey
24584 * windows when running the illume2 module of E17.
24586 * So conformant content will be sized and positioned considering the
24587 * space required for such stuff, and when they popup, as a keyboard
24588 * shows when an entry is selected, conformant content won't change.
24590 * Available styles for it:
24593 * Default contents parts of the conformant widget that you can use for are:
24594 * @li "elm.swallow.content" - A content of the conformant
24596 * See how to use this widget in this example:
24597 * @ref conformant_example
24601 * @addtogroup Conformant
24606 * Add a new conformant widget to the given parent Elementary
24607 * (container) object.
24609 * @param parent The parent object.
24610 * @return A new conformant widget handle or @c NULL, on errors.
24612 * This function inserts a new conformant widget on the canvas.
24614 * @ingroup Conformant
24616 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24619 * Set the content of the conformant widget.
24621 * @param obj The conformant object.
24622 * @param content The content to be displayed by the conformant.
24624 * Content will be sized and positioned considering the space required
24625 * to display a virtual keyboard. So it won't fill all the conformant
24626 * size. This way is possible to be sure that content won't resize
24627 * or be re-positioned after the keyboard is displayed.
24629 * Once the content object is set, a previously set one will be deleted.
24630 * If you want to keep that old content object, use the
24631 * elm_object_content_unset() function.
24633 * @see elm_object_content_unset()
24634 * @see elm_object_content_get()
24636 * @deprecated use elm_object_content_set() instead
24638 * @ingroup Conformant
24640 EINA_DEPRECATED EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24643 * Get the content of the conformant widget.
24645 * @param obj The conformant object.
24646 * @return The content that is being used.
24648 * Return the content object which is set for this widget.
24649 * It won't be unparent from conformant. For that, use
24650 * elm_object_content_unset().
24652 * @see elm_object_content_set().
24653 * @see elm_object_content_unset()
24655 * @deprecated use elm_object_content_get() instead
24657 * @ingroup Conformant
24659 EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24662 * Unset the content of the conformant widget.
24664 * @param obj The conformant object.
24665 * @return The content that was being used.
24667 * Unparent and return the content object which was set for this widget.
24669 * @see elm_object_content_set().
24671 * @deprecated use elm_object_content_unset() instead
24673 * @ingroup Conformant
24675 EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24678 * Returns the Evas_Object that represents the content area.
24680 * @param obj The conformant object.
24681 * @return The content area of the widget.
24683 * @ingroup Conformant
24685 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24692 * @defgroup Mapbuf Mapbuf
24693 * @ingroup Elementary
24695 * @image html img/widget/mapbuf/preview-00.png
24696 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
24698 * This holds one content object and uses an Evas Map of transformation
24699 * points to be later used with this content. So the content will be
24700 * moved, resized, etc as a single image. So it will improve performance
24701 * when you have a complex interafce, with a lot of elements, and will
24702 * need to resize or move it frequently (the content object and its
24705 * To set/get/unset the content of the mapbuf, you can use
24706 * elm_object_content_set/get/unset APIs.
24707 * Once the content object is set, a previously set one will be deleted.
24708 * If you want to keep that old content object, use the
24709 * elm_object_content_unset() function.
24711 * To enable map, elm_mapbuf_enabled_set() should be used.
24713 * See how to use this widget in this example:
24714 * @ref mapbuf_example
24718 * @addtogroup Mapbuf
24723 * Add a new mapbuf widget to the given parent Elementary
24724 * (container) object.
24726 * @param parent The parent object.
24727 * @return A new mapbuf widget handle or @c NULL, on errors.
24729 * This function inserts a new mapbuf widget on the canvas.
24733 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24736 * Set the content of the mapbuf.
24738 * @param obj The mapbuf object.
24739 * @param content The content that will be filled in this mapbuf object.
24741 * Once the content object is set, a previously set one will be deleted.
24742 * If you want to keep that old content object, use the
24743 * elm_mapbuf_content_unset() function.
24745 * To enable map, elm_mapbuf_enabled_set() should be used.
24747 * @deprecated use elm_object_content_set() instead
24751 EINA_DEPRECATED EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24754 * Get the content of the mapbuf.
24756 * @param obj The mapbuf object.
24757 * @return The content that is being used.
24759 * Return the content object which is set for this widget.
24761 * @see elm_mapbuf_content_set() for details.
24763 * @deprecated use elm_object_content_get() instead
24767 EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24770 * Unset the content of the mapbuf.
24772 * @param obj The mapbuf object.
24773 * @return The content that was being used.
24775 * Unparent and return the content object which was set for this widget.
24777 * @see elm_mapbuf_content_set() for details.
24779 * @deprecated use elm_object_content_unset() instead
24783 EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24786 * Enable or disable the map.
24788 * @param obj The mapbuf object.
24789 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
24791 * This enables the map that is set or disables it. On enable, the object
24792 * geometry will be saved, and the new geometry will change (position and
24793 * size) to reflect the map geometry set.
24795 * Also, when enabled, alpha and smooth states will be used, so if the
24796 * content isn't solid, alpha should be enabled, for example, otherwise
24797 * a black retangle will fill the content.
24799 * When disabled, the stored map will be freed and geometry prior to
24800 * enabling the map will be restored.
24802 * It's disabled by default.
24804 * @see elm_mapbuf_alpha_set()
24805 * @see elm_mapbuf_smooth_set()
24809 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
24812 * Get a value whether map is enabled or not.
24814 * @param obj The mapbuf object.
24815 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
24816 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24818 * @see elm_mapbuf_enabled_set() for details.
24822 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24825 * Enable or disable smooth map rendering.
24827 * @param obj The mapbuf object.
24828 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
24831 * This sets smoothing for map rendering. If the object is a type that has
24832 * its own smoothing settings, then both the smooth settings for this object
24833 * and the map must be turned off.
24835 * By default smooth maps are enabled.
24839 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
24842 * Get a value whether smooth map rendering is enabled or not.
24844 * @param obj The mapbuf object.
24845 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
24846 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24848 * @see elm_mapbuf_smooth_set() for details.
24852 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24855 * Set or unset alpha flag for map rendering.
24857 * @param obj The mapbuf object.
24858 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
24861 * This sets alpha flag for map rendering. If the object is a type that has
24862 * its own alpha settings, then this will take precedence. Only image objects
24863 * have this currently. It stops alpha blending of the map area, and is
24864 * useful if you know the object and/or all sub-objects is 100% solid.
24866 * Alpha is enabled by default.
24870 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
24873 * Get a value whether alpha blending is enabled or not.
24875 * @param obj The mapbuf object.
24876 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
24877 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24879 * @see elm_mapbuf_alpha_set() for details.
24883 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24890 * @defgroup Flipselector Flip Selector
24892 * @image html img/widget/flipselector/preview-00.png
24893 * @image latex img/widget/flipselector/preview-00.eps
24895 * A flip selector is a widget to show a set of @b text items, one
24896 * at a time, with the same sheet switching style as the @ref Clock
24897 * "clock" widget, when one changes the current displaying sheet
24898 * (thus, the "flip" in the name).
24900 * User clicks to flip sheets which are @b held for some time will
24901 * make the flip selector to flip continuosly and automatically for
24902 * the user. The interval between flips will keep growing in time,
24903 * so that it helps the user to reach an item which is distant from
24904 * the current selection.
24906 * Smart callbacks one can register to:
24907 * - @c "selected" - when the widget's selected text item is changed
24908 * - @c "overflowed" - when the widget's current selection is changed
24909 * from the first item in its list to the last
24910 * - @c "underflowed" - when the widget's current selection is changed
24911 * from the last item in its list to the first
24913 * Available styles for it:
24916 * Here is an example on its usage:
24917 * @li @ref flipselector_example
24921 * @addtogroup Flipselector
24925 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
24928 * Add a new flip selector widget to the given parent Elementary
24929 * (container) widget
24931 * @param parent The parent object
24932 * @return a new flip selector widget handle or @c NULL, on errors
24934 * This function inserts a new flip selector widget on the canvas.
24936 * @ingroup Flipselector
24938 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24941 * Programmatically select the next item of a flip selector widget
24943 * @param obj The flipselector object
24945 * @note The selection will be animated. Also, if it reaches the
24946 * end of its list of member items, it will continue with the first
24949 * @ingroup Flipselector
24951 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24954 * Programmatically select the previous item of a flip selector
24957 * @param obj The flipselector object
24959 * @note The selection will be animated. Also, if it reaches the
24960 * beginning of its list of member items, it will continue with the
24961 * last one backwards.
24963 * @ingroup Flipselector
24965 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24968 * Append a (text) item to a flip selector widget
24970 * @param obj The flipselector object
24971 * @param label The (text) label of the new item
24972 * @param func Convenience callback function to take place when
24974 * @param data Data passed to @p func, above
24975 * @return A handle to the item added or @c NULL, on errors
24977 * The widget's list of labels to show will be appended with the
24978 * given value. If the user wishes so, a callback function pointer
24979 * can be passed, which will get called when this same item is
24982 * @note The current selection @b won't be modified by appending an
24983 * element to the list.
24985 * @note The maximum length of the text label is going to be
24986 * determined <b>by the widget's theme</b>. Strings larger than
24987 * that value are going to be @b truncated.
24989 * @ingroup Flipselector
24991 EAPI Elm_Flipselector_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24994 * Prepend a (text) item to a flip selector widget
24996 * @param obj The flipselector object
24997 * @param label The (text) label of the new item
24998 * @param func Convenience callback function to take place when
25000 * @param data Data passed to @p func, above
25001 * @return A handle to the item added or @c NULL, on errors
25003 * The widget's list of labels to show will be prepended with the
25004 * given value. If the user wishes so, a callback function pointer
25005 * can be passed, which will get called when this same item is
25008 * @note The current selection @b won't be modified by prepending
25009 * an element to the list.
25011 * @note The maximum length of the text label is going to be
25012 * determined <b>by the widget's theme</b>. Strings larger than
25013 * that value are going to be @b truncated.
25015 * @ingroup Flipselector
25017 EAPI Elm_Flipselector_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
25020 * Get the internal list of items in a given flip selector widget.
25022 * @param obj The flipselector object
25023 * @return The list of items (#Elm_Flipselector_Item as data) or
25024 * @c NULL on errors.
25026 * This list is @b not to be modified in any way and must not be
25027 * freed. Use the list members with functions like
25028 * elm_flipselector_item_label_set(),
25029 * elm_flipselector_item_label_get(),
25030 * elm_flipselector_item_del(),
25031 * elm_flipselector_item_selected_get(),
25032 * elm_flipselector_item_selected_set().
25034 * @warning This list is only valid until @p obj object's internal
25035 * items list is changed. It should be fetched again with another
25036 * call to this function when changes happen.
25038 * @ingroup Flipselector
25040 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25043 * Get the first item in the given flip selector widget's list of
25046 * @param obj The flipselector object
25047 * @return The first item or @c NULL, if it has no items (and on
25050 * @see elm_flipselector_item_append()
25051 * @see elm_flipselector_last_item_get()
25053 * @ingroup Flipselector
25055 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25058 * Get the last item in the given flip selector widget's list of
25061 * @param obj The flipselector object
25062 * @return The last item or @c NULL, if it has no items (and on
25065 * @see elm_flipselector_item_prepend()
25066 * @see elm_flipselector_first_item_get()
25068 * @ingroup Flipselector
25070 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25073 * Get the currently selected item in a flip selector widget.
25075 * @param obj The flipselector object
25076 * @return The selected item or @c NULL, if the widget has no items
25079 * @ingroup Flipselector
25081 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25084 * Set whether a given flip selector widget's item should be the
25085 * currently selected one.
25087 * @param item The flip selector item
25088 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
25090 * This sets whether @p item is or not the selected (thus, under
25091 * display) one. If @p item is different than one under display,
25092 * the latter will be unselected. If the @p item is set to be
25093 * unselected, on the other hand, the @b first item in the widget's
25094 * internal members list will be the new selected one.
25096 * @see elm_flipselector_item_selected_get()
25098 * @ingroup Flipselector
25100 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
25103 * Get whether a given flip selector widget's item is the currently
25106 * @param item The flip selector item
25107 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
25110 * @see elm_flipselector_item_selected_set()
25112 * @ingroup Flipselector
25114 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
25117 * Delete a given item from a flip selector widget.
25119 * @param item The item to delete
25121 * @ingroup Flipselector
25123 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
25126 * Get the label of a given flip selector widget's item.
25128 * @param item The item to get label from
25129 * @return The text label of @p item or @c NULL, on errors
25131 * @see elm_flipselector_item_label_set()
25133 * @ingroup Flipselector
25135 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
25138 * Set the label of a given flip selector widget's item.
25140 * @param item The item to set label on
25141 * @param label The text label string, in UTF-8 encoding
25143 * @see elm_flipselector_item_label_get()
25145 * @ingroup Flipselector
25147 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
25150 * Gets the item before @p item in a flip selector widget's
25151 * internal list of items.
25153 * @param item The item to fetch previous from
25154 * @return The item before the @p item, in its parent's list. If
25155 * there is no previous item for @p item or there's an
25156 * error, @c NULL is returned.
25158 * @see elm_flipselector_item_next_get()
25160 * @ingroup Flipselector
25162 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
25165 * Gets the item after @p item in a flip selector widget's
25166 * internal list of items.
25168 * @param item The item to fetch next from
25169 * @return The item after the @p item, in its parent's list. If
25170 * there is no next item for @p item or there's an
25171 * error, @c NULL is returned.
25173 * @see elm_flipselector_item_next_get()
25175 * @ingroup Flipselector
25177 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
25180 * Set the interval on time updates for an user mouse button hold
25181 * on a flip selector widget.
25183 * @param obj The flip selector object
25184 * @param interval The (first) interval value in seconds
25186 * This interval value is @b decreased while the user holds the
25187 * mouse pointer either flipping up or flipping doww a given flip
25190 * This helps the user to get to a given item distant from the
25191 * current one easier/faster, as it will start to flip quicker and
25192 * quicker on mouse button holds.
25194 * The calculation for the next flip interval value, starting from
25195 * the one set with this call, is the previous interval divided by
25196 * 1.05, so it decreases a little bit.
25198 * The default starting interval value for automatic flips is
25201 * @see elm_flipselector_interval_get()
25203 * @ingroup Flipselector
25205 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25208 * Get the interval on time updates for an user mouse button hold
25209 * on a flip selector widget.
25211 * @param obj The flip selector object
25212 * @return The (first) interval value, in seconds, set on it
25214 * @see elm_flipselector_interval_set() for more details
25216 * @ingroup Flipselector
25218 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25224 * @addtogroup Calendar
25229 * @enum _Elm_Calendar_Mark_Repeat
25230 * @typedef Elm_Calendar_Mark_Repeat
25232 * Event periodicity, used to define if a mark should be repeated
25233 * @b beyond event's day. It's set when a mark is added.
25235 * So, for a mark added to 13th May with periodicity set to WEEKLY,
25236 * there will be marks every week after this date. Marks will be displayed
25237 * at 13th, 20th, 27th, 3rd June ...
25239 * Values don't work as bitmask, only one can be choosen.
25241 * @see elm_calendar_mark_add()
25243 * @ingroup Calendar
25245 typedef enum _Elm_Calendar_Mark_Repeat
25247 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
25248 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
25249 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
25250 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*/
25251 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. */
25252 } Elm_Calendar_Mark_Repeat;
25254 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(). */
25257 * Add a new calendar widget to the given parent Elementary
25258 * (container) object.
25260 * @param parent The parent object.
25261 * @return a new calendar widget handle or @c NULL, on errors.
25263 * This function inserts a new calendar widget on the canvas.
25265 * @ref calendar_example_01
25267 * @ingroup Calendar
25269 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25272 * Get weekdays names displayed by the calendar.
25274 * @param obj The calendar object.
25275 * @return Array of seven strings to be used as weekday names.
25277 * By default, weekdays abbreviations get from system are displayed:
25278 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25279 * The first string is related to Sunday, the second to Monday...
25281 * @see elm_calendar_weekdays_name_set()
25283 * @ref calendar_example_05
25285 * @ingroup Calendar
25287 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25290 * Set weekdays names to be displayed by the calendar.
25292 * @param obj The calendar object.
25293 * @param weekdays Array of seven strings to be used as weekday names.
25294 * @warning It must have 7 elements, or it will access invalid memory.
25295 * @warning The strings must be NULL terminated ('@\0').
25297 * By default, weekdays abbreviations get from system are displayed:
25298 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25300 * The first string should be related to Sunday, the second to Monday...
25302 * The usage should be like this:
25304 * const char *weekdays[] =
25306 * "Sunday", "Monday", "Tuesday", "Wednesday",
25307 * "Thursday", "Friday", "Saturday"
25309 * elm_calendar_weekdays_names_set(calendar, weekdays);
25312 * @see elm_calendar_weekdays_name_get()
25314 * @ref calendar_example_02
25316 * @ingroup Calendar
25318 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
25321 * Set the minimum and maximum values for the year
25323 * @param obj The calendar object
25324 * @param min The minimum year, greater than 1901;
25325 * @param max The maximum year;
25327 * Maximum must be greater than minimum, except if you don't wan't to set
25329 * Default values are 1902 and -1.
25331 * If the maximum year is a negative value, it will be limited depending
25332 * on the platform architecture (year 2037 for 32 bits);
25334 * @see elm_calendar_min_max_year_get()
25336 * @ref calendar_example_03
25338 * @ingroup Calendar
25340 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
25343 * Get the minimum and maximum values for the year
25345 * @param obj The calendar object.
25346 * @param min The minimum year.
25347 * @param max The maximum year.
25349 * Default values are 1902 and -1.
25351 * @see elm_calendar_min_max_year_get() for more details.
25353 * @ref calendar_example_05
25355 * @ingroup Calendar
25357 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
25360 * Enable or disable day selection
25362 * @param obj The calendar object.
25363 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
25366 * Enabled by default. If disabled, the user still can select months,
25367 * but not days. Selected days are highlighted on calendar.
25368 * It should be used if you won't need such selection for the widget usage.
25370 * When a day is selected, or month is changed, smart callbacks for
25371 * signal "changed" will be called.
25373 * @see elm_calendar_day_selection_enable_get()
25375 * @ref calendar_example_04
25377 * @ingroup Calendar
25379 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25382 * Get a value whether day selection is enabled or not.
25384 * @see elm_calendar_day_selection_enable_set() for details.
25386 * @param obj The calendar object.
25387 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
25388 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
25390 * @ref calendar_example_05
25392 * @ingroup Calendar
25394 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25398 * Set selected date to be highlighted on calendar.
25400 * @param obj The calendar object.
25401 * @param selected_time A @b tm struct to represent the selected date.
25403 * Set the selected date, changing the displayed month if needed.
25404 * Selected date changes when the user goes to next/previous month or
25405 * select a day pressing over it on calendar.
25407 * @see elm_calendar_selected_time_get()
25409 * @ref calendar_example_04
25411 * @ingroup Calendar
25413 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
25416 * Get selected date.
25418 * @param obj The calendar object
25419 * @param selected_time A @b tm struct to point to selected date
25420 * @return EINA_FALSE means an error ocurred and returned time shouldn't
25423 * Get date selected by the user or set by function
25424 * elm_calendar_selected_time_set().
25425 * Selected date changes when the user goes to next/previous month or
25426 * select a day pressing over it on calendar.
25428 * @see elm_calendar_selected_time_get()
25430 * @ref calendar_example_05
25432 * @ingroup Calendar
25434 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
25437 * Set a function to format the string that will be used to display
25440 * @param obj The calendar object
25441 * @param format_function Function to set the month-year string given
25442 * the selected date
25444 * By default it uses strftime with "%B %Y" format string.
25445 * It should allocate the memory that will be used by the string,
25446 * that will be freed by the widget after usage.
25447 * A pointer to the string and a pointer to the time struct will be provided.
25452 * _format_month_year(struct tm *selected_time)
25455 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
25456 * return strdup(buf);
25459 * elm_calendar_format_function_set(calendar, _format_month_year);
25462 * @ref calendar_example_02
25464 * @ingroup Calendar
25466 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
25469 * Add a new mark to the calendar
25471 * @param obj The calendar object
25472 * @param mark_type A string used to define the type of mark. It will be
25473 * emitted to the theme, that should display a related modification on these
25474 * days representation.
25475 * @param mark_time A time struct to represent the date of inclusion of the
25476 * mark. For marks that repeats it will just be displayed after the inclusion
25477 * date in the calendar.
25478 * @param repeat Repeat the event following this periodicity. Can be a unique
25479 * mark (that don't repeat), daily, weekly, monthly or annually.
25480 * @return The created mark or @p NULL upon failure.
25482 * Add a mark that will be drawn in the calendar respecting the insertion
25483 * time and periodicity. It will emit the type as signal to the widget theme.
25484 * Default theme supports "holiday" and "checked", but it can be extended.
25486 * It won't immediately update the calendar, drawing the marks.
25487 * For this, call elm_calendar_marks_draw(). However, when user selects
25488 * next or previous month calendar forces marks drawn.
25490 * Marks created with this method can be deleted with
25491 * elm_calendar_mark_del().
25495 * struct tm selected_time;
25496 * time_t current_time;
25498 * current_time = time(NULL) + 5 * 84600;
25499 * localtime_r(¤t_time, &selected_time);
25500 * elm_calendar_mark_add(cal, "holiday", selected_time,
25501 * ELM_CALENDAR_ANNUALLY);
25503 * current_time = time(NULL) + 1 * 84600;
25504 * localtime_r(¤t_time, &selected_time);
25505 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
25507 * elm_calendar_marks_draw(cal);
25510 * @see elm_calendar_marks_draw()
25511 * @see elm_calendar_mark_del()
25513 * @ref calendar_example_06
25515 * @ingroup Calendar
25517 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);
25520 * Delete mark from the calendar.
25522 * @param mark The mark to be deleted.
25524 * If deleting all calendar marks is required, elm_calendar_marks_clear()
25525 * should be used instead of getting marks list and deleting each one.
25527 * @see elm_calendar_mark_add()
25529 * @ref calendar_example_06
25531 * @ingroup Calendar
25533 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
25536 * Remove all calendar's marks
25538 * @param obj The calendar object.
25540 * @see elm_calendar_mark_add()
25541 * @see elm_calendar_mark_del()
25543 * @ingroup Calendar
25545 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25549 * Get a list of all the calendar marks.
25551 * @param obj The calendar object.
25552 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
25554 * @see elm_calendar_mark_add()
25555 * @see elm_calendar_mark_del()
25556 * @see elm_calendar_marks_clear()
25558 * @ingroup Calendar
25560 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25563 * Draw calendar marks.
25565 * @param obj The calendar object.
25567 * Should be used after adding, removing or clearing marks.
25568 * It will go through the entire marks list updating the calendar.
25569 * If lots of marks will be added, add all the marks and then call
25572 * When the month is changed, i.e. user selects next or previous month,
25573 * marks will be drawed.
25575 * @see elm_calendar_mark_add()
25576 * @see elm_calendar_mark_del()
25577 * @see elm_calendar_marks_clear()
25579 * @ref calendar_example_06
25581 * @ingroup Calendar
25583 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
25586 * Set a day text color to the same that represents Saturdays.
25588 * @param obj The calendar object.
25589 * @param pos The text position. Position is the cell counter, from left
25590 * to right, up to down. It starts on 0 and ends on 41.
25592 * @deprecated use elm_calendar_mark_add() instead like:
25595 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
25596 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25599 * @see elm_calendar_mark_add()
25601 * @ingroup Calendar
25603 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25606 * Set a day text color to the same that represents Sundays.
25608 * @param obj The calendar object.
25609 * @param pos The text position. Position is the cell counter, from left
25610 * to right, up to down. It starts on 0 and ends on 41.
25612 * @deprecated use elm_calendar_mark_add() instead like:
25615 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
25616 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25619 * @see elm_calendar_mark_add()
25621 * @ingroup Calendar
25623 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25626 * Set a day text color to the same that represents Weekdays.
25628 * @param obj The calendar object
25629 * @param pos The text position. Position is the cell counter, from left
25630 * to right, up to down. It starts on 0 and ends on 41.
25632 * @deprecated use elm_calendar_mark_add() instead like:
25635 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
25637 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
25638 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25639 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
25640 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25641 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
25642 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25643 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
25644 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25645 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
25648 * @see elm_calendar_mark_add()
25650 * @ingroup Calendar
25652 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25655 * Set the interval on time updates for an user mouse button hold
25656 * on calendar widgets' month selection.
25658 * @param obj The calendar object
25659 * @param interval The (first) interval value in seconds
25661 * This interval value is @b decreased while the user holds the
25662 * mouse pointer either selecting next or previous month.
25664 * This helps the user to get to a given month distant from the
25665 * current one easier/faster, as it will start to change quicker and
25666 * quicker on mouse button holds.
25668 * The calculation for the next change interval value, starting from
25669 * the one set with this call, is the previous interval divided by
25670 * 1.05, so it decreases a little bit.
25672 * The default starting interval value for automatic changes is
25675 * @see elm_calendar_interval_get()
25677 * @ingroup Calendar
25679 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25682 * Get the interval on time updates for an user mouse button hold
25683 * on calendar widgets' month selection.
25685 * @param obj The calendar object
25686 * @return The (first) interval value, in seconds, set on it
25688 * @see elm_calendar_interval_set() for more details
25690 * @ingroup Calendar
25692 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25699 * @defgroup Diskselector Diskselector
25700 * @ingroup Elementary
25702 * @image html img/widget/diskselector/preview-00.png
25703 * @image latex img/widget/diskselector/preview-00.eps
25705 * A diskselector is a kind of list widget. It scrolls horizontally,
25706 * and can contain label and icon objects. Three items are displayed
25707 * with the selected one in the middle.
25709 * It can act like a circular list with round mode and labels can be
25710 * reduced for a defined length for side items.
25712 * Smart callbacks one can listen to:
25713 * - "selected" - when item is selected, i.e. scroller stops.
25715 * Available styles for it:
25718 * List of examples:
25719 * @li @ref diskselector_example_01
25720 * @li @ref diskselector_example_02
25724 * @addtogroup Diskselector
25728 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(). */
25731 * Add a new diskselector widget to the given parent Elementary
25732 * (container) object.
25734 * @param parent The parent object.
25735 * @return a new diskselector widget handle or @c NULL, on errors.
25737 * This function inserts a new diskselector widget on the canvas.
25739 * @ingroup Diskselector
25741 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25744 * Enable or disable round mode.
25746 * @param obj The diskselector object.
25747 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
25750 * Disabled by default. If round mode is enabled the items list will
25751 * work like a circle list, so when the user reaches the last item,
25752 * the first one will popup.
25754 * @see elm_diskselector_round_get()
25756 * @ingroup Diskselector
25758 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
25761 * Get a value whether round mode is enabled or not.
25763 * @see elm_diskselector_round_set() for details.
25765 * @param obj The diskselector object.
25766 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
25767 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25769 * @ingroup Diskselector
25771 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25774 * Get the side labels max length.
25776 * @deprecated use elm_diskselector_side_label_length_get() instead:
25778 * @param obj The diskselector object.
25779 * @return The max length defined for side labels, or 0 if not a valid
25782 * @ingroup Diskselector
25784 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25787 * Set the side labels max length.
25789 * @deprecated use elm_diskselector_side_label_length_set() instead:
25791 * @param obj The diskselector object.
25792 * @param len The max length defined for side labels.
25794 * @ingroup Diskselector
25796 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25799 * Get the side labels max length.
25801 * @see elm_diskselector_side_label_length_set() for details.
25803 * @param obj The diskselector object.
25804 * @return The max length defined for side labels, or 0 if not a valid
25807 * @ingroup Diskselector
25809 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25812 * Set the side labels max length.
25814 * @param obj The diskselector object.
25815 * @param len The max length defined for side labels.
25817 * Length is the number of characters of items' label that will be
25818 * visible when it's set on side positions. It will just crop
25819 * the string after defined size. E.g.:
25821 * An item with label "January" would be displayed on side position as
25822 * "Jan" if max length is set to 3, or "Janu", if this property
25825 * When it's selected, the entire label will be displayed, except for
25826 * width restrictions. In this case label will be cropped and "..."
25827 * will be concatenated.
25829 * Default side label max length is 3.
25831 * This property will be applyed over all items, included before or
25832 * later this function call.
25834 * @ingroup Diskselector
25836 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25839 * Set the number of items to be displayed.
25841 * @param obj The diskselector object.
25842 * @param num The number of items the diskselector will display.
25844 * Default value is 3, and also it's the minimun. If @p num is less
25845 * than 3, it will be set to 3.
25847 * Also, it can be set on theme, using data item @c display_item_num
25848 * on group "elm/diskselector/item/X", where X is style set.
25851 * group { name: "elm/diskselector/item/X";
25853 * item: "display_item_num" "5";
25856 * @ingroup Diskselector
25858 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
25861 * Get the number of items in the diskselector object.
25863 * @param obj The diskselector object.
25865 * @ingroup Diskselector
25867 EAPI int elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25870 * Set bouncing behaviour when the scrolled content reaches an edge.
25872 * Tell the internal scroller object whether it should bounce or not
25873 * when it reaches the respective edges for each axis.
25875 * @param obj The diskselector object.
25876 * @param h_bounce Whether to bounce or not in the horizontal axis.
25877 * @param v_bounce Whether to bounce or not in the vertical axis.
25879 * @see elm_scroller_bounce_set()
25881 * @ingroup Diskselector
25883 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
25886 * Get the bouncing behaviour of the internal scroller.
25888 * Get whether the internal scroller should bounce when the edge of each
25889 * axis is reached scrolling.
25891 * @param obj The diskselector object.
25892 * @param h_bounce Pointer where to store the bounce state of the horizontal
25894 * @param v_bounce Pointer where to store the bounce state of the vertical
25897 * @see elm_scroller_bounce_get()
25898 * @see elm_diskselector_bounce_set()
25900 * @ingroup Diskselector
25902 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
25905 * Get the scrollbar policy.
25907 * @see elm_diskselector_scroller_policy_get() for details.
25909 * @param obj The diskselector object.
25910 * @param policy_h Pointer where to store horizontal scrollbar policy.
25911 * @param policy_v Pointer where to store vertical scrollbar policy.
25913 * @ingroup Diskselector
25915 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);
25918 * Set the scrollbar policy.
25920 * @param obj The diskselector object.
25921 * @param policy_h Horizontal scrollbar policy.
25922 * @param policy_v Vertical scrollbar policy.
25924 * This sets the scrollbar visibility policy for the given scroller.
25925 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
25926 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
25927 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
25928 * This applies respectively for the horizontal and vertical scrollbars.
25930 * The both are disabled by default, i.e., are set to
25931 * #ELM_SCROLLER_POLICY_OFF.
25933 * @ingroup Diskselector
25935 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
25938 * Remove all diskselector's items.
25940 * @param obj The diskselector object.
25942 * @see elm_diskselector_item_del()
25943 * @see elm_diskselector_item_append()
25945 * @ingroup Diskselector
25947 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25950 * Get a list of all the diskselector items.
25952 * @param obj The diskselector object.
25953 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
25954 * or @c NULL on failure.
25956 * @see elm_diskselector_item_append()
25957 * @see elm_diskselector_item_del()
25958 * @see elm_diskselector_clear()
25960 * @ingroup Diskselector
25962 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25965 * Appends a new item to the diskselector object.
25967 * @param obj The diskselector object.
25968 * @param label The label of the diskselector item.
25969 * @param icon The icon object to use at left side of the item. An
25970 * icon can be any Evas object, but usually it is an icon created
25971 * with elm_icon_add().
25972 * @param func The function to call when the item is selected.
25973 * @param data The data to associate with the item for related callbacks.
25975 * @return The created item or @c NULL upon failure.
25977 * A new item will be created and appended to the diskselector, i.e., will
25978 * be set as last item. Also, if there is no selected item, it will
25979 * be selected. This will always happens for the first appended item.
25981 * If no icon is set, label will be centered on item position, otherwise
25982 * the icon will be placed at left of the label, that will be shifted
25985 * Items created with this method can be deleted with
25986 * elm_diskselector_item_del().
25988 * Associated @p data can be properly freed when item is deleted if a
25989 * callback function is set with elm_diskselector_item_del_cb_set().
25991 * If a function is passed as argument, it will be called everytime this item
25992 * is selected, i.e., the user stops the diskselector with this
25993 * item on center position. If such function isn't needed, just passing
25994 * @c NULL as @p func is enough. The same should be done for @p data.
25996 * Simple example (with no function callback or data associated):
25998 * disk = elm_diskselector_add(win);
25999 * ic = elm_icon_add(win);
26000 * elm_icon_file_set(ic, "path/to/image", NULL);
26001 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
26002 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
26005 * @see elm_diskselector_item_del()
26006 * @see elm_diskselector_item_del_cb_set()
26007 * @see elm_diskselector_clear()
26008 * @see elm_icon_add()
26010 * @ingroup Diskselector
26012 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);
26016 * Delete them item from the diskselector.
26018 * @param it The item of diskselector to be deleted.
26020 * If deleting all diskselector items is required, elm_diskselector_clear()
26021 * should be used instead of getting items list and deleting each one.
26023 * @see elm_diskselector_clear()
26024 * @see elm_diskselector_item_append()
26025 * @see elm_diskselector_item_del_cb_set()
26027 * @ingroup Diskselector
26029 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26032 * Set the function called when a diskselector item is freed.
26034 * @param it The item to set the callback on
26035 * @param func The function called
26037 * If there is a @p func, then it will be called prior item's memory release.
26038 * That will be called with the following arguments:
26040 * @li item's Evas object;
26043 * This way, a data associated to a diskselector item could be properly
26046 * @ingroup Diskselector
26048 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
26051 * Get the data associated to the item.
26053 * @param it The diskselector item
26054 * @return The data associated to @p it
26056 * The return value is a pointer to data associated to @p item when it was
26057 * created, with function elm_diskselector_item_append(). If no data
26058 * was passed as argument, it will return @c NULL.
26060 * @see elm_diskselector_item_append()
26062 * @ingroup Diskselector
26064 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26067 * Set the icon associated to the item.
26069 * @param it The diskselector item
26070 * @param icon The icon object to associate with @p it
26072 * The icon object to use at left side of the item. An
26073 * icon can be any Evas object, but usually it is an icon created
26074 * with elm_icon_add().
26076 * Once the icon object is set, a previously set one will be deleted.
26077 * @warning Setting the same icon for two items will cause the icon to
26078 * dissapear from the first item.
26080 * If an icon was passed as argument on item creation, with function
26081 * elm_diskselector_item_append(), it will be already
26082 * associated to the item.
26084 * @see elm_diskselector_item_append()
26085 * @see elm_diskselector_item_icon_get()
26087 * @ingroup Diskselector
26089 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
26092 * Get the icon associated to the item.
26094 * @param it The diskselector item
26095 * @return The icon associated to @p it
26097 * The return value is a pointer to the icon associated to @p item when it was
26098 * created, with function elm_diskselector_item_append(), or later
26099 * with function elm_diskselector_item_icon_set. If no icon
26100 * was passed as argument, it will return @c NULL.
26102 * @see elm_diskselector_item_append()
26103 * @see elm_diskselector_item_icon_set()
26105 * @ingroup Diskselector
26107 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26110 * Set the label of item.
26112 * @param it The item of diskselector.
26113 * @param label The label of item.
26115 * The label to be displayed by the item.
26117 * If no icon is set, label will be centered on item position, otherwise
26118 * the icon will be placed at left of the label, that will be shifted
26121 * An item with label "January" would be displayed on side position as
26122 * "Jan" if max length is set to 3 with function
26123 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
26126 * When this @p item is selected, the entire label will be displayed,
26127 * except for width restrictions.
26128 * In this case label will be cropped and "..." will be concatenated,
26129 * but only for display purposes. It will keep the entire string, so
26130 * if diskselector is resized the remaining characters will be displayed.
26132 * If a label was passed as argument on item creation, with function
26133 * elm_diskselector_item_append(), it will be already
26134 * displayed by the item.
26136 * @see elm_diskselector_side_label_lenght_set()
26137 * @see elm_diskselector_item_label_get()
26138 * @see elm_diskselector_item_append()
26140 * @ingroup Diskselector
26142 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
26145 * Get the label of item.
26147 * @param it The item of diskselector.
26148 * @return The label of item.
26150 * The return value is a pointer to the label associated to @p item when it was
26151 * created, with function elm_diskselector_item_append(), or later
26152 * with function elm_diskselector_item_label_set. If no label
26153 * was passed as argument, it will return @c NULL.
26155 * @see elm_diskselector_item_label_set() for more details.
26156 * @see elm_diskselector_item_append()
26158 * @ingroup Diskselector
26160 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26163 * Get the selected item.
26165 * @param obj The diskselector object.
26166 * @return The selected diskselector item.
26168 * The selected item can be unselected with function
26169 * elm_diskselector_item_selected_set(), and the first item of
26170 * diskselector will be selected.
26172 * The selected item always will be centered on diskselector, with
26173 * full label displayed, i.e., max lenght set to side labels won't
26174 * apply on the selected item. More details on
26175 * elm_diskselector_side_label_length_set().
26177 * @ingroup Diskselector
26179 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26182 * Set the selected state of an item.
26184 * @param it The diskselector item
26185 * @param selected The selected state
26187 * This sets the selected state of the given item @p it.
26188 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
26190 * If a new item is selected the previosly selected will be unselected.
26191 * Previoulsy selected item can be get with function
26192 * elm_diskselector_selected_item_get().
26194 * If the item @p it is unselected, the first item of diskselector will
26197 * Selected items will be visible on center position of diskselector.
26198 * So if it was on another position before selected, or was invisible,
26199 * diskselector will animate items until the selected item reaches center
26202 * @see elm_diskselector_item_selected_get()
26203 * @see elm_diskselector_selected_item_get()
26205 * @ingroup Diskselector
26207 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
26210 * Get whether the @p item is selected or not.
26212 * @param it The diskselector item.
26213 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
26214 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
26216 * @see elm_diskselector_selected_item_set() for details.
26217 * @see elm_diskselector_item_selected_get()
26219 * @ingroup Diskselector
26221 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26224 * Get the first item of the diskselector.
26226 * @param obj The diskselector object.
26227 * @return The first item, or @c NULL if none.
26229 * The list of items follows append order. So it will return the first
26230 * item appended to the widget that wasn't deleted.
26232 * @see elm_diskselector_item_append()
26233 * @see elm_diskselector_items_get()
26235 * @ingroup Diskselector
26237 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26240 * Get the last item of the diskselector.
26242 * @param obj The diskselector object.
26243 * @return The last item, or @c NULL if none.
26245 * The list of items follows append order. So it will return last first
26246 * item appended to the widget that wasn't deleted.
26248 * @see elm_diskselector_item_append()
26249 * @see elm_diskselector_items_get()
26251 * @ingroup Diskselector
26253 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26256 * Get the item before @p item in diskselector.
26258 * @param it The diskselector item.
26259 * @return The item before @p item, or @c NULL if none or on failure.
26261 * The list of items follows append order. So it will return item appended
26262 * just before @p item and that wasn't deleted.
26264 * If it is the first item, @c NULL will be returned.
26265 * First item can be get by elm_diskselector_first_item_get().
26267 * @see elm_diskselector_item_append()
26268 * @see elm_diskselector_items_get()
26270 * @ingroup Diskselector
26272 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26275 * Get the item after @p item in diskselector.
26277 * @param it The diskselector item.
26278 * @return The item after @p item, or @c NULL if none or on failure.
26280 * The list of items follows append order. So it will return item appended
26281 * just after @p item and that wasn't deleted.
26283 * If it is the last item, @c NULL will be returned.
26284 * Last item can be get by elm_diskselector_last_item_get().
26286 * @see elm_diskselector_item_append()
26287 * @see elm_diskselector_items_get()
26289 * @ingroup Diskselector
26291 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26294 * Set the text to be shown in the diskselector item.
26296 * @param item Target item
26297 * @param text The text to set in the content
26299 * Setup the text as tooltip to object. The item can have only one tooltip,
26300 * so any previous tooltip data is removed.
26302 * @see elm_object_tooltip_text_set() for more details.
26304 * @ingroup Diskselector
26306 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
26309 * Set the content to be shown in the tooltip item.
26311 * Setup the tooltip to item. The item can have only one tooltip,
26312 * so any previous tooltip data is removed. @p func(with @p data) will
26313 * be called every time that need show the tooltip and it should
26314 * return a valid Evas_Object. This object is then managed fully by
26315 * tooltip system and is deleted when the tooltip is gone.
26317 * @param item the diskselector item being attached a tooltip.
26318 * @param func the function used to create the tooltip contents.
26319 * @param data what to provide to @a func as callback data/context.
26320 * @param del_cb called when data is not needed anymore, either when
26321 * another callback replaces @p func, the tooltip is unset with
26322 * elm_diskselector_item_tooltip_unset() or the owner @a item
26323 * dies. This callback receives as the first parameter the
26324 * given @a data, and @c event_info is the item.
26326 * @see elm_object_tooltip_content_cb_set() for more details.
26328 * @ingroup Diskselector
26330 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);
26333 * Unset tooltip from item.
26335 * @param item diskselector item to remove previously set tooltip.
26337 * Remove tooltip from item. The callback provided as del_cb to
26338 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
26339 * it is not used anymore.
26341 * @see elm_object_tooltip_unset() for more details.
26342 * @see elm_diskselector_item_tooltip_content_cb_set()
26344 * @ingroup Diskselector
26346 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26350 * Sets a different style for this item tooltip.
26352 * @note before you set a style you should define a tooltip with
26353 * elm_diskselector_item_tooltip_content_cb_set() or
26354 * elm_diskselector_item_tooltip_text_set()
26356 * @param item diskselector item with tooltip already set.
26357 * @param style the theme style to use (default, transparent, ...)
26359 * @see elm_object_tooltip_style_set() for more details.
26361 * @ingroup Diskselector
26363 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26366 * Get the style for this item tooltip.
26368 * @param item diskselector item with tooltip already set.
26369 * @return style the theme style in use, defaults to "default". If the
26370 * object does not have a tooltip set, then NULL is returned.
26372 * @see elm_object_tooltip_style_get() for more details.
26373 * @see elm_diskselector_item_tooltip_style_set()
26375 * @ingroup Diskselector
26377 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26380 * Set the cursor to be shown when mouse is over the diskselector item
26382 * @param item Target item
26383 * @param cursor the cursor name to be used.
26385 * @see elm_object_cursor_set() for more details.
26387 * @ingroup Diskselector
26389 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
26392 * Get the cursor to be shown when mouse is over the diskselector item
26394 * @param item diskselector item with cursor already set.
26395 * @return the cursor name.
26397 * @see elm_object_cursor_get() for more details.
26398 * @see elm_diskselector_cursor_set()
26400 * @ingroup Diskselector
26402 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26406 * Unset the cursor to be shown when mouse is over the diskselector item
26408 * @param item Target item
26410 * @see elm_object_cursor_unset() for more details.
26411 * @see elm_diskselector_cursor_set()
26413 * @ingroup Diskselector
26415 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26418 * Sets a different style for this item cursor.
26420 * @note before you set a style you should define a cursor with
26421 * elm_diskselector_item_cursor_set()
26423 * @param item diskselector item with cursor already set.
26424 * @param style the theme style to use (default, transparent, ...)
26426 * @see elm_object_cursor_style_set() for more details.
26428 * @ingroup Diskselector
26430 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26434 * Get the style for this item cursor.
26436 * @param item diskselector item with cursor already set.
26437 * @return style the theme style in use, defaults to "default". If the
26438 * object does not have a cursor set, then @c NULL is returned.
26440 * @see elm_object_cursor_style_get() for more details.
26441 * @see elm_diskselector_item_cursor_style_set()
26443 * @ingroup Diskselector
26445 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26449 * Set if the cursor set should be searched on the theme or should use
26450 * the provided by the engine, only.
26452 * @note before you set if should look on theme you should define a cursor
26453 * with elm_diskselector_item_cursor_set().
26454 * By default it will only look for cursors provided by the engine.
26456 * @param item widget item with cursor already set.
26457 * @param engine_only boolean to define if cursors set with
26458 * elm_diskselector_item_cursor_set() should be searched only
26459 * between cursors provided by the engine or searched on widget's
26462 * @see elm_object_cursor_engine_only_set() for more details.
26464 * @ingroup Diskselector
26466 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
26469 * Get the cursor engine only usage for this item cursor.
26471 * @param item widget item with cursor already set.
26472 * @return engine_only boolean to define it cursors should be looked only
26473 * between the provided by the engine or searched on widget's theme as well.
26474 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
26476 * @see elm_object_cursor_engine_only_get() for more details.
26477 * @see elm_diskselector_item_cursor_engine_only_set()
26479 * @ingroup Diskselector
26481 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26488 * @defgroup Colorselector Colorselector
26492 * @image html img/widget/colorselector/preview-00.png
26493 * @image latex img/widget/colorselector/preview-00.eps
26495 * @brief Widget for user to select a color.
26497 * Signals that you can add callbacks for are:
26498 * "changed" - When the color value changes(event_info is NULL).
26500 * See @ref tutorial_colorselector.
26503 * @brief Add a new colorselector to the parent
26505 * @param parent The parent object
26506 * @return The new object or NULL if it cannot be created
26508 * @ingroup Colorselector
26510 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26512 * Set a color for the colorselector
26514 * @param obj Colorselector object
26515 * @param r r-value of color
26516 * @param g g-value of color
26517 * @param b b-value of color
26518 * @param a a-value of color
26520 * @ingroup Colorselector
26522 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
26524 * Get a color from the colorselector
26526 * @param obj Colorselector object
26527 * @param r integer pointer for r-value of color
26528 * @param g integer pointer for g-value of color
26529 * @param b integer pointer for b-value of color
26530 * @param a integer pointer for a-value of color
26532 * @ingroup Colorselector
26534 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
26540 * @defgroup Ctxpopup Ctxpopup
26542 * @image html img/widget/ctxpopup/preview-00.png
26543 * @image latex img/widget/ctxpopup/preview-00.eps
26545 * @brief Context popup widet.
26547 * A ctxpopup is a widget that, when shown, pops up a list of items.
26548 * It automatically chooses an area inside its parent object's view
26549 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
26550 * optimally fit into it. In the default theme, it will also point an
26551 * arrow to it's top left position at the time one shows it. Ctxpopup
26552 * items have a label and/or an icon. It is intended for a small
26553 * number of items (hence the use of list, not genlist).
26555 * @note Ctxpopup is a especialization of @ref Hover.
26557 * Signals that you can add callbacks for are:
26558 * "dismissed" - the ctxpopup was dismissed
26560 * Default contents parts of the ctxpopup widget that you can use for are:
26561 * @li "elm.swallow.content" - A content of the ctxpopup
26563 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
26566 typedef enum _Elm_Ctxpopup_Direction
26568 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
26570 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
26571 the clicked area */
26572 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
26573 the clicked area */
26574 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
26576 ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
26577 } Elm_Ctxpopup_Direction;
26580 * @brief Add a new Ctxpopup object to the parent.
26582 * @param parent Parent object
26583 * @return New object or @c NULL, if it cannot be created
26585 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26587 * @brief Set the Ctxpopup's parent
26589 * @param obj The ctxpopup object
26590 * @param area The parent to use
26592 * Set the parent object.
26594 * @note elm_ctxpopup_add() will automatically call this function
26595 * with its @c parent argument.
26597 * @see elm_ctxpopup_add()
26598 * @see elm_hover_parent_set()
26600 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
26602 * @brief Get the Ctxpopup's parent
26604 * @param obj The ctxpopup object
26606 * @see elm_ctxpopup_hover_parent_set() for more information
26608 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26610 * @brief Clear all items in the given ctxpopup object.
26612 * @param obj Ctxpopup object
26614 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26616 * @brief Change the ctxpopup's orientation to horizontal or vertical.
26618 * @param obj Ctxpopup object
26619 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
26621 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
26623 * @brief Get the value of current ctxpopup object's orientation.
26625 * @param obj Ctxpopup object
26626 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
26628 * @see elm_ctxpopup_horizontal_set()
26630 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26632 * @brief Add a new item to a ctxpopup object.
26634 * @param obj Ctxpopup object
26635 * @param icon Icon to be set on new item
26636 * @param label The Label of the new item
26637 * @param func Convenience function called when item selected
26638 * @param data Data passed to @p func
26639 * @return A handle to the item added or @c NULL, on errors
26641 * @warning Ctxpopup can't hold both an item list and a content at the same
26642 * time. When an item is added, any previous content will be removed.
26644 * @see elm_ctxpopup_content_set()
26646 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);
26648 * @brief Delete the given item in a ctxpopup object.
26650 * @param it Ctxpopup item to be deleted
26652 * @see elm_ctxpopup_item_append()
26654 EAPI void elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26656 * @brief Set the ctxpopup item's state as disabled or enabled.
26658 * @param it Ctxpopup item to be enabled/disabled
26659 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
26661 * When disabled the item is greyed out to indicate it's state.
26663 EAPI void elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
26665 * @brief Get the ctxpopup item's disabled/enabled state.
26667 * @param it Ctxpopup item to be enabled/disabled
26668 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
26670 * @see elm_ctxpopup_item_disabled_set()
26672 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26674 * @brief Get the icon object for the given ctxpopup item.
26676 * @param it Ctxpopup item
26677 * @return icon object or @c NULL, if the item does not have icon or an error
26680 * @see elm_ctxpopup_item_append()
26681 * @see elm_ctxpopup_item_icon_set()
26683 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26685 * @brief Sets the side icon associated with the ctxpopup item
26687 * @param it Ctxpopup item
26688 * @param icon Icon object to be set
26690 * Once the icon object is set, a previously set one will be deleted.
26691 * @warning Setting the same icon for two items will cause the icon to
26692 * dissapear from the first item.
26694 * @see elm_ctxpopup_item_append()
26696 EAPI void elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26698 * @brief Get the label for the given ctxpopup item.
26700 * @param it Ctxpopup item
26701 * @return label string or @c NULL, if the item does not have label or an
26704 * @see elm_ctxpopup_item_append()
26705 * @see elm_ctxpopup_item_label_set()
26707 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26709 * @brief (Re)set the label on the given ctxpopup item.
26711 * @param it Ctxpopup item
26712 * @param label String to set as label
26714 EAPI void elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26716 * @brief Set an elm widget as the content of the ctxpopup.
26718 * @param obj Ctxpopup object
26719 * @param content Content to be swallowed
26721 * If the content object is already set, a previous one will bedeleted. If
26722 * you want to keep that old content object, use the
26723 * elm_ctxpopup_content_unset() function.
26725 * @deprecated use elm_object_content_set()
26727 * @warning Ctxpopup can't hold both a item list and a content at the same
26728 * time. When a content is set, any previous items will be removed.
26731 * @deprecated use elm_object_content_set() instead
26734 EINA_DEPRECATED EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
26736 * @brief Unset the ctxpopup content
26738 * @param obj Ctxpopup object
26739 * @return The content that was being used
26741 * Unparent and return the content object which was set for this widget.
26743 * @deprecated use elm_object_content_unset()
26745 * @see elm_ctxpopup_content_set()
26747 * @deprecated use elm_object_content_unset() instead
26750 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
26752 * @brief Set the direction priority of a ctxpopup.
26754 * @param obj Ctxpopup object
26755 * @param first 1st priority of direction
26756 * @param second 2nd priority of direction
26757 * @param third 3th priority of direction
26758 * @param fourth 4th priority of direction
26760 * This functions gives a chance to user to set the priority of ctxpopup
26761 * showing direction. This doesn't guarantee the ctxpopup will appear in the
26762 * requested direction.
26764 * @see Elm_Ctxpopup_Direction
26766 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);
26768 * @brief Get the direction priority of a ctxpopup.
26770 * @param obj Ctxpopup object
26771 * @param first 1st priority of direction to be returned
26772 * @param second 2nd priority of direction to be returned
26773 * @param third 3th priority of direction to be returned
26774 * @param fourth 4th priority of direction to be returned
26776 * @see elm_ctxpopup_direction_priority_set() for more information.
26778 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);
26781 * @brief Get the current direction of a ctxpopup.
26783 * @param obj Ctxpopup object
26784 * @return current direction of a ctxpopup
26786 * @warning Once the ctxpopup showed up, the direction would be determined
26788 EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26797 * @defgroup Transit Transit
26798 * @ingroup Elementary
26800 * Transit is designed to apply various animated transition effects to @c
26801 * Evas_Object, such like translation, rotation, etc. For using these
26802 * effects, create an @ref Elm_Transit and add the desired transition effects.
26804 * Once the effects are added into transit, they will be automatically
26805 * managed (their callback will be called until the duration is ended, and
26806 * they will be deleted on completion).
26810 * Elm_Transit *trans = elm_transit_add();
26811 * elm_transit_object_add(trans, obj);
26812 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
26813 * elm_transit_duration_set(transit, 1);
26814 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
26815 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
26816 * elm_transit_repeat_times_set(transit, 3);
26819 * Some transition effects are used to change the properties of objects. They
26821 * @li @ref elm_transit_effect_translation_add
26822 * @li @ref elm_transit_effect_color_add
26823 * @li @ref elm_transit_effect_rotation_add
26824 * @li @ref elm_transit_effect_wipe_add
26825 * @li @ref elm_transit_effect_zoom_add
26826 * @li @ref elm_transit_effect_resizing_add
26828 * Other transition effects are used to make one object disappear and another
26829 * object appear on its old place. These effects are:
26831 * @li @ref elm_transit_effect_flip_add
26832 * @li @ref elm_transit_effect_resizable_flip_add
26833 * @li @ref elm_transit_effect_fade_add
26834 * @li @ref elm_transit_effect_blend_add
26836 * It's also possible to make a transition chain with @ref
26837 * elm_transit_chain_transit_add.
26839 * @warning We strongly recommend to use elm_transit just when edje can not do
26840 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
26841 * animations can be manipulated inside the theme.
26843 * List of examples:
26844 * @li @ref transit_example_01_explained
26845 * @li @ref transit_example_02_explained
26846 * @li @ref transit_example_03_c
26847 * @li @ref transit_example_04_c
26853 * @enum Elm_Transit_Tween_Mode
26855 * The type of acceleration used in the transition.
26859 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
26860 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
26861 over time, then decrease again
26863 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
26865 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
26867 } Elm_Transit_Tween_Mode;
26870 * @enum Elm_Transit_Effect_Flip_Axis
26872 * The axis where flip effect should be applied.
26876 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
26877 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
26878 } Elm_Transit_Effect_Flip_Axis;
26880 * @enum Elm_Transit_Effect_Wipe_Dir
26882 * The direction where the wipe effect should occur.
26886 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
26887 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
26888 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
26889 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
26890 } Elm_Transit_Effect_Wipe_Dir;
26891 /** @enum Elm_Transit_Effect_Wipe_Type
26893 * Whether the wipe effect should show or hide the object.
26897 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
26899 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
26901 } Elm_Transit_Effect_Wipe_Type;
26904 * @typedef Elm_Transit
26906 * The Transit created with elm_transit_add(). This type has the information
26907 * about the objects which the transition will be applied, and the
26908 * transition effects that will be used. It also contains info about
26909 * duration, number of repetitions, auto-reverse, etc.
26911 typedef struct _Elm_Transit Elm_Transit;
26912 typedef void Elm_Transit_Effect;
26914 * @typedef Elm_Transit_Effect_Transition_Cb
26916 * Transition callback called for this effect on each transition iteration.
26918 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
26920 * Elm_Transit_Effect_End_Cb
26922 * Transition callback called for this effect when the transition is over.
26924 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
26927 * Elm_Transit_Del_Cb
26929 * A callback called when the transit is deleted.
26931 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
26936 * @note Is not necessary to delete the transit object, it will be deleted at
26937 * the end of its operation.
26938 * @note The transit will start playing when the program enter in the main loop, is not
26939 * necessary to give a start to the transit.
26941 * @return The transit object.
26945 EAPI Elm_Transit *elm_transit_add(void);
26948 * Stops the animation and delete the @p transit object.
26950 * Call this function if you wants to stop the animation before the duration
26951 * time. Make sure the @p transit object is still alive with
26952 * elm_transit_del_cb_set() function.
26953 * All added effects will be deleted, calling its repective data_free_cb
26954 * functions. The function setted by elm_transit_del_cb_set() will be called.
26956 * @see elm_transit_del_cb_set()
26958 * @param transit The transit object to be deleted.
26961 * @warning Just call this function if you are sure the transit is alive.
26963 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
26966 * Add a new effect to the transit.
26968 * @note The cb function and the data are the key to the effect. If you try to
26969 * add an already added effect, nothing is done.
26970 * @note After the first addition of an effect in @p transit, if its
26971 * effect list become empty again, the @p transit will be killed by
26972 * elm_transit_del(transit) function.
26976 * Elm_Transit *transit = elm_transit_add();
26977 * elm_transit_effect_add(transit,
26978 * elm_transit_effect_blend_op,
26979 * elm_transit_effect_blend_context_new(),
26980 * elm_transit_effect_blend_context_free);
26983 * @param transit The transit object.
26984 * @param transition_cb The operation function. It is called when the
26985 * animation begins, it is the function that actually performs the animation.
26986 * It is called with the @p data, @p transit and the time progression of the
26987 * animation (a double value between 0.0 and 1.0).
26988 * @param effect The context data of the effect.
26989 * @param end_cb The function to free the context data, it will be called
26990 * at the end of the effect, it must finalize the animation and free the
26994 * @warning The transit free the context data at the and of the transition with
26995 * the data_free_cb function, do not use the context data in another transit.
26997 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);
27000 * Delete an added effect.
27002 * This function will remove the effect from the @p transit, calling the
27003 * data_free_cb to free the @p data.
27005 * @see elm_transit_effect_add()
27007 * @note If the effect is not found, nothing is done.
27008 * @note If the effect list become empty, this function will call
27009 * elm_transit_del(transit), that is, it will kill the @p transit.
27011 * @param transit The transit object.
27012 * @param transition_cb The operation function.
27013 * @param effect The context data of the effect.
27017 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);
27020 * Add new object to apply the effects.
27022 * @note After the first addition of an object in @p transit, if its
27023 * object list become empty again, the @p transit will be killed by
27024 * elm_transit_del(transit) function.
27025 * @note If the @p obj belongs to another transit, the @p obj will be
27026 * removed from it and it will only belong to the @p transit. If the old
27027 * transit stays without objects, it will die.
27028 * @note When you add an object into the @p transit, its state from
27029 * evas_object_pass_events_get(obj) is saved, and it is applied when the
27030 * transit ends, if you change this state whith evas_object_pass_events_set()
27031 * after add the object, this state will change again when @p transit stops to
27034 * @param transit The transit object.
27035 * @param obj Object to be animated.
27038 * @warning It is not allowed to add a new object after transit begins to go.
27040 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
27043 * Removes an added object from the transit.
27045 * @note If the @p obj is not in the @p transit, nothing is done.
27046 * @note If the list become empty, this function will call
27047 * elm_transit_del(transit), that is, it will kill the @p transit.
27049 * @param transit The transit object.
27050 * @param obj Object to be removed from @p transit.
27053 * @warning It is not allowed to remove objects after transit begins to go.
27055 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
27058 * Get the objects of the transit.
27060 * @param transit The transit object.
27061 * @return a Eina_List with the objects from the transit.
27065 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27068 * Enable/disable keeping up the objects states.
27069 * If it is not kept, the objects states will be reset when transition ends.
27071 * @note @p transit can not be NULL.
27072 * @note One state includes geometry, color, map data.
27074 * @param transit The transit object.
27075 * @param state_keep Keeping or Non Keeping.
27079 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
27082 * Get a value whether the objects states will be reset or not.
27084 * @note @p transit can not be NULL
27086 * @see elm_transit_objects_final_state_keep_set()
27088 * @param transit The transit object.
27089 * @return EINA_TRUE means the states of the objects will be reset.
27090 * If @p transit is NULL, EINA_FALSE is returned
27094 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27097 * Set the event enabled when transit is operating.
27099 * If @p enabled is EINA_TRUE, the objects of the transit will receives
27100 * events from mouse and keyboard during the animation.
27101 * @note When you add an object with elm_transit_object_add(), its state from
27102 * evas_object_pass_events_get(obj) is saved, and it is applied when the
27103 * transit ends, if you change this state with evas_object_pass_events_set()
27104 * after adding the object, this state will change again when @p transit stops
27107 * @param transit The transit object.
27108 * @param enabled Events are received when enabled is @c EINA_TRUE, and
27109 * ignored otherwise.
27113 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
27116 * Get the value of event enabled status.
27118 * @see elm_transit_event_enabled_set()
27120 * @param transit The Transit object
27121 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
27122 * EINA_FALSE is returned
27126 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27129 * Set the user-callback function when the transit is deleted.
27131 * @note Using this function twice will overwrite the first function setted.
27132 * @note the @p transit object will be deleted after call @p cb function.
27134 * @param transit The transit object.
27135 * @param cb Callback function pointer. This function will be called before
27136 * the deletion of the transit.
27137 * @param data Callback funtion user data. It is the @p op parameter.
27141 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
27144 * Set reverse effect automatically.
27146 * If auto reverse is setted, after running the effects with the progress
27147 * parameter from 0 to 1, it will call the effecs again with the progress
27148 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
27149 * where the duration was setted with the function elm_transit_add and
27150 * the repeat with the function elm_transit_repeat_times_set().
27152 * @param transit The transit object.
27153 * @param reverse EINA_TRUE means the auto_reverse is on.
27157 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
27160 * Get if the auto reverse is on.
27162 * @see elm_transit_auto_reverse_set()
27164 * @param transit The transit object.
27165 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
27166 * EINA_FALSE is returned
27170 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27173 * Set the transit repeat count. Effect will be repeated by repeat count.
27175 * This function sets the number of repetition the transit will run after
27176 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
27177 * If the @p repeat is a negative number, it will repeat infinite times.
27179 * @note If this function is called during the transit execution, the transit
27180 * will run @p repeat times, ignoring the times it already performed.
27182 * @param transit The transit object
27183 * @param repeat Repeat count
27187 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
27190 * Get the transit repeat count.
27192 * @see elm_transit_repeat_times_set()
27194 * @param transit The Transit object.
27195 * @return The repeat count. If @p transit is NULL
27200 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27203 * Set the transit animation acceleration type.
27205 * This function sets the tween mode of the transit that can be:
27206 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
27207 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
27208 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
27209 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
27211 * @param transit The transit object.
27212 * @param tween_mode The tween type.
27216 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
27219 * Get the transit animation acceleration type.
27221 * @note @p transit can not be NULL
27223 * @param transit The transit object.
27224 * @return The tween type. If @p transit is NULL
27225 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
27229 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27232 * Set the transit animation time
27234 * @note @p transit can not be NULL
27236 * @param transit The transit object.
27237 * @param duration The animation time.
27241 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
27244 * Get the transit animation time
27246 * @note @p transit can not be NULL
27248 * @param transit The transit object.
27250 * @return The transit animation time.
27254 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27257 * Starts the transition.
27258 * Once this API is called, the transit begins to measure the time.
27260 * @note @p transit can not be NULL
27262 * @param transit The transit object.
27266 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27269 * Pause/Resume the transition.
27271 * If you call elm_transit_go again, the transit will be started from the
27272 * beginning, and will be unpaused.
27274 * @note @p transit can not be NULL
27276 * @param transit The transit object.
27277 * @param paused Whether the transition should be paused or not.
27281 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
27284 * Get the value of paused status.
27286 * @see elm_transit_paused_set()
27288 * @note @p transit can not be NULL
27290 * @param transit The transit object.
27291 * @return EINA_TRUE means transition is paused. If @p transit is NULL
27292 * EINA_FALSE is returned
27296 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27299 * Get the time progression of the animation (a double value between 0.0 and 1.0).
27301 * The value returned is a fraction (current time / total time). It
27302 * represents the progression position relative to the total.
27304 * @note @p transit can not be NULL
27306 * @param transit The transit object.
27308 * @return The time progression value. If @p transit is NULL
27313 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27316 * Makes the chain relationship between two transits.
27318 * @note @p transit can not be NULL. Transit would have multiple chain transits.
27319 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
27321 * @param transit The transit object.
27322 * @param chain_transit The chain transit object. This transit will be operated
27323 * after transit is done.
27325 * This function adds @p chain_transit transition to a chain after the @p
27326 * transit, and will be started as soon as @p transit ends. See @ref
27327 * transit_example_02_explained for a full example.
27331 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
27334 * Cut off the chain relationship between two transits.
27336 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
27337 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
27339 * @param transit The transit object.
27340 * @param chain_transit The chain transit object.
27342 * This function remove the @p chain_transit transition from the @p transit.
27346 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
27349 * Get the current chain transit list.
27351 * @note @p transit can not be NULL.
27353 * @param transit The transit object.
27354 * @return chain transit list.
27358 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
27361 * Add the Resizing Effect to Elm_Transit.
27363 * @note This API is one of the facades. It creates resizing effect context
27364 * and add it's required APIs to elm_transit_effect_add.
27366 * @see elm_transit_effect_add()
27368 * @param transit Transit object.
27369 * @param from_w Object width size when effect begins.
27370 * @param from_h Object height size when effect begins.
27371 * @param to_w Object width size when effect ends.
27372 * @param to_h Object height size when effect ends.
27373 * @return Resizing effect context data.
27377 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);
27380 * Add the Translation Effect to Elm_Transit.
27382 * @note This API is one of the facades. It creates translation effect context
27383 * and add it's required APIs to elm_transit_effect_add.
27385 * @see elm_transit_effect_add()
27387 * @param transit Transit object.
27388 * @param from_dx X Position variation when effect begins.
27389 * @param from_dy Y Position variation when effect begins.
27390 * @param to_dx X Position variation when effect ends.
27391 * @param to_dy Y Position variation when effect ends.
27392 * @return Translation effect context data.
27395 * @warning It is highly recommended just create a transit with this effect when
27396 * the window that the objects of the transit belongs has already been created.
27397 * This is because this effect needs the geometry information about the objects,
27398 * and if the window was not created yet, it can get a wrong information.
27400 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);
27403 * Add the Zoom Effect to Elm_Transit.
27405 * @note This API is one of the facades. It creates zoom effect context
27406 * and add it's required APIs to elm_transit_effect_add.
27408 * @see elm_transit_effect_add()
27410 * @param transit Transit object.
27411 * @param from_rate Scale rate when effect begins (1 is current rate).
27412 * @param to_rate Scale rate when effect ends.
27413 * @return Zoom effect context data.
27416 * @warning It is highly recommended just create a transit with this effect when
27417 * the window that the objects of the transit belongs has already been created.
27418 * This is because this effect needs the geometry information about the objects,
27419 * and if the window was not created yet, it can get a wrong information.
27421 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
27424 * Add the Flip Effect to Elm_Transit.
27426 * @note This API is one of the facades. It creates flip effect context
27427 * and add it's required APIs to elm_transit_effect_add.
27428 * @note This effect is applied to each pair of objects in the order they are listed
27429 * in the transit list of objects. The first object in the pair will be the
27430 * "front" object and the second will be the "back" object.
27432 * @see elm_transit_effect_add()
27434 * @param transit Transit object.
27435 * @param axis Flipping Axis(X or Y).
27436 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27437 * @return Flip effect context data.
27440 * @warning It is highly recommended just create a transit with this effect when
27441 * the window that the objects of the transit belongs has already been created.
27442 * This is because this effect needs the geometry information about the objects,
27443 * and if the window was not created yet, it can get a wrong information.
27445 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27448 * Add the Resizable Flip Effect to Elm_Transit.
27450 * @note This API is one of the facades. It creates resizable flip effect context
27451 * and add it's required APIs to elm_transit_effect_add.
27452 * @note This effect is applied to each pair of objects in the order they are listed
27453 * in the transit list of objects. The first object in the pair will be the
27454 * "front" object and the second will be the "back" object.
27456 * @see elm_transit_effect_add()
27458 * @param transit Transit object.
27459 * @param axis Flipping Axis(X or Y).
27460 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27461 * @return Resizable flip effect context data.
27464 * @warning It is highly recommended just create a transit with this effect when
27465 * the window that the objects of the transit belongs has already been created.
27466 * This is because this effect needs the geometry information about the objects,
27467 * and if the window was not created yet, it can get a wrong information.
27469 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27472 * Add the Wipe Effect to Elm_Transit.
27474 * @note This API is one of the facades. It creates wipe effect context
27475 * and add it's required APIs to elm_transit_effect_add.
27477 * @see elm_transit_effect_add()
27479 * @param transit Transit object.
27480 * @param type Wipe type. Hide or show.
27481 * @param dir Wipe Direction.
27482 * @return Wipe effect context data.
27485 * @warning It is highly recommended just create a transit with this effect when
27486 * the window that the objects of the transit belongs has already been created.
27487 * This is because this effect needs the geometry information about the objects,
27488 * and if the window was not created yet, it can get a wrong information.
27490 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
27493 * Add the Color Effect to Elm_Transit.
27495 * @note This API is one of the facades. It creates color effect context
27496 * and add it's required APIs to elm_transit_effect_add.
27498 * @see elm_transit_effect_add()
27500 * @param transit Transit object.
27501 * @param from_r RGB R when effect begins.
27502 * @param from_g RGB G when effect begins.
27503 * @param from_b RGB B when effect begins.
27504 * @param from_a RGB A when effect begins.
27505 * @param to_r RGB R when effect ends.
27506 * @param to_g RGB G when effect ends.
27507 * @param to_b RGB B when effect ends.
27508 * @param to_a RGB A when effect ends.
27509 * @return Color effect context data.
27513 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);
27516 * Add the Fade Effect to Elm_Transit.
27518 * @note This API is one of the facades. It creates fade effect context
27519 * and add it's required APIs to elm_transit_effect_add.
27520 * @note This effect is applied to each pair of objects in the order they are listed
27521 * in the transit list of objects. The first object in the pair will be the
27522 * "before" object and the second will be the "after" object.
27524 * @see elm_transit_effect_add()
27526 * @param transit Transit object.
27527 * @return Fade effect context data.
27530 * @warning It is highly recommended just create a transit with this effect when
27531 * the window that the objects of the transit belongs has already been created.
27532 * This is because this effect needs the color information about the objects,
27533 * and if the window was not created yet, it can get a wrong information.
27535 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
27538 * Add the Blend Effect to Elm_Transit.
27540 * @note This API is one of the facades. It creates blend effect context
27541 * and add it's required APIs to elm_transit_effect_add.
27542 * @note This effect is applied to each pair of objects in the order they are listed
27543 * in the transit list of objects. The first object in the pair will be the
27544 * "before" object and the second will be the "after" object.
27546 * @see elm_transit_effect_add()
27548 * @param transit Transit object.
27549 * @return Blend effect context data.
27552 * @warning It is highly recommended just create a transit with this effect when
27553 * the window that the objects of the transit belongs has already been created.
27554 * This is because this effect needs the color information about the objects,
27555 * and if the window was not created yet, it can get a wrong information.
27557 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
27560 * Add the Rotation Effect to Elm_Transit.
27562 * @note This API is one of the facades. It creates rotation effect context
27563 * and add it's required APIs to elm_transit_effect_add.
27565 * @see elm_transit_effect_add()
27567 * @param transit Transit object.
27568 * @param from_degree Degree when effect begins.
27569 * @param to_degree Degree when effect is ends.
27570 * @return Rotation effect context data.
27573 * @warning It is highly recommended just create a transit with this effect when
27574 * the window that the objects of the transit belongs has already been created.
27575 * This is because this effect needs the geometry information about the objects,
27576 * and if the window was not created yet, it can get a wrong information.
27578 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
27581 * Add the ImageAnimation Effect to Elm_Transit.
27583 * @note This API is one of the facades. It creates image animation effect context
27584 * and add it's required APIs to elm_transit_effect_add.
27585 * The @p images parameter is a list images paths. This list and
27586 * its contents will be deleted at the end of the effect by
27587 * elm_transit_effect_image_animation_context_free() function.
27591 * char buf[PATH_MAX];
27592 * Eina_List *images = NULL;
27593 * Elm_Transit *transi = elm_transit_add();
27595 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
27596 * images = eina_list_append(images, eina_stringshare_add(buf));
27598 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
27599 * images = eina_list_append(images, eina_stringshare_add(buf));
27600 * elm_transit_effect_image_animation_add(transi, images);
27604 * @see elm_transit_effect_add()
27606 * @param transit Transit object.
27607 * @param images Eina_List of images file paths. This list and
27608 * its contents will be deleted at the end of the effect by
27609 * elm_transit_effect_image_animation_context_free() function.
27610 * @return Image Animation effect context data.
27614 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
27619 typedef struct _Elm_Store Elm_Store;
27620 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
27621 typedef struct _Elm_Store_Item Elm_Store_Item;
27622 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
27623 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
27624 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
27625 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
27626 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
27627 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
27628 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
27629 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
27631 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
27632 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
27633 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
27634 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
27638 ELM_STORE_ITEM_MAPPING_NONE = 0,
27639 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
27640 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
27641 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
27642 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
27643 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
27644 // can add more here as needed by common apps
27645 ELM_STORE_ITEM_MAPPING_LAST
27646 } Elm_Store_Item_Mapping_Type;
27648 struct _Elm_Store_Item_Mapping_Icon
27650 // FIXME: allow edje file icons
27652 Elm_Icon_Lookup_Order lookup_order;
27653 Eina_Bool standard_name : 1;
27654 Eina_Bool no_scale : 1;
27655 Eina_Bool smooth : 1;
27656 Eina_Bool scale_up : 1;
27657 Eina_Bool scale_down : 1;
27660 struct _Elm_Store_Item_Mapping_Empty
27665 struct _Elm_Store_Item_Mapping_Photo
27670 struct _Elm_Store_Item_Mapping_Custom
27672 Elm_Store_Item_Mapping_Cb func;
27675 struct _Elm_Store_Item_Mapping
27677 Elm_Store_Item_Mapping_Type type;
27682 Elm_Store_Item_Mapping_Empty empty;
27683 Elm_Store_Item_Mapping_Icon icon;
27684 Elm_Store_Item_Mapping_Photo photo;
27685 Elm_Store_Item_Mapping_Custom custom;
27686 // add more types here
27690 struct _Elm_Store_Item_Info
27692 Elm_Genlist_Item_Class *item_class;
27693 const Elm_Store_Item_Mapping *mapping;
27698 struct _Elm_Store_Item_Info_Filesystem
27700 Elm_Store_Item_Info base;
27704 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
27705 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
27707 EAPI void elm_store_free(Elm_Store *st);
27709 EAPI Elm_Store *elm_store_filesystem_new(void);
27710 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
27711 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27712 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27714 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
27716 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
27717 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27718 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27719 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27720 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
27721 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27723 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27724 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
27725 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27726 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
27727 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27728 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27729 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27732 * @defgroup SegmentControl SegmentControl
27733 * @ingroup Elementary
27735 * @image html img/widget/segment_control/preview-00.png
27736 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
27738 * @image html img/segment_control.png
27739 * @image latex img/segment_control.eps width=\textwidth
27741 * Segment control widget is a horizontal control made of multiple segment
27742 * items, each segment item functioning similar to discrete two state button.
27743 * A segment control groups the items together and provides compact
27744 * single button with multiple equal size segments.
27746 * Segment item size is determined by base widget
27747 * size and the number of items added.
27748 * Only one segment item can be at selected state. A segment item can display
27749 * combination of Text and any Evas_Object like Images or other widget.
27751 * Smart callbacks one can listen to:
27752 * - "changed" - When the user clicks on a segment item which is not
27753 * previously selected and get selected. The event_info parameter is the
27754 * segment item pointer.
27756 * Available styles for it:
27759 * Here is an example on its usage:
27760 * @li @ref segment_control_example
27764 * @addtogroup SegmentControl
27768 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
27771 * Add a new segment control widget to the given parent Elementary
27772 * (container) object.
27774 * @param parent The parent object.
27775 * @return a new segment control widget handle or @c NULL, on errors.
27777 * This function inserts a new segment control widget on the canvas.
27779 * @ingroup SegmentControl
27781 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27784 * Append a new item to the segment control object.
27786 * @param obj The segment control object.
27787 * @param icon The icon object to use for the left side of the item. An
27788 * icon can be any Evas object, but usually it is an icon created
27789 * with elm_icon_add().
27790 * @param label The label of the item.
27791 * Note that, NULL is different from empty string "".
27792 * @return The created item or @c NULL upon failure.
27794 * A new item will be created and appended to the segment control, i.e., will
27795 * be set as @b last item.
27797 * If it should be inserted at another position,
27798 * elm_segment_control_item_insert_at() should be used instead.
27800 * Items created with this function can be deleted with function
27801 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27803 * @note @p label set to @c NULL is different from empty string "".
27805 * only has icon, it will be displayed bigger and centered. If it has
27806 * icon and label, even that an empty string, icon will be smaller and
27807 * positioned at left.
27811 * sc = elm_segment_control_add(win);
27812 * ic = elm_icon_add(win);
27813 * elm_icon_file_set(ic, "path/to/image", NULL);
27814 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
27815 * elm_segment_control_item_add(sc, ic, "label");
27816 * evas_object_show(sc);
27819 * @see elm_segment_control_item_insert_at()
27820 * @see elm_segment_control_item_del()
27822 * @ingroup SegmentControl
27824 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
27827 * Insert a new item to the segment control object at specified position.
27829 * @param obj The segment control object.
27830 * @param icon The icon object to use for the left side of the item. An
27831 * icon can be any Evas object, but usually it is an icon created
27832 * with elm_icon_add().
27833 * @param label The label of the item.
27834 * @param index Item position. Value should be between 0 and items count.
27835 * @return The created item or @c NULL upon failure.
27837 * Index values must be between @c 0, when item will be prepended to
27838 * segment control, and items count, that can be get with
27839 * elm_segment_control_item_count_get(), case when item will be appended
27840 * to segment control, just like elm_segment_control_item_add().
27842 * Items created with this function can be deleted with function
27843 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27845 * @note @p label set to @c NULL is different from empty string "".
27847 * only has icon, it will be displayed bigger and centered. If it has
27848 * icon and label, even that an empty string, icon will be smaller and
27849 * positioned at left.
27851 * @see elm_segment_control_item_add()
27852 * @see elm_segment_control_item_count_get()
27853 * @see elm_segment_control_item_del()
27855 * @ingroup SegmentControl
27857 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);
27860 * Remove a segment control item from its parent, deleting it.
27862 * @param it The item to be removed.
27864 * Items can be added with elm_segment_control_item_add() or
27865 * elm_segment_control_item_insert_at().
27867 * @ingroup SegmentControl
27869 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27872 * Remove a segment control item at given index from its parent,
27875 * @param obj The segment control object.
27876 * @param index The position of the segment control item to be deleted.
27878 * Items can be added with elm_segment_control_item_add() or
27879 * elm_segment_control_item_insert_at().
27881 * @ingroup SegmentControl
27883 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27886 * Get the Segment items count from segment control.
27888 * @param obj The segment control object.
27889 * @return Segment items count.
27891 * It will just return the number of items added to segment control @p obj.
27893 * @ingroup SegmentControl
27895 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27898 * Get the item placed at specified index.
27900 * @param obj The segment control object.
27901 * @param index The index of the segment item.
27902 * @return The segment control item or @c NULL on failure.
27904 * Index is the position of an item in segment control widget. Its
27905 * range is from @c 0 to <tt> count - 1 </tt>.
27906 * Count is the number of items, that can be get with
27907 * elm_segment_control_item_count_get().
27909 * @ingroup SegmentControl
27911 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27914 * Get the label of item.
27916 * @param obj The segment control object.
27917 * @param index The index of the segment item.
27918 * @return The label of the item at @p index.
27920 * The return value is a pointer to the label associated to the item when
27921 * it was created, with function elm_segment_control_item_add(), or later
27922 * with function elm_segment_control_item_label_set. If no label
27923 * was passed as argument, it will return @c NULL.
27925 * @see elm_segment_control_item_label_set() for more details.
27926 * @see elm_segment_control_item_add()
27928 * @ingroup SegmentControl
27930 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27933 * Set the label of item.
27935 * @param it The item of segment control.
27936 * @param text The label of item.
27938 * The label to be displayed by the item.
27939 * Label will be at right of the icon (if set).
27941 * If a label was passed as argument on item creation, with function
27942 * elm_control_segment_item_add(), it will be already
27943 * displayed by the item.
27945 * @see elm_segment_control_item_label_get()
27946 * @see elm_segment_control_item_add()
27948 * @ingroup SegmentControl
27950 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
27953 * Get the icon associated to the item.
27955 * @param obj The segment control object.
27956 * @param index The index of the segment item.
27957 * @return The left side icon associated to the item at @p index.
27959 * The return value is a pointer to the icon associated to the item when
27960 * it was created, with function elm_segment_control_item_add(), or later
27961 * with function elm_segment_control_item_icon_set(). If no icon
27962 * was passed as argument, it will return @c NULL.
27964 * @see elm_segment_control_item_add()
27965 * @see elm_segment_control_item_icon_set()
27967 * @ingroup SegmentControl
27969 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27972 * Set the icon associated to the item.
27974 * @param it The segment control item.
27975 * @param icon The icon object to associate with @p it.
27977 * The icon object to use at left side of the item. An
27978 * icon can be any Evas object, but usually it is an icon created
27979 * with elm_icon_add().
27981 * Once the icon object is set, a previously set one will be deleted.
27982 * @warning Setting the same icon for two items will cause the icon to
27983 * dissapear from the first item.
27985 * If an icon was passed as argument on item creation, with function
27986 * elm_segment_control_item_add(), it will be already
27987 * associated to the item.
27989 * @see elm_segment_control_item_add()
27990 * @see elm_segment_control_item_icon_get()
27992 * @ingroup SegmentControl
27994 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
27997 * Get the index of an item.
27999 * @param it The segment control item.
28000 * @return The position of item in segment control widget.
28002 * Index is the position of an item in segment control widget. Its
28003 * range is from @c 0 to <tt> count - 1 </tt>.
28004 * Count is the number of items, that can be get with
28005 * elm_segment_control_item_count_get().
28007 * @ingroup SegmentControl
28009 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28012 * Get the base object of the item.
28014 * @param it The segment control item.
28015 * @return The base object associated with @p it.
28017 * Base object is the @c Evas_Object that represents that item.
28019 * @ingroup SegmentControl
28021 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28024 * Get the selected item.
28026 * @param obj The segment control object.
28027 * @return The selected item or @c NULL if none of segment items is
28030 * The selected item can be unselected with function
28031 * elm_segment_control_item_selected_set().
28033 * The selected item always will be highlighted on segment control.
28035 * @ingroup SegmentControl
28037 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28040 * Set the selected state of an item.
28042 * @param it The segment control item
28043 * @param select The selected state
28045 * This sets the selected state of the given item @p it.
28046 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
28048 * If a new item is selected the previosly selected will be unselected.
28049 * Previoulsy selected item can be get with function
28050 * elm_segment_control_item_selected_get().
28052 * The selected item always will be highlighted on segment control.
28054 * @see elm_segment_control_item_selected_get()
28056 * @ingroup SegmentControl
28058 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
28065 * @defgroup Grid Grid
28067 * The grid is a grid layout widget that lays out a series of children as a
28068 * fixed "grid" of widgets using a given percentage of the grid width and
28069 * height each using the child object.
28071 * The Grid uses a "Virtual resolution" that is stretched to fill the grid
28072 * widgets size itself. The default is 100 x 100, so that means the
28073 * position and sizes of children will effectively be percentages (0 to 100)
28074 * of the width or height of the grid widget
28080 * Add a new grid to the parent
28082 * @param parent The parent object
28083 * @return The new object or NULL if it cannot be created
28087 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
28090 * Set the virtual size of the grid
28092 * @param obj The grid object
28093 * @param w The virtual width of the grid
28094 * @param h The virtual height of the grid
28098 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
28101 * Get the virtual size of the grid
28103 * @param obj The grid object
28104 * @param w Pointer to integer to store the virtual width of the grid
28105 * @param h Pointer to integer to store the virtual height of the grid
28109 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
28112 * Pack child at given position and size
28114 * @param obj The grid object
28115 * @param subobj The child to pack
28116 * @param x The virtual x coord at which to pack it
28117 * @param y The virtual y coord at which to pack it
28118 * @param w The virtual width at which to pack it
28119 * @param h The virtual height at which to pack it
28123 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
28126 * Unpack a child from a grid object
28128 * @param obj The grid object
28129 * @param subobj The child to unpack
28133 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
28136 * Faster way to remove all child objects from a grid object.
28138 * @param obj The grid object
28139 * @param clear If true, it will delete just removed children
28143 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
28146 * Set packing of an existing child at to position and size
28148 * @param subobj The child to set packing of
28149 * @param x The virtual x coord at which to pack it
28150 * @param y The virtual y coord at which to pack it
28151 * @param w The virtual width at which to pack it
28152 * @param h The virtual height at which to pack it
28156 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
28159 * get packing of a child
28161 * @param subobj The child to query
28162 * @param x Pointer to integer to store the virtual x coord
28163 * @param y Pointer to integer to store the virtual y coord
28164 * @param w Pointer to integer to store the virtual width
28165 * @param h Pointer to integer to store the virtual height
28169 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
28175 EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
28176 EINA_DEPRECATED EAPI void elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
28177 EINA_DEPRECATED EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
28178 EAPI void elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
28179 EAPI Eina_Bool elm_factory_maxmin_mode_get(const Evas_Object *obj);
28180 EAPI void elm_factory_maxmin_reset_set(Evas_Object *obj);
28183 * @defgroup Video Video
28185 * @addtogroup Video
28188 * Elementary comes with two object that help design application that need
28189 * to display video. The main one, Elm_Video, display a video by using Emotion.
28190 * It does embedded the video inside an Edje object, so you can do some
28191 * animation depending on the video state change. It does also implement a
28192 * ressource management policy to remove this burden from the application writer.
28194 * The second one, Elm_Player is a video player that need to be linked with and Elm_Video.
28195 * It take care of updating its content according to Emotion event and provide a
28196 * way to theme itself. It also does automatically raise the priority of the
28197 * linked Elm_Video so it will use the video decoder if available. It also does
28198 * activate the remember function on the linked Elm_Video object.
28200 * Signals that you can add callback for are :
28202 * "forward,clicked" - the user clicked the forward button.
28203 * "info,clicked" - the user clicked the info button.
28204 * "next,clicked" - the user clicked the next button.
28205 * "pause,clicked" - the user clicked the pause button.
28206 * "play,clicked" - the user clicked the play button.
28207 * "prev,clicked" - the user clicked the prev button.
28208 * "rewind,clicked" - the user clicked the rewind button.
28209 * "stop,clicked" - the user clicked the stop button.
28211 * To set the video of the player, you can use elm_object_content_set() API.
28216 * @brief Add a new Elm_Player object to the given parent Elementary (container) object.
28218 * @param parent The parent object
28219 * @return a new player widget handle or @c NULL, on errors.
28221 * This function inserts a new player widget on the canvas.
28223 * @see elm_object_content_set()
28227 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
28230 * @brief Link a Elm_Payer with an Elm_Video object.
28232 * @param player the Elm_Player object.
28233 * @param video The Elm_Video object.
28235 * This mean that action on the player widget will affect the
28236 * video object and the state of the video will be reflected in
28237 * the player itself.
28239 * @see elm_player_add()
28240 * @see elm_video_add()
28241 * @deprecated use elm_object_content_set() instead
28245 EINA_DEPRECATED EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
28248 * @brief Add a new Elm_Video object to the given parent Elementary (container) object.
28250 * @param parent The parent object
28251 * @return a new video widget handle or @c NULL, on errors.
28253 * This function inserts a new video widget on the canvas.
28255 * @seeelm_video_file_set()
28256 * @see elm_video_uri_set()
28260 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
28263 * @brief Define the file that will be the video source.
28265 * @param video The video object to define the file for.
28266 * @param filename The file to target.
28268 * This function will explicitly define a filename as a source
28269 * for the video of the Elm_Video object.
28271 * @see elm_video_uri_set()
28272 * @see elm_video_add()
28273 * @see elm_player_add()
28277 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
28280 * @brief Define the uri that will be the video source.
28282 * @param video The video object to define the file for.
28283 * @param uri The uri to target.
28285 * This function will define an uri as a source for the video of the
28286 * Elm_Video object. URI could be remote source of video, like http:// or local source
28287 * like for example WebCam who are most of the time v4l2:// (but that depend and
28288 * you should use Emotion API to request and list the available Webcam on your system).
28290 * @see elm_video_file_set()
28291 * @see elm_video_add()
28292 * @see elm_player_add()
28296 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
28299 * @brief Get the underlying Emotion object.
28301 * @param video The video object to proceed the request on.
28302 * @return the underlying Emotion object.
28306 EAPI Evas_Object *elm_video_emotion_get(const Evas_Object *video);
28309 * @brief Start to play the video
28311 * @param video The video object to proceed the request on.
28313 * Start to play the video and cancel all suspend state.
28317 EAPI void elm_video_play(Evas_Object *video);
28320 * @brief Pause the video
28322 * @param video The video object to proceed the request on.
28324 * Pause the video and start a timer to trigger suspend mode.
28328 EAPI void elm_video_pause(Evas_Object *video);
28331 * @brief Stop the video
28333 * @param video The video object to proceed the request on.
28335 * Stop the video and put the emotion in deep sleep mode.
28339 EAPI void elm_video_stop(Evas_Object *video);
28342 * @brief Is the video actually playing.
28344 * @param video The video object to proceed the request on.
28345 * @return EINA_TRUE if the video is actually playing.
28347 * You should consider watching event on the object instead of polling
28348 * the object state.
28352 EAPI Eina_Bool elm_video_is_playing(const Evas_Object *video);
28355 * @brief Is it possible to seek inside the video.
28357 * @param video The video object to proceed the request on.
28358 * @return EINA_TRUE if is possible to seek inside the video.
28362 EAPI Eina_Bool elm_video_is_seekable(const Evas_Object *video);
28365 * @brief Is the audio muted.
28367 * @param video The video object to proceed the request on.
28368 * @return EINA_TRUE if the audio is muted.
28372 EAPI Eina_Bool elm_video_audio_mute_get(const Evas_Object *video);
28375 * @brief Change the mute state of the Elm_Video object.
28377 * @param video The video object to proceed the request on.
28378 * @param mute The new mute state.
28382 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
28385 * @brief Get the audio level of the current video.
28387 * @param video The video object to proceed the request on.
28388 * @return the current audio level.
28392 EAPI double elm_video_audio_level_get(const Evas_Object *video);
28395 * @brief Set the audio level of anElm_Video object.
28397 * @param video The video object to proceed the request on.
28398 * @param volume The new audio volume.
28402 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
28404 EAPI double elm_video_play_position_get(const Evas_Object *video);
28405 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
28406 EAPI double elm_video_play_length_get(const Evas_Object *video);
28407 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
28408 EAPI Eina_Bool elm_video_remember_position_get(const Evas_Object *video);
28409 EAPI const char *elm_video_title_get(const Evas_Object *video);
28415 * @defgroup Naviframe Naviframe
28416 * @ingroup Elementary
28418 * @brief Naviframe is a kind of view manager for the applications.
28420 * Naviframe provides functions to switch different pages with stack
28421 * mechanism. It means if one page(item) needs to be changed to the new one,
28422 * then naviframe would push the new page to it's internal stack. Of course,
28423 * it can be back to the previous page by popping the top page. Naviframe
28424 * provides some transition effect while the pages are switching (same as
28427 * Since each item could keep the different styles, users could keep the
28428 * same look & feel for the pages or different styles for the items in it's
28431 * Signals that you can add callback for are:
28432 * @li "transition,finished" - When the transition is finished in changing
28434 * @li "title,clicked" - User clicked title area
28436 * Default contents parts of the naviframe items that you can use for are:
28437 * @li "elm.swallow.content" - A main content of the page
28438 * @li "elm.swallow.icon" - A icon in the title area
28439 * @li "elm.swallow.prev_btn" - A button to go to the previous page
28440 * @li "elm.swallow.next_btn" - A button to go to the next page
28442 * Default text parts of the naviframe items that you can use for are:
28443 * @li "elm.text.title" - Title label in the title area
28444 * @li "elm.text.subtitle" - Sub-title label in the title area
28446 * @ref tutorial_naviframe gives a good overview of the usage of the API.
28449 #define ELM_NAVIFRAME_ITEM_CONTENT_ICON "elm.swallow.icon"
28450 #define ELM_NAVIFRAME_ITEM_CONTENT_PREV_BTN "elm.swallow.prev_btn"
28451 #define ELM_NAVIFRAME_ITEM_CONTNET_NEXT_BTN "elm.swallow.next_btn"
28452 #define ELM_NAVIFRAME_ITEM_TEXT_SUBTITLE "elm.text.subtitle"
28455 * @addtogroup Naviframe
28460 * @brief Add a new Naviframe object to the parent.
28462 * @param parent Parent object
28463 * @return New object or @c NULL, if it cannot be created
28465 * @ingroup Naviframe
28467 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28469 * @brief Push a new item to the top of the naviframe stack (and show it).
28471 * @param obj The naviframe object
28472 * @param title_label The label in the title area. The name of the title
28473 * label part is "elm.text.title"
28474 * @param prev_btn The button to go to the previous item. If it is NULL,
28475 * then naviframe will create a back button automatically. The name of
28476 * the prev_btn part is "elm.swallow.prev_btn"
28477 * @param next_btn The button to go to the next item. Or It could be just an
28478 * extra function button. The name of the next_btn part is
28479 * "elm.swallow.next_btn"
28480 * @param content The main content object. The name of content part is
28481 * "elm.swallow.content"
28482 * @param item_style The current item style name. @c NULL would be default.
28483 * @return The created item or @c NULL upon failure.
28485 * The item pushed becomes one page of the naviframe, this item will be
28486 * deleted when it is popped.
28488 * @see also elm_naviframe_item_style_set()
28489 * @see also elm_naviframe_item_insert_before()
28490 * @see also elm_naviframe_item_insert_after()
28492 * The following styles are available for this item:
28495 * @ingroup Naviframe
28497 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);
28499 * @brief Insert a new item into the naviframe before item @p before.
28501 * @param before The naviframe item to insert before.
28502 * @param title_label The label in the title area. The name of the title
28503 * label part is "elm.text.title"
28504 * @param prev_btn The button to go to the previous item. If it is NULL,
28505 * then naviframe will create a back button automatically. The name of
28506 * the prev_btn part is "elm.swallow.prev_btn"
28507 * @param next_btn The button to go to the next item. Or It could be just an
28508 * extra function button. The name of the next_btn part is
28509 * "elm.swallow.next_btn"
28510 * @param content The main content object. The name of content part is
28511 * "elm.swallow.content"
28512 * @param item_style The current item style name. @c NULL would be default.
28513 * @return The created item or @c NULL upon failure.
28515 * The item is inserted into the naviframe straight away without any
28516 * transition operations. This item will be deleted when it is popped.
28518 * @see also elm_naviframe_item_style_set()
28519 * @see also elm_naviframe_item_push()
28520 * @see also elm_naviframe_item_insert_after()
28522 * The following styles are available for this item:
28525 * @ingroup Naviframe
28527 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);
28529 * @brief Insert a new item into the naviframe after item @p after.
28531 * @param after The naviframe item to insert after.
28532 * @param title_label The label in the title area. The name of the title
28533 * label part is "elm.text.title"
28534 * @param prev_btn The button to go to the previous item. If it is NULL,
28535 * then naviframe will create a back button automatically. The name of
28536 * the prev_btn part is "elm.swallow.prev_btn"
28537 * @param next_btn The button to go to the next item. Or It could be just an
28538 * extra function button. The name of the next_btn part is
28539 * "elm.swallow.next_btn"
28540 * @param content The main content object. The name of content part is
28541 * "elm.swallow.content"
28542 * @param item_style The current item style name. @c NULL would be default.
28543 * @return The created item or @c NULL upon failure.
28545 * The item is inserted into the naviframe straight away without any
28546 * transition operations. This item will be deleted when it is popped.
28548 * @see also elm_naviframe_item_style_set()
28549 * @see also elm_naviframe_item_push()
28550 * @see also elm_naviframe_item_insert_before()
28552 * The following styles are available for this item:
28555 * @ingroup Naviframe
28557 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);
28559 * @brief Pop an item that is on top of the stack
28561 * @param obj The naviframe object
28562 * @return @c NULL or the content object(if the
28563 * elm_naviframe_content_preserve_on_pop_get is true).
28565 * This pops an item that is on the top(visible) of the naviframe, makes it
28566 * disappear, then deletes the item. The item that was underneath it on the
28567 * stack will become visible.
28569 * @see also elm_naviframe_content_preserve_on_pop_get()
28571 * @ingroup Naviframe
28573 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
28575 * @brief Pop the items between the top and the above one on the given item.
28577 * @param it The naviframe item
28579 * @ingroup Naviframe
28581 EAPI void elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28583 * Promote an item already in the naviframe stack to the top of the stack
28585 * @param it The naviframe item
28587 * This will take the indicated item and promote it to the top of the stack
28588 * as if it had been pushed there. The item must already be inside the
28589 * naviframe stack to work.
28592 EAPI void elm_naviframe_item_promote(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28594 * @brief Delete the given item instantly.
28596 * @param it The naviframe item
28598 * This just deletes the given item from the naviframe item list instantly.
28599 * So this would not emit any signals for view transitions but just change
28600 * the current view if the given item is a top one.
28602 * @ingroup Naviframe
28604 EAPI void elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28606 * @brief preserve the content objects when items are popped.
28608 * @param obj The naviframe object
28609 * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
28611 * @see also elm_naviframe_content_preserve_on_pop_get()
28613 * @ingroup Naviframe
28615 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
28617 * @brief Get a value whether preserve mode is enabled or not.
28619 * @param obj The naviframe object
28620 * @return If @c EINA_TRUE, preserve mode is enabled
28622 * @see also elm_naviframe_content_preserve_on_pop_set()
28624 * @ingroup Naviframe
28626 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28628 * @brief Get a top item on the naviframe stack
28630 * @param obj The naviframe object
28631 * @return The top item on the naviframe stack or @c NULL, if the stack is
28634 * @ingroup Naviframe
28636 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28638 * @brief Get a bottom item on the naviframe stack
28640 * @param obj The naviframe object
28641 * @return The bottom item on the naviframe stack or @c NULL, if the stack is
28644 * @ingroup Naviframe
28646 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28648 * @brief Set an item style
28650 * @param obj The naviframe item
28651 * @param item_style The current item style name. @c NULL would be default
28653 * The following styles are available for this item:
28656 * @see also elm_naviframe_item_style_get()
28658 * @ingroup Naviframe
28660 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
28662 * @brief Get an item style
28664 * @param obj The naviframe item
28665 * @return The current item style name
28667 * @see also elm_naviframe_item_style_set()
28669 * @ingroup Naviframe
28671 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28673 * @brief Show/Hide the title area
28675 * @param it The naviframe item
28676 * @param visible If @c EINA_TRUE, title area will be visible, hidden
28679 * When the title area is invisible, then the controls would be hidden so as * to expand the content area to full-size.
28681 * @see also elm_naviframe_item_title_visible_get()
28683 * @ingroup Naviframe
28685 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
28687 * @brief Get a value whether title area is visible or not.
28689 * @param it The naviframe item
28690 * @return If @c EINA_TRUE, title area is visible
28692 * @see also elm_naviframe_item_title_visible_set()
28694 * @ingroup Naviframe
28696 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28699 * @brief Set creating prev button automatically or not
28701 * @param obj The naviframe object
28702 * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
28703 * be created internally when you pass the @c NULL to the prev_btn
28704 * parameter in elm_naviframe_item_push
28706 * @see also elm_naviframe_item_push()
28708 EAPI void elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
28710 * @brief Get a value whether prev button(back button) will be auto pushed or
28713 * @param obj The naviframe object
28714 * @return If @c EINA_TRUE, prev button will be auto pushed.
28716 * @see also elm_naviframe_item_push()
28717 * elm_naviframe_prev_btn_auto_pushed_set()
28719 EAPI Eina_Bool elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28721 * @brief Get a list of all the naviframe items.
28723 * @param obj The naviframe object
28724 * @return An Eina_Inlist* of naviframe items, #Elm_Object_Item,
28725 * or @c NULL on failure.
28727 EAPI Eina_Inlist *elm_naviframe_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);