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
320 @ELM_DIRENT_H_DEF@ ELM_DIRENT_H
322 /* Standard headers for standard system calls etc. */
327 #include <sys/types.h>
328 #include <sys/stat.h>
329 #include <sys/time.h>
330 #include <sys/param.h>
344 # ifdef ELM_LIBINTL_H
345 # include <libintl.h>
356 #if defined (ELM_WIN32) || defined (ELM_WINCE)
359 # define alloca _alloca
368 // disabled - evas 1.1 won't have this.
369 //#include <Evas_GL.h>
371 #include <Ecore_Evas.h>
372 #include <Ecore_File.h>
373 #include <Ecore_IMF.h>
374 #include <Ecore_Con.h>
383 # include <Efreet_Mime.h>
384 # include <Efreet_Trash.h>
388 # include <Ethumb_Client.h>
400 # ifdef ELEMENTARY_BUILD
402 # define EAPI __declspec(dllexport)
405 # endif /* ! DLL_EXPORT */
407 # define EAPI __declspec(dllimport)
408 # endif /* ! EFL_EVAS_BUILD */
412 # define EAPI __attribute__ ((visibility("default")))
419 #endif /* ! _WIN32 */
424 # define EAPI_MAIN EAPI
427 /* allow usage from c++ */
432 #define ELM_VERSION_MAJOR @VMAJ@
433 #define ELM_VERSION_MINOR @VMIN@
435 typedef struct _Elm_Version
443 EAPI extern Elm_Version *elm_version;
446 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
447 #define ELM_PI 3.14159265358979323846
450 * @defgroup General General
452 * @brief General Elementary API. Functions that don't relate to
453 * Elementary objects specifically.
455 * Here are documented functions which init/shutdown the library,
456 * that apply to generic Elementary objects, that deal with
457 * configuration, et cetera.
459 * @ref general_functions_example_page "This" example contemplates
460 * some of these functions.
464 * @addtogroup General
469 * Defines couple of standard Evas_Object layers to be used
470 * with evas_object_layer_set().
472 * @note whenever extending with new values, try to keep some padding
473 * to siblings so there is room for further extensions.
475 typedef enum _Elm_Object_Layer
477 ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
478 ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
479 ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
480 ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
481 ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
482 ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
485 /**************************************************************************/
486 EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
489 * Emitted when the application has reconfigured elementary settings due
490 * to an external configuration tool asking it to.
492 EAPI extern int ELM_EVENT_CONFIG_ALL_CHANGED;
495 * Emitted when any Elementary's policy value is changed.
497 EAPI extern int ELM_EVENT_POLICY_CHANGED;
500 * @typedef Elm_Event_Policy_Changed
502 * Data on the event when an Elementary policy has changed
504 typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
507 * @struct _Elm_Event_Policy_Changed
509 * Data on the event when an Elementary policy has changed
511 struct _Elm_Event_Policy_Changed
513 unsigned int policy; /**< the policy identifier */
514 int new_value; /**< value the policy had before the change */
515 int old_value; /**< new value the policy got */
519 * Policy identifiers.
521 typedef enum _Elm_Policy
523 ELM_POLICY_QUIT, /**< under which circumstances the application
524 * should quit automatically. @see
528 } Elm_Policy; /**< Elementary policy identifiers/groups enumeration. @see elm_policy_set()
531 typedef enum _Elm_Policy_Quit
533 ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
535 ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
537 * window is closed */
538 } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
540 typedef enum _Elm_Focus_Direction
544 } Elm_Focus_Direction;
546 typedef enum _Elm_Text_Format
548 ELM_TEXT_FORMAT_PLAIN_UTF8,
549 ELM_TEXT_FORMAT_MARKUP_UTF8
553 * Line wrapping types.
555 typedef enum _Elm_Wrap_Type
557 ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
558 ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
559 ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
560 ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
566 ELM_INPUT_PANEL_LAYOUT_NORMAL, /**< Default layout */
567 ELM_INPUT_PANEL_LAYOUT_NUMBER, /**< Number layout */
568 ELM_INPUT_PANEL_LAYOUT_EMAIL, /**< Email layout */
569 ELM_INPUT_PANEL_LAYOUT_URL, /**< URL layout */
570 ELM_INPUT_PANEL_LAYOUT_PHONENUMBER, /**< Phone Number layout */
571 ELM_INPUT_PANEL_LAYOUT_IP, /**< IP layout */
572 ELM_INPUT_PANEL_LAYOUT_MONTH, /**< Month layout */
573 ELM_INPUT_PANEL_LAYOUT_NUMBERONLY, /**< Number Only layout */
574 ELM_INPUT_PANEL_LAYOUT_INVALID
575 } Elm_Input_Panel_Layout;
579 ELM_AUTOCAPITAL_TYPE_NONE,
580 ELM_AUTOCAPITAL_TYPE_WORD,
581 ELM_AUTOCAPITAL_TYPE_SENTENCE,
582 ELM_AUTOCAPITAL_TYPE_ALLCHARACTER,
583 } Elm_Autocapital_Type;
586 * @typedef Elm_Object_Item
587 * An Elementary Object item handle.
590 typedef struct _Elm_Object_Item Elm_Object_Item;
594 * Called back when a widget's tooltip is activated and needs content.
595 * @param data user-data given to elm_object_tooltip_content_cb_set()
596 * @param obj owner widget.
597 * @param tooltip The tooltip object (affix content to this!)
599 typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip);
602 * Called back when a widget's item tooltip is activated and needs content.
603 * @param data user-data given to elm_object_tooltip_content_cb_set()
604 * @param obj owner widget.
605 * @param tooltip The tooltip object (affix content to this!)
606 * @param item context dependent item. As an example, if tooltip was
607 * set on Elm_List_Item, then it is of this type.
609 typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
611 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. */
613 #ifndef ELM_LIB_QUICKLAUNCH
614 #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 */
616 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
619 /**************************************************************************/
623 * Initialize Elementary
625 * @param[in] argc System's argument count value
626 * @param[in] argv System's pointer to array of argument strings
627 * @return The init counter value.
629 * This function initializes Elementary and increments a counter of
630 * the number of calls to it. It returns the new counter's value.
632 * @warning This call is exported only for use by the @c ELM_MAIN()
633 * macro. There is no need to use this if you use this macro (which
634 * is highly advisable). An elm_main() should contain the entry
635 * point code for your application, having the same prototype as
636 * elm_init(), and @b not being static (putting the @c EAPI symbol
637 * in front of its type declaration is advisable). The @c
638 * ELM_MAIN() call should be placed just after it.
641 * @dontinclude bg_example_01.c
645 * See the full @ref bg_example_01_c "example".
647 * @see elm_shutdown().
650 EAPI int elm_init(int argc, char **argv);
653 * Shut down Elementary
655 * @return The init counter value.
657 * This should be called at the end of your application, just
658 * before it ceases to do any more processing. This will clean up
659 * any permanent resources your application may have allocated via
660 * Elementary that would otherwise persist.
662 * @see elm_init() for an example
666 EAPI int elm_shutdown(void);
669 * Run Elementary's main loop
671 * This call should be issued just after all initialization is
672 * completed. This function will not return until elm_exit() is
673 * called. It will keep looping, running the main
674 * (event/processing) loop for Elementary.
676 * @see elm_init() for an example
680 EAPI void elm_run(void);
683 * Exit Elementary's main loop
685 * If this call is issued, it will flag the main loop to cease
686 * processing and return back to its parent function (usually your
687 * elm_main() function).
689 * @see elm_init() for an example. There, just after a request to
690 * close the window comes, the main loop will be left.
692 * @note By using the appropriate #ELM_POLICY_QUIT on your Elementary
693 * applications, you'll be able to get this function called automatically for you.
697 EAPI void elm_exit(void);
700 * Provide information in order to make Elementary determine the @b
701 * run time location of the software in question, so other data files
702 * such as images, sound files, executable utilities, libraries,
703 * modules and locale files can be found.
705 * @param mainfunc This is your application's main function name,
706 * whose binary's location is to be found. Providing @c NULL
707 * will make Elementary not to use it
708 * @param dom This will be used as the application's "domain", in the
709 * form of a prefix to any environment variables that may
710 * override prefix detection and the directory name, inside the
711 * standard share or data directories, where the software's
712 * data files will be looked for.
713 * @param checkfile This is an (optional) magic file's path to check
714 * for existence (and it must be located in the data directory,
715 * under the share directory provided above). Its presence will
716 * help determine the prefix found was correct. Pass @c NULL if
717 * the check is not to be done.
719 * This function allows one to re-locate the application somewhere
720 * else after compilation, if the developer wishes for easier
721 * distribution of pre-compiled binaries.
723 * The prefix system is designed to locate where the given software is
724 * installed (under a common path prefix) at run time and then report
725 * specific locations of this prefix and common directories inside
726 * this prefix like the binary, library, data and locale directories,
727 * through the @c elm_app_*_get() family of functions.
729 * Call elm_app_info_set() early on before you change working
730 * directory or anything about @c argv[0], so it gets accurate
733 * It will then try and trace back which file @p mainfunc comes from,
734 * if provided, to determine the application's prefix directory.
736 * The @p dom parameter provides a string prefix to prepend before
737 * environment variables, allowing a fallback to @b specific
738 * environment variables to locate the software. You would most
739 * probably provide a lowercase string there, because it will also
740 * serve as directory domain, explained next. For environment
741 * variables purposes, this string is made uppercase. For example if
742 * @c "myapp" is provided as the prefix, then the program would expect
743 * @c "MYAPP_PREFIX" as a master environment variable to specify the
744 * exact install prefix for the software, or more specific environment
745 * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
746 * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
747 * the user or scripts before launching. If not provided (@c NULL),
748 * environment variables will not be used to override compiled-in
749 * defaults or auto detections.
751 * The @p dom string also provides a subdirectory inside the system
752 * shared data directory for data files. For example, if the system
753 * directory is @c /usr/local/share, then this directory name is
754 * appended, creating @c /usr/local/share/myapp, if it @p was @c
755 * "myapp". It is expected that the application installs data files in
758 * The @p checkfile is a file name or path of something inside the
759 * share or data directory to be used to test that the prefix
760 * detection worked. For example, your app will install a wallpaper
761 * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
762 * check that this worked, provide @c "images/wallpaper.jpg" as the @p
765 * @see elm_app_compile_bin_dir_set()
766 * @see elm_app_compile_lib_dir_set()
767 * @see elm_app_compile_data_dir_set()
768 * @see elm_app_compile_locale_set()
769 * @see elm_app_prefix_dir_get()
770 * @see elm_app_bin_dir_get()
771 * @see elm_app_lib_dir_get()
772 * @see elm_app_data_dir_get()
773 * @see elm_app_locale_dir_get()
775 EAPI void elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
778 * Provide information on the @b fallback application's binaries
779 * directory, in scenarios where they get overriden by
780 * elm_app_info_set().
782 * @param dir The path to the default binaries directory (compile time
785 * @note Elementary will as well use this path to determine actual
786 * names of binaries' directory paths, maybe changing it to be @c
787 * something/local/bin instead of @c something/bin, only, for
790 * @warning You should call this function @b before
791 * elm_app_info_set().
793 EAPI void elm_app_compile_bin_dir_set(const char *dir);
796 * Provide information on the @b fallback application's libraries
797 * directory, on scenarios where they get overriden by
798 * elm_app_info_set().
800 * @param dir The path to the default libraries directory (compile
803 * @note Elementary will as well use this path to determine actual
804 * names of libraries' directory paths, maybe changing it to be @c
805 * something/lib32 or @c something/lib64 instead of @c something/lib,
808 * @warning You should call this function @b before
809 * elm_app_info_set().
811 EAPI void elm_app_compile_lib_dir_set(const char *dir);
814 * Provide information on the @b fallback application's data
815 * directory, on scenarios where they get overriden by
816 * elm_app_info_set().
818 * @param dir The path to the default data directory (compile time
821 * @note Elementary will as well use this path to determine actual
822 * names of data directory paths, maybe changing it to be @c
823 * something/local/share instead of @c something/share, only, for
826 * @warning You should call this function @b before
827 * elm_app_info_set().
829 EAPI void elm_app_compile_data_dir_set(const char *dir);
832 * Provide information on the @b fallback application's locale
833 * directory, on scenarios where they get overriden by
834 * elm_app_info_set().
836 * @param dir The path to the default locale directory (compile time
839 * @warning You should call this function @b before
840 * elm_app_info_set().
842 EAPI void elm_app_compile_locale_set(const char *dir);
845 * Retrieve the application's run time prefix directory, as set by
846 * elm_app_info_set() and the way (environment) the application was
849 * @return The directory prefix the application is actually using.
851 EAPI const char *elm_app_prefix_dir_get(void);
854 * Retrieve the application's run time binaries prefix directory, as
855 * set by elm_app_info_set() and the way (environment) the application
858 * @return The binaries directory prefix the application is actually
861 EAPI const char *elm_app_bin_dir_get(void);
864 * Retrieve the application's run time libraries prefix directory, as
865 * set by elm_app_info_set() and the way (environment) the application
868 * @return The libraries directory prefix the application is actually
871 EAPI const char *elm_app_lib_dir_get(void);
874 * Retrieve the application's run time data prefix directory, as
875 * set by elm_app_info_set() and the way (environment) the application
878 * @return The data directory prefix the application is actually
881 EAPI const char *elm_app_data_dir_get(void);
884 * Retrieve the application's run time locale prefix directory, as
885 * set by elm_app_info_set() and the way (environment) the application
888 * @return The locale directory prefix the application is actually
891 EAPI const char *elm_app_locale_dir_get(void);
893 EAPI void elm_quicklaunch_mode_set(Eina_Bool ql_on);
894 EAPI Eina_Bool elm_quicklaunch_mode_get(void);
895 EAPI int elm_quicklaunch_init(int argc, char **argv);
896 EAPI int elm_quicklaunch_sub_init(int argc, char **argv);
897 EAPI int elm_quicklaunch_sub_shutdown(void);
898 EAPI int elm_quicklaunch_shutdown(void);
899 EAPI void elm_quicklaunch_seed(void);
900 EAPI Eina_Bool elm_quicklaunch_prepare(int argc, char **argv);
901 EAPI Eina_Bool elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
902 EAPI void elm_quicklaunch_cleanup(void);
903 EAPI int elm_quicklaunch_fallback(int argc, char **argv);
904 EAPI char *elm_quicklaunch_exe_path_get(const char *exe);
906 EAPI Eina_Bool elm_need_efreet(void);
907 EAPI Eina_Bool elm_need_e_dbus(void);
910 * This must be called before any other function that deals with
911 * elm_thumb objects or ethumb_client instances.
915 EAPI Eina_Bool elm_need_ethumb(void);
918 * This must be called before any other function that deals with
919 * elm_web objects or ewk_view instances.
923 EAPI Eina_Bool elm_need_web(void);
926 * Set a new policy's value (for a given policy group/identifier).
928 * @param policy policy identifier, as in @ref Elm_Policy.
929 * @param value policy value, which depends on the identifier
931 * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
933 * Elementary policies define applications' behavior,
934 * somehow. These behaviors are divided in policy groups (see
935 * #Elm_Policy enumeration). This call will emit the Ecore event
936 * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
937 * handlers. An #Elm_Event_Policy_Changed struct will be passed,
940 * @note Currently, we have only one policy identifier/group
941 * (#ELM_POLICY_QUIT), which has two possible values.
945 EAPI Eina_Bool elm_policy_set(unsigned int policy, int value);
948 * Gets the policy value for given policy identifier.
950 * @param policy policy identifier, as in #Elm_Policy.
951 * @return The currently set policy value, for that
952 * identifier. Will be @c 0 if @p policy passed is invalid.
956 EAPI int elm_policy_get(unsigned int policy);
959 * Change the language of the current application
961 * The @p lang passed must be the full name of the locale to use, for
962 * example "en_US.utf8" or "es_ES@euro".
964 * Changing language with this function will make Elementary run through
965 * all its widgets, translating strings set with
966 * elm_object_domain_translatable_text_part_set(). This way, an entire
967 * UI can have its language changed without having to restart the program.
969 * For more complex cases, like having formatted strings that need
970 * translation, widgets will also emit a "language,changed" signal that
971 * the user can listen to to manually translate the text.
973 * @param lang Language to set, must be the full name of the locale
977 EAPI void elm_language_set(const char *lang);
980 * Set a label of an object
982 * @param obj The Elementary object
983 * @param part The text part name to set (NULL for the default label)
984 * @param label The new text of the label
986 * @note Elementary objects may have many labels (e.g. Action Slider)
987 * @deprecated Use elm_object_part_text_set() instead.
990 EINA_DEPRECATED EAPI void elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
993 * Set a label of an object
995 * @param obj The Elementary object
996 * @param part The text part name to set (NULL for the default label)
997 * @param label The new text of the label
999 * @note Elementary objects may have many labels (e.g. Action Slider)
1003 EAPI void elm_object_part_text_set(Evas_Object *obj, const char *part, const char *label);
1005 #define elm_object_text_set(obj, label) elm_object_part_text_set((obj), NULL, (label))
1008 * Get a label of an object
1010 * @param obj The Elementary object
1011 * @param part The text part name to get (NULL for the default label)
1012 * @return text of the label or NULL for any error
1014 * @note Elementary objects may have many labels (e.g. Action Slider)
1015 * @deprecated Use elm_object_part_text_get() instead.
1018 EINA_DEPRECATED EAPI const char *elm_object_text_part_get(const Evas_Object *obj, const char *part);
1021 * Get a label of an object
1023 * @param obj The Elementary object
1024 * @param part The text part name to get (NULL for the default label)
1025 * @return text of the label or NULL for any error
1027 * @note Elementary objects may have many labels (e.g. Action Slider)
1031 EAPI const char *elm_object_part_text_get(const Evas_Object *obj, const char *part);
1033 #define elm_object_text_get(obj) elm_object_part_text_get((obj), NULL)
1036 * Set the text for an objects' part, marking it as translatable.
1038 * The string to set as @p text must be the original one. Do not pass the
1039 * return of @c gettext() here. Elementary will translate the string
1040 * internally and set it on the object using elm_object_part_text_set(),
1041 * also storing the original string so that it can be automatically
1042 * translated when the language is changed with elm_language_set().
1044 * The @p domain will be stored along to find the translation in the
1045 * correct catalog. It can be NULL, in which case it will use whatever
1046 * domain was set by the application with @c textdomain(). This is useful
1047 * in case you are building a library on top of Elementary that will have
1048 * its own translatable strings, that should not be mixed with those of
1049 * programs using the library.
1051 * @param obj The object containing the text part
1052 * @param part The name of the part to set
1053 * @param domain The translation domain to use
1054 * @param text The original, non-translated text to set
1058 EAPI void elm_object_domain_translatable_text_part_set(Evas_Object *obj, const char *part, const char *domain, const char *text);
1060 #define elm_object_domain_translatable_text_set(obj, domain, text) elm_object_domain_translatable_text_part_set((obj), NULL, (domain), (text))
1062 #define elm_object_translatable_text_set(obj, text) elm_object_domain_translatable_text_part_set((obj), NULL, NULL, (text))
1065 * Gets the original string set as translatable for an object
1067 * When setting translated strings, the function elm_object_part_text_get()
1068 * will return the translation returned by @c gettext(). To get the
1069 * original string use this function.
1071 * @param obj The object
1072 * @param part The name of the part that was set
1074 * @return The original, untranslated string
1078 EAPI const char *elm_object_translatable_text_part_get(const Evas_Object *obj, const char *part);
1080 #define elm_object_translatable_text_get(obj) elm_object_translatable_text_part_get((obj), NULL)
1083 * Set a content of an object
1085 * @param obj The Elementary object
1086 * @param part The content part name to set (NULL for the default content)
1087 * @param content The new content of the object
1089 * @note Elementary objects may have many contents
1090 * @deprecated Use elm_object_part_content_set instead.
1093 EINA_DEPRECATED EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
1096 * Set a content of an object
1098 * @param obj The Elementary object
1099 * @param part The content part name to set (NULL for the default content)
1100 * @param content The new content of the object
1102 * @note Elementary objects may have many contents
1106 EAPI void elm_object_part_content_set(Evas_Object *obj, const char *part, Evas_Object *content);
1108 #define elm_object_content_set(obj, content) elm_object_part_content_set((obj), NULL, (content))
1111 * Get a content of an object
1113 * @param obj The Elementary object
1114 * @param item The content part name to get (NULL for the default content)
1115 * @return content of the object or NULL for any error
1117 * @note Elementary objects may have many contents
1118 * @deprecated Use elm_object_part_content_get instead.
1121 EINA_DEPRECATED EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
1124 * Get a content of an object
1126 * @param obj The Elementary object
1127 * @param item The content part name to get (NULL for the default content)
1128 * @return content of the object or NULL for any error
1130 * @note Elementary objects may have many contents
1134 EAPI Evas_Object *elm_object_part_content_get(const Evas_Object *obj, const char *part);
1136 #define elm_object_content_get(obj) elm_object_part_content_get((obj), NULL)
1139 * Unset a content of an object
1141 * @param obj The Elementary object
1142 * @param item The content part name to unset (NULL for the default content)
1144 * @note Elementary objects may have many contents
1145 * @deprecated Use elm_object_part_content_unset instead.
1148 EINA_DEPRECATED EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
1151 * Unset a content of an object
1153 * @param obj The Elementary object
1154 * @param item The content part name to unset (NULL for the default content)
1156 * @note Elementary objects may have many contents
1160 EAPI Evas_Object *elm_object_part_content_unset(Evas_Object *obj, const char *part);
1162 #define elm_object_content_unset(obj) elm_object_part_content_unset((obj), NULL)
1165 * Set the text to read out when in accessibility mode
1167 * @param obj The object which is to be described
1168 * @param txt The text that describes the widget to people with poor or no vision
1172 EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1175 * Get the widget object's handle which contains a given item
1177 * @param item The Elementary object item
1178 * @return The widget object
1180 * @note This returns the widget object itself that an item belongs to.
1184 EAPI Evas_Object *elm_object_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1187 * Set a content of an object item
1189 * @param it The Elementary object item
1190 * @param part The content part name to set (NULL for the default content)
1191 * @param content The new content of the object item
1193 * @note Elementary object items may have many contents
1194 * @deprecated Use elm_object_item_part_content_set instead.
1197 EINA_DEPRECATED EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1200 * Set a content of an object item
1202 * @param it The Elementary object item
1203 * @param part The content part name to set (NULL for the default content)
1204 * @param content The new content of the object item
1206 * @note Elementary object items may have many contents
1210 EAPI void elm_object_item_part_content_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1212 #define elm_object_item_content_set(it, content) elm_object_item_part_content_set((it), NULL, (content))
1215 * Get a content of an object item
1217 * @param it The Elementary object item
1218 * @param part The content part name to unset (NULL for the default content)
1219 * @return content of the object item or NULL for any error
1221 * @note Elementary object items may have many contents
1222 * @deprecated Use elm_object_item_part_content_get instead.
1225 EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *part);
1228 * Get a content of an object item
1230 * @param it The Elementary object item
1231 * @param part The content part name to unset (NULL for the default content)
1232 * @return content of the object item or NULL for any error
1234 * @note Elementary object items may have many contents
1238 EAPI Evas_Object *elm_object_item_part_content_get(const Elm_Object_Item *it, const char *part);
1240 #define elm_object_item_content_get(it) elm_object_item_part_content_get((it), NULL)
1243 * Unset a content of an object item
1245 * @param it The Elementary object item
1246 * @param part The content part name to unset (NULL for the default content)
1248 * @note Elementary object items may have many contents
1249 * @deprecated Use elm_object_item_part_content_unset instead.
1252 EINA_DEPRECATED EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1255 * Unset a content of an object item
1257 * @param it The Elementary object item
1258 * @param part The content part name to unset (NULL for the default content)
1260 * @note Elementary object items may have many contents
1264 EAPI Evas_Object *elm_object_item_part_content_unset(Elm_Object_Item *it, const char *part);
1266 #define elm_object_item_content_unset(it) elm_object_item_part_content_unset((it), NULL)
1269 * Set a label of an object item
1271 * @param it The Elementary object item
1272 * @param part The text part name to set (NULL for the default label)
1273 * @param label The new text of the label
1275 * @note Elementary object items may have many labels
1276 * @deprecated Use elm_object_item_part_text_set instead.
1279 EINA_DEPRECATED EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1282 * Set a label of an object item
1284 * @param it The Elementary object item
1285 * @param part The text part name to set (NULL for the default label)
1286 * @param label The new text of the label
1288 * @note Elementary object items may have many labels
1292 EAPI void elm_object_item_part_text_set(Elm_Object_Item *it, const char *part, const char *label);
1294 #define elm_object_item_text_set(it, label) elm_object_item_part_text_set((it), NULL, (label))
1297 * Get a label of an object item
1299 * @param it The Elementary object item
1300 * @param part The text part name to get (NULL for the default label)
1301 * @return text of the label or NULL for any error
1303 * @note Elementary object items may have many labels
1304 * @deprecated Use elm_object_item_part_text_get instead.
1307 EINA_DEPRECATED EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1309 * Get a label of an object item
1311 * @param it The Elementary object item
1312 * @param part The text part name to get (NULL for the default label)
1313 * @return text of the label or NULL for any error
1315 * @note Elementary object items may have many labels
1319 EAPI const char *elm_object_item_part_text_get(const Elm_Object_Item *it, const char *part);
1321 #define elm_object_item_text_get(it) elm_object_item_part_text_get((it), NULL)
1324 * Set the text to read out when in accessibility mode
1326 * @param it The object item which is to be described
1327 * @param txt The text that describes the widget to people with poor or no vision
1331 EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1334 * Get the data associated with an object item
1335 * @param it The Elementary object item
1336 * @return The data associated with @p it
1340 EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
1343 * Set the data associated with an object item
1344 * @param it The Elementary object item
1345 * @param data The data to be associated with @p it
1349 EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
1352 * Send a signal to the edje object of the widget item.
1354 * This function sends a signal to the edje object of the obj item. An
1355 * edje program can respond to a signal by specifying matching
1356 * 'signal' and 'source' fields.
1358 * @param it The Elementary object item
1359 * @param emission The signal's name.
1360 * @param source The signal's source.
1363 EAPI void elm_object_item_signal_emit(Elm_Object_Item *it, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1366 * Set the disabled state of an widget item.
1368 * @param obj The Elementary object item
1369 * @param disabled The state to put in in: @c EINA_TRUE for
1370 * disabled, @c EINA_FALSE for enabled
1372 * Elementary object item can be @b disabled, in which state they won't
1373 * receive input and, in general, will be themed differently from
1374 * their normal state, usually greyed out. Useful for contexts
1375 * where you don't want your users to interact with some of the
1376 * parts of you interface.
1378 * This sets the state for the widget item, either disabling it or
1383 EAPI void elm_object_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1386 * Get the disabled state of an widget item.
1388 * @param obj The Elementary object
1389 * @return @c EINA_TRUE, if the widget item is disabled, @c EINA_FALSE
1390 * if it's enabled (or on errors)
1392 * This gets the state of the widget, which might be enabled or disabled.
1396 EAPI Eina_Bool elm_object_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1403 * @defgroup Caches Caches
1405 * These are functions which let one fine-tune some cache values for
1406 * Elementary applications, thus allowing for performance adjustments.
1412 * @brief Flush all caches.
1414 * Frees all data that was in cache and is not currently being used to reduce
1415 * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1416 * to calling all of the following functions:
1417 * @li edje_file_cache_flush()
1418 * @li edje_collection_cache_flush()
1419 * @li eet_clearcache()
1420 * @li evas_image_cache_flush()
1421 * @li evas_font_cache_flush()
1422 * @li evas_render_dump()
1423 * @note Evas caches are flushed for every canvas associated with a window.
1427 EAPI void elm_all_flush(void);
1430 * Get the configured cache flush interval time
1432 * This gets the globally configured cache flush interval time, in
1435 * @return The cache flush interval time
1438 * @see elm_all_flush()
1440 EAPI int elm_cache_flush_interval_get(void);
1443 * Set the configured cache flush interval time
1445 * This sets the globally configured cache flush interval time, in ticks
1447 * @param size The cache flush interval time
1450 * @see elm_all_flush()
1452 EAPI void elm_cache_flush_interval_set(int size);
1455 * Set the configured cache flush interval time for all applications on the
1458 * This sets the globally configured cache flush interval time -- in ticks
1459 * -- for all applications on the display.
1461 * @param size The cache flush interval time
1464 EAPI void elm_cache_flush_interval_all_set(int size);
1467 * Get the configured cache flush enabled state
1469 * This gets the globally configured cache flush state - if it is enabled
1470 * or not. When cache flushing is enabled, elementary will regularly
1471 * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1472 * memory and allow usage to re-seed caches and data in memory where it
1473 * can do so. An idle application will thus minimise its memory usage as
1474 * data will be freed from memory and not be re-loaded as it is idle and
1475 * not rendering or doing anything graphically right now.
1477 * @return The cache flush state
1480 * @see elm_all_flush()
1482 EAPI Eina_Bool elm_cache_flush_enabled_get(void);
1485 * Set the configured cache flush enabled state
1487 * This sets the globally configured cache flush enabled state.
1489 * @param size The cache flush enabled state
1492 * @see elm_all_flush()
1494 EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
1497 * Set the configured cache flush enabled state for all applications on the
1500 * This sets the globally configured cache flush enabled state for all
1501 * applications on the display.
1503 * @param size The cache flush enabled state
1506 EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1509 * Get the configured font cache size
1511 * This gets the globally configured font cache size, in bytes.
1513 * @return The font cache size
1516 EAPI int elm_font_cache_get(void);
1519 * Set the configured font cache size
1521 * This sets the globally configured font cache size, in bytes
1523 * @param size The font cache size
1526 EAPI void elm_font_cache_set(int size);
1529 * Set the configured font cache size for all applications on the
1532 * This sets the globally configured font cache size -- in bytes
1533 * -- for all applications on the display.
1535 * @param size The font cache size
1538 EAPI void elm_font_cache_all_set(int size);
1541 * Get the configured image cache size
1543 * This gets the globally configured image cache size, in bytes
1545 * @return The image cache size
1548 EAPI int elm_image_cache_get(void);
1551 * Set the configured image cache size
1553 * This sets the globally configured image cache size, in bytes
1555 * @param size The image cache size
1558 EAPI void elm_image_cache_set(int size);
1561 * Set the configured image cache size for all applications on the
1564 * This sets the globally configured image cache size -- in bytes
1565 * -- for all applications on the display.
1567 * @param size The image cache size
1570 EAPI void elm_image_cache_all_set(int size);
1573 * Get the configured edje file cache size.
1575 * This gets the globally configured edje file cache size, in number
1578 * @return The edje file cache size
1581 EAPI int elm_edje_file_cache_get(void);
1584 * Set the configured edje file cache size
1586 * This sets the globally configured edje file cache size, in number
1589 * @param size The edje file cache size
1592 EAPI void elm_edje_file_cache_set(int size);
1595 * Set the configured edje file cache size for all applications on the
1598 * This sets the globally configured edje file cache size -- in number
1599 * of files -- for all applications on the display.
1601 * @param size The edje file cache size
1604 EAPI void elm_edje_file_cache_all_set(int size);
1607 * Get the configured edje collections (groups) cache size.
1609 * This gets the globally configured edje collections cache size, in
1610 * number of collections.
1612 * @return The edje collections cache size
1615 EAPI int elm_edje_collection_cache_get(void);
1618 * Set the configured edje collections (groups) cache size
1620 * This sets the globally configured edje collections cache size, in
1621 * number of collections.
1623 * @param size The edje collections cache size
1626 EAPI void elm_edje_collection_cache_set(int size);
1629 * Set the configured edje collections (groups) cache size for all
1630 * applications on the display
1632 * This sets the globally configured edje collections cache size -- in
1633 * number of collections -- for all applications on the display.
1635 * @param size The edje collections cache size
1638 EAPI void elm_edje_collection_cache_all_set(int size);
1645 * @defgroup Scaling Widget Scaling
1647 * Different widgets can be scaled independently. These functions
1648 * allow you to manipulate this scaling on a per-widget basis. The
1649 * object and all its children get their scaling factors multiplied
1650 * by the scale factor set. This is multiplicative, in that if a
1651 * child also has a scale size set it is in turn multiplied by its
1652 * parent's scale size. @c 1.0 means ādon't scaleā, @c 2.0 is
1653 * double size, @c 0.5 is half, etc.
1655 * @ref general_functions_example_page "This" example contemplates
1656 * some of these functions.
1660 * Get the global scaling factor
1662 * This gets the globally configured scaling factor that is applied to all
1665 * @return The scaling factor
1668 EAPI double elm_scale_get(void);
1671 * Set the global scaling factor
1673 * This sets the globally configured scaling factor that is applied to all
1676 * @param scale The scaling factor to set
1679 EAPI void elm_scale_set(double scale);
1682 * Set the global scaling factor for all applications on the display
1684 * This sets the globally configured scaling factor that is applied to all
1685 * objects for all applications.
1686 * @param scale The scaling factor to set
1689 EAPI void elm_scale_all_set(double scale);
1692 * Set the scaling factor for a given Elementary object
1694 * @param obj The Elementary to operate on
1695 * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1700 EAPI void elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1703 * Get the scaling factor for a given Elementary object
1705 * @param obj The object
1706 * @return The scaling factor set by elm_object_scale_set()
1710 EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1713 * @defgroup Password_last_show Password last input show
1715 * Last show feature of password mode enables user to view
1716 * the last input entered for few seconds before masking it.
1717 * These functions allow to set this feature in password mode
1718 * of entry widget and also allow to manipulate the duration
1719 * for which the input has to be visible.
1725 * Get show last setting of password mode.
1727 * This gets the show last input setting of password mode which might be
1728 * enabled or disabled.
1730 * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1732 * @ingroup Password_last_show
1734 EAPI Eina_Bool elm_password_show_last_get(void);
1737 * Set show last setting in password mode.
1739 * This enables or disables show last setting of password mode.
1741 * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1742 * @see elm_password_show_last_timeout_set()
1743 * @ingroup Password_last_show
1745 EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1748 * Get's the timeout value in last show password mode.
1750 * This gets the time out value for which the last input entered in password
1751 * mode will be visible.
1753 * @return The timeout value of last show password mode.
1754 * @ingroup Password_last_show
1756 EAPI double elm_password_show_last_timeout_get(void);
1759 * Set's the timeout value in last show password mode.
1761 * This sets the time out value for which the last input entered in password
1762 * mode will be visible.
1764 * @param password_show_last_timeout The timeout value.
1765 * @see elm_password_show_last_set()
1766 * @ingroup Password_last_show
1768 EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1775 * @defgroup UI-Mirroring Selective Widget mirroring
1777 * These functions allow you to set ui-mirroring on specific
1778 * widgets or the whole interface. Widgets can be in one of two
1779 * modes, automatic and manual. Automatic means they'll be changed
1780 * according to the system mirroring mode and manual means only
1781 * explicit changes will matter. You are not supposed to change
1782 * mirroring state of a widget set to automatic, will mostly work,
1783 * but the behavior is not really defined.
1788 EAPI Eina_Bool elm_mirrored_get(void);
1789 EAPI void elm_mirrored_set(Eina_Bool mirrored);
1792 * Get the system mirrored mode. This determines the default mirrored mode
1795 * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1797 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1800 * Set the system mirrored mode. This determines the default mirrored mode
1803 * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1805 EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1808 * Returns the widget's mirrored mode setting.
1810 * @param obj The widget.
1811 * @return mirrored mode setting of the object.
1814 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1817 * Sets the widget's mirrored mode setting.
1818 * When widget in automatic mode, it follows the system mirrored mode set by
1819 * elm_mirrored_set().
1820 * @param obj The widget.
1821 * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1823 EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1830 * Set the style to use by a widget
1832 * Sets the style name that will define the appearance of a widget. Styles
1833 * vary from widget to widget and may also be defined by other themes
1834 * by means of extensions and overlays.
1836 * @param obj The Elementary widget to style
1837 * @param style The style name to use
1839 * @see elm_theme_extension_add()
1840 * @see elm_theme_extension_del()
1841 * @see elm_theme_overlay_add()
1842 * @see elm_theme_overlay_del()
1846 EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1848 * Get the style used by the widget
1850 * This gets the style being used for that widget. Note that the string
1851 * pointer is only valid as longas the object is valid and the style doesn't
1854 * @param obj The Elementary widget to query for its style
1855 * @return The style name used
1857 * @see elm_object_style_set()
1861 EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1864 * @defgroup Styles Styles
1866 * Widgets can have different styles of look. These generic API's
1867 * set styles of widgets, if they support them (and if the theme(s)
1870 * @ref general_functions_example_page "This" example contemplates
1871 * some of these functions.
1875 * Set the disabled state of an Elementary object.
1877 * @param obj The Elementary object to operate on
1878 * @param disabled The state to put in in: @c EINA_TRUE for
1879 * disabled, @c EINA_FALSE for enabled
1881 * Elementary objects can be @b disabled, in which state they won't
1882 * receive input and, in general, will be themed differently from
1883 * their normal state, usually greyed out. Useful for contexts
1884 * where you don't want your users to interact with some of the
1885 * parts of you interface.
1887 * This sets the state for the widget, either disabling it or
1892 EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1895 * Get the disabled state of an Elementary object.
1897 * @param obj The Elementary object to operate on
1898 * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1899 * if it's enabled (or on errors)
1901 * This gets the state of the widget, which might be enabled or disabled.
1905 EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1908 * @defgroup WidgetNavigation Widget Tree Navigation.
1910 * How to check if an Evas Object is an Elementary widget? How to
1911 * get the first elementary widget that is parent of the given
1912 * object? These are all covered in widget tree navigation.
1914 * @ref general_functions_example_page "This" example contemplates
1915 * some of these functions.
1919 * Check if the given Evas Object is an Elementary widget.
1921 * @param obj the object to query.
1922 * @return @c EINA_TRUE if it is an elementary widget variant,
1923 * @c EINA_FALSE otherwise
1924 * @ingroup WidgetNavigation
1926 EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1929 * Get the first parent of the given object that is an Elementary
1932 * @param obj the Elementary object to query parent from.
1933 * @return the parent object that is an Elementary widget, or @c
1934 * NULL, if it was not found.
1936 * Use this to query for an object's parent widget.
1938 * @note Most of Elementary users wouldn't be mixing non-Elementary
1939 * smart objects in the objects tree of an application, as this is
1940 * an advanced usage of Elementary with Evas. So, except for the
1941 * application's window, which is the root of that tree, all other
1942 * objects would have valid Elementary widget parents.
1944 * @ingroup WidgetNavigation
1946 EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1949 * Get the top level parent of an Elementary widget.
1951 * @param obj The object to query.
1952 * @return The top level Elementary widget, or @c NULL if parent cannot be
1954 * @ingroup WidgetNavigation
1956 EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1959 * Get the string that represents this Elementary widget.
1961 * @note Elementary is weird and exposes itself as a single
1962 * Evas_Object_Smart_Class of type "elm_widget", so
1963 * evas_object_type_get() always return that, making debug and
1964 * language bindings hard. This function tries to mitigate this
1965 * problem, but the solution is to change Elementary to use
1966 * proper inheritance.
1968 * @param obj the object to query.
1969 * @return Elementary widget name, or @c NULL if not a valid widget.
1970 * @ingroup WidgetNavigation
1972 EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1975 * @defgroup Config Elementary Config
1977 * Elementary configuration is formed by a set options bounded to a
1978 * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1979 * "finger size", etc. These are functions with which one syncronizes
1980 * changes made to those values to the configuration storing files, de
1981 * facto. You most probably don't want to use the functions in this
1982 * group unlees you're writing an elementary configuration manager.
1988 * Save back Elementary's configuration, so that it will persist on
1991 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1994 * This function will take effect -- thus, do I/O -- immediately. Use
1995 * it when you want to apply all configuration changes at once. The
1996 * current configuration set will get saved onto the current profile
1997 * configuration file.
2000 EAPI Eina_Bool elm_config_save(void);
2003 * Reload Elementary's configuration, bounded to current selected
2006 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
2009 * Useful when you want to force reloading of configuration values for
2010 * a profile. If one removes user custom configuration directories,
2011 * for example, it will force a reload with system values instead.
2014 EAPI void elm_config_reload(void);
2021 * @defgroup Profile Elementary Profile
2023 * Profiles are pre-set options that affect the whole look-and-feel of
2024 * Elementary-based applications. There are, for example, profiles
2025 * aimed at desktop computer applications and others aimed at mobile,
2026 * touchscreen-based ones. You most probably don't want to use the
2027 * functions in this group unlees you're writing an elementary
2028 * configuration manager.
2034 * Get Elementary's profile in use.
2036 * This gets the global profile that is applied to all Elementary
2039 * @return The profile's name
2042 EAPI const char *elm_profile_current_get(void);
2045 * Get an Elementary's profile directory path in the filesystem. One
2046 * may want to fetch a system profile's dir or an user one (fetched
2049 * @param profile The profile's name
2050 * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
2051 * or a system one (@c EINA_FALSE)
2052 * @return The profile's directory path.
2055 * @note You must free it with elm_profile_dir_free().
2057 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
2060 * Free an Elementary's profile directory path, as returned by
2061 * elm_profile_dir_get().
2063 * @param p_dir The profile's path
2067 EAPI void elm_profile_dir_free(const char *p_dir);
2070 * Get Elementary's list of available profiles.
2072 * @return The profiles list. List node data are the profile name
2076 * @note One must free this list, after usage, with the function
2077 * elm_profile_list_free().
2079 EAPI Eina_List *elm_profile_list_get(void);
2082 * Free Elementary's list of available profiles.
2084 * @param l The profiles list, as returned by elm_profile_list_get().
2088 EAPI void elm_profile_list_free(Eina_List *l);
2091 * Set Elementary's profile.
2093 * This sets the global profile that is applied to Elementary
2094 * applications. Just the process the call comes from will be
2097 * @param profile The profile's name
2101 EAPI void elm_profile_set(const char *profile);
2104 * Set Elementary's profile.
2106 * This sets the global profile that is applied to all Elementary
2107 * applications. All running Elementary windows will be affected.
2109 * @param profile The profile's name
2113 EAPI void elm_profile_all_set(const char *profile);
2120 * @defgroup Engine Elementary Engine
2122 * These are functions setting and querying which rendering engine
2123 * Elementary will use for drawing its windows' pixels.
2125 * The following are the available engines:
2126 * @li "software_x11"
2129 * @li "software_16_x11"
2130 * @li "software_8_x11"
2133 * @li "software_gdi"
2134 * @li "software_16_wince_gdi"
2136 * @li "software_16_sdl"
2140 * @li "opengl_cocoa"
2147 * @brief Get Elementary's rendering engine in use.
2149 * @return The rendering engine's name
2150 * @note there's no need to free the returned string, here.
2152 * This gets the global rendering engine that is applied to all Elementary
2155 * @see elm_engine_set()
2157 EAPI const char *elm_engine_current_get(void);
2160 * @brief Set Elementary's rendering engine for use.
2162 * @param engine The rendering engine's name
2164 * This sets global rendering engine that is applied to all Elementary
2165 * applications. Note that it will take effect only to Elementary windows
2166 * created after this is called.
2168 * @see elm_win_add()
2170 EAPI void elm_engine_set(const char *engine);
2177 * @defgroup Fonts Elementary Fonts
2179 * These are functions dealing with font rendering, selection and the
2180 * like for Elementary applications. One might fetch which system
2181 * fonts are there to use and set custom fonts for individual classes
2182 * of UI items containing text (text classes).
2187 typedef struct _Elm_Text_Class
2193 typedef struct _Elm_Font_Overlay
2195 const char *text_class;
2197 Evas_Font_Size size;
2200 typedef struct _Elm_Font_Properties
2204 } Elm_Font_Properties;
2207 * Get Elementary's list of supported text classes.
2209 * @return The text classes list, with @c Elm_Text_Class blobs as data.
2212 * Release the list with elm_text_classes_list_free().
2214 EAPI const Eina_List *elm_text_classes_list_get(void);
2217 * Free Elementary's list of supported text classes.
2221 * @see elm_text_classes_list_get().
2223 EAPI void elm_text_classes_list_free(const Eina_List *list);
2226 * Get Elementary's list of font overlays, set with
2227 * elm_font_overlay_set().
2229 * @return The font overlays list, with @c Elm_Font_Overlay blobs as
2234 * For each text class, one can set a <b>font overlay</b> for it,
2235 * overriding the default font properties for that class coming from
2236 * the theme in use. There is no need to free this list.
2238 * @see elm_font_overlay_set() and elm_font_overlay_unset().
2240 EAPI const Eina_List *elm_font_overlay_list_get(void);
2243 * Set a font overlay for a given Elementary text class.
2245 * @param text_class Text class name
2246 * @param font Font name and style string
2247 * @param size Font size
2251 * @p font has to be in the format returned by
2252 * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
2253 * and elm_font_overlay_unset().
2255 EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
2258 * Unset a font overlay for a given Elementary text class.
2260 * @param text_class Text class name
2264 * This will bring back text elements belonging to text class
2265 * @p text_class back to their default font settings.
2267 EAPI void elm_font_overlay_unset(const char *text_class);
2270 * Apply the changes made with elm_font_overlay_set() and
2271 * elm_font_overlay_unset() on the current Elementary window.
2275 * This applies all font overlays set to all objects in the UI.
2277 EAPI void elm_font_overlay_apply(void);
2280 * Apply the changes made with elm_font_overlay_set() and
2281 * elm_font_overlay_unset() on all Elementary application windows.
2285 * This applies all font overlays set to all objects in the UI.
2287 EAPI void elm_font_overlay_all_apply(void);
2290 * Translate a font (family) name string in fontconfig's font names
2291 * syntax into an @c Elm_Font_Properties struct.
2293 * @param font The font name and styles string
2294 * @return the font properties struct
2298 * @note The reverse translation can be achived with
2299 * elm_font_fontconfig_name_get(), for one style only (single font
2300 * instance, not family).
2302 EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
2305 * Free font properties return by elm_font_properties_get().
2307 * @param efp the font properties struct
2311 EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
2314 * Translate a font name, bound to a style, into fontconfig's font names
2317 * @param name The font (family) name
2318 * @param style The given style (may be @c NULL)
2320 * @return the font name and style string
2324 * @note The reverse translation can be achived with
2325 * elm_font_properties_get(), for one style only (single font
2326 * instance, not family).
2328 EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
2331 * Free the font string return by elm_font_fontconfig_name_get().
2333 * @param efp the font properties struct
2337 EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
2340 * Create a font hash table of available system fonts.
2342 * One must call it with @p list being the return value of
2343 * evas_font_available_list(). The hash will be indexed by font
2344 * (family) names, being its values @c Elm_Font_Properties blobs.
2346 * @param list The list of available system fonts, as returned by
2347 * evas_font_available_list().
2348 * @return the font hash.
2352 * @note The user is supposed to get it populated at least with 3
2353 * default font families (Sans, Serif, Monospace), which should be
2354 * present on most systems.
2356 EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
2359 * Free the hash return by elm_font_available_hash_add().
2361 * @param hash the hash to be freed.
2365 EAPI void elm_font_available_hash_del(Eina_Hash *hash);
2372 * @defgroup Fingers Fingers
2374 * Elementary is designed to be finger-friendly for touchscreens,
2375 * and so in addition to scaling for display resolution, it can
2376 * also scale based on finger "resolution" (or size). You can then
2377 * customize the granularity of the areas meant to receive clicks
2380 * Different profiles may have pre-set values for finger sizes.
2382 * @ref general_functions_example_page "This" example contemplates
2383 * some of these functions.
2389 * Get the configured "finger size"
2391 * @return The finger size
2393 * This gets the globally configured finger size, <b>in pixels</b>
2397 EAPI Evas_Coord elm_finger_size_get(void);
2400 * Set the configured finger size
2402 * This sets the globally configured finger size in pixels
2404 * @param size The finger size
2407 EAPI void elm_finger_size_set(Evas_Coord size);
2410 * Set the configured finger size for all applications on the display
2412 * This sets the globally configured finger size in pixels for all
2413 * applications on the display
2415 * @param size The finger size
2418 EAPI void elm_finger_size_all_set(Evas_Coord size);
2425 * @defgroup Focus Focus
2427 * An Elementary application has, at all times, one (and only one)
2428 * @b focused object. This is what determines where the input
2429 * events go to within the application's window. Also, focused
2430 * objects can be decorated differently, in order to signal to the
2431 * user where the input is, at a given moment.
2433 * Elementary applications also have the concept of <b>focus
2434 * chain</b>: one can cycle through all the windows' focusable
2435 * objects by input (tab key) or programmatically. The default
2436 * focus chain for an application is the one define by the order in
2437 * which the widgets where added in code. One will cycle through
2438 * top level widgets, and, for each one containg sub-objects, cycle
2439 * through them all, before returning to the level
2440 * above. Elementary also allows one to set @b custom focus chains
2441 * for their applications.
2443 * Besides the focused decoration a widget may exhibit, when it
2444 * gets focus, Elementary has a @b global focus highlight object
2445 * that can be enabled for a window. If one chooses to do so, this
2446 * extra highlight effect will surround the current focused object,
2449 * @note Some Elementary widgets are @b unfocusable, after
2450 * creation, by their very nature: they are not meant to be
2451 * interacted with input events, but are there just for visual
2454 * @ref general_functions_example_page "This" example contemplates
2455 * some of these functions.
2459 * Get the enable status of the focus highlight
2461 * This gets whether the highlight on focused objects is enabled or not
2464 EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
2467 * Set the enable status of the focus highlight
2469 * Set whether to show or not the highlight on focused objects
2470 * @param enable Enable highlight if EINA_TRUE, disable otherwise
2473 EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
2476 * Get the enable status of the highlight animation
2478 * Get whether the focus highlight, if enabled, will animate its switch from
2479 * one object to the next
2482 EAPI Eina_Bool elm_focus_highlight_animate_get(void);
2485 * Set the enable status of the highlight animation
2487 * Set whether the focus highlight, if enabled, will animate its switch from
2488 * one object to the next
2489 * @param animate Enable animation if EINA_TRUE, disable otherwise
2492 EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
2495 * Get the whether an Elementary object has the focus or not.
2497 * @param obj The Elementary object to get the information from
2498 * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2499 * not (and on errors).
2501 * @see elm_object_focus_set()
2505 EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2508 * Set/unset focus to a given Elementary object.
2510 * @param obj The Elementary object to operate on.
2511 * @param enable @c EINA_TRUE Set focus to a given object,
2512 * @c EINA_FALSE Unset focus to a given object.
2514 * @note When you set focus to this object, if it can handle focus, will
2515 * take the focus away from the one who had it previously and will, for
2516 * now on, be the one receiving input events. Unsetting focus will remove
2517 * the focus from @p obj, passing it back to the previous element in the
2520 * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2524 EAPI void elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2527 * Make a given Elementary object the focused one.
2529 * @param obj The Elementary object to make focused.
2531 * @note This object, if it can handle focus, will take the focus
2532 * away from the one who had it previously and will, for now on, be
2533 * the one receiving input events.
2535 * @see elm_object_focus_get()
2536 * @deprecated use elm_object_focus_set() instead.
2540 EINA_DEPRECATED EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2543 * Remove the focus from an Elementary object
2545 * @param obj The Elementary to take focus from
2547 * This removes the focus from @p obj, passing it back to the
2548 * previous element in the focus chain list.
2550 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2551 * @deprecated use elm_object_focus_set() instead.
2555 EINA_DEPRECATED EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2558 * Set the ability for an Element object to be focused
2560 * @param obj The Elementary object to operate on
2561 * @param enable @c EINA_TRUE if the object can be focused, @c
2562 * EINA_FALSE if not (and on errors)
2564 * This sets whether the object @p obj is able to take focus or
2565 * not. Unfocusable objects do nothing when programmatically
2566 * focused, being the nearest focusable parent object the one
2567 * really getting focus. Also, when they receive mouse input, they
2568 * will get the event, but not take away the focus from where it
2573 EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2576 * Get whether an Elementary object is focusable or not
2578 * @param obj The Elementary object to operate on
2579 * @return @c EINA_TRUE if the object is allowed to be focused, @c
2580 * EINA_FALSE if not (and on errors)
2582 * @note Objects which are meant to be interacted with by input
2583 * events are created able to be focused, by default. All the
2588 EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2591 * Set custom focus chain.
2593 * This function overwrites any previous custom focus chain within
2594 * the list of objects. The previous list will be deleted and this list
2595 * will be managed by elementary. After it is set, don't modify it.
2597 * @note On focus cycle, only will be evaluated children of this container.
2599 * @param obj The container object
2600 * @param objs Chain of objects to pass focus
2603 EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2606 * Unset a custom focus chain on a given Elementary widget
2608 * @param obj The container object to remove focus chain from
2610 * Any focus chain previously set on @p obj (for its child objects)
2611 * is removed entirely after this call.
2615 EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2618 * Get custom focus chain
2620 * @param obj The container object
2623 EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2626 * Append object to custom focus chain.
2628 * @note If relative_child equal to NULL or not in custom chain, the object
2629 * will be added in end.
2631 * @note On focus cycle, only will be evaluated children of this container.
2633 * @param obj The container object
2634 * @param child The child to be added in custom chain
2635 * @param relative_child The relative object to position the child
2638 EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2641 * Prepend object to custom focus chain.
2643 * @note If relative_child equal to NULL or not in custom chain, the object
2644 * will be added in begin.
2646 * @note On focus cycle, only will be evaluated children of this container.
2648 * @param obj The container object
2649 * @param child The child to be added in custom chain
2650 * @param relative_child The relative object to position the child
2653 EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2656 * Give focus to next object in object tree.
2658 * Give focus to next object in focus chain of one object sub-tree.
2659 * If the last object of chain already have focus, the focus will go to the
2660 * first object of chain.
2662 * @param obj The object root of sub-tree
2663 * @param dir Direction to cycle the focus
2667 EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2670 * Give focus to near object in one direction.
2672 * Give focus to near object in direction of one object.
2673 * If none focusable object in given direction, the focus will not change.
2675 * @param obj The reference object
2676 * @param x Horizontal component of direction to focus
2677 * @param y Vertical component of direction to focus
2681 EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2684 * Make the elementary object and its children to be unfocusable
2687 * @param obj The Elementary object to operate on
2688 * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2689 * @c EINA_FALSE for focusable.
2691 * This sets whether the object @p obj and its children objects
2692 * are able to take focus or not. If the tree is set as unfocusable,
2693 * newest focused object which is not in this tree will get focus.
2694 * This API can be helpful for an object to be deleted.
2695 * When an object will be deleted soon, it and its children may not
2696 * want to get focus (by focus reverting or by other focus controls).
2697 * Then, just use this API before deleting.
2699 * @see elm_object_tree_unfocusable_get()
2703 EAPI void elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable) EINA_ARG_NONNULL(1);
2706 * Get whether an Elementary object and its children are unfocusable or not.
2708 * @param obj The Elementary object to get the information from
2709 * @return @c EINA_TRUE, if the tree is unfocussable,
2710 * @c EINA_FALSE if not (and on errors).
2712 * @see elm_object_tree_unfocusable_set()
2716 EAPI Eina_Bool elm_object_tree_unfocusable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2719 * @defgroup Scrolling Scrolling
2721 * These are functions setting how scrollable views in Elementary
2722 * widgets should behave on user interaction.
2728 * Get whether scrollers should bounce when they reach their
2729 * viewport's edge during a scroll.
2731 * @return the thumb scroll bouncing state
2733 * This is the default behavior for touch screens, in general.
2734 * @ingroup Scrolling
2736 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
2739 * Set whether scrollers should bounce when they reach their
2740 * viewport's edge during a scroll.
2742 * @param enabled the thumb scroll bouncing state
2744 * @see elm_thumbscroll_bounce_enabled_get()
2745 * @ingroup Scrolling
2747 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2750 * Set whether scrollers should bounce when they reach their
2751 * viewport's edge during a scroll, for all Elementary application
2754 * @param enabled the thumb scroll bouncing state
2756 * @see elm_thumbscroll_bounce_enabled_get()
2757 * @ingroup Scrolling
2759 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2762 * Get the amount of inertia a scroller will impose at bounce
2765 * @return the thumb scroll bounce friction
2767 * @ingroup Scrolling
2769 EAPI double elm_scroll_bounce_friction_get(void);
2772 * Set the amount of inertia a scroller will impose at bounce
2775 * @param friction the thumb scroll bounce friction
2777 * @see elm_thumbscroll_bounce_friction_get()
2778 * @ingroup Scrolling
2780 EAPI void elm_scroll_bounce_friction_set(double friction);
2783 * Set the amount of inertia a scroller will impose at bounce
2784 * animations, for all Elementary application windows.
2786 * @param friction the thumb scroll bounce friction
2788 * @see elm_thumbscroll_bounce_friction_get()
2789 * @ingroup Scrolling
2791 EAPI void elm_scroll_bounce_friction_all_set(double friction);
2794 * Get the amount of inertia a <b>paged</b> scroller will impose at
2795 * page fitting animations.
2797 * @return the page scroll friction
2799 * @ingroup Scrolling
2801 EAPI double elm_scroll_page_scroll_friction_get(void);
2804 * Set the amount of inertia a <b>paged</b> scroller will impose at
2805 * page fitting animations.
2807 * @param friction the page scroll friction
2809 * @see elm_thumbscroll_page_scroll_friction_get()
2810 * @ingroup Scrolling
2812 EAPI void elm_scroll_page_scroll_friction_set(double friction);
2815 * Set the amount of inertia a <b>paged</b> scroller will impose at
2816 * page fitting animations, for all Elementary application windows.
2818 * @param friction the page scroll friction
2820 * @see elm_thumbscroll_page_scroll_friction_get()
2821 * @ingroup Scrolling
2823 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
2826 * Get the amount of inertia a scroller will impose at region bring
2829 * @return the bring in scroll friction
2831 * @ingroup Scrolling
2833 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
2836 * Set the amount of inertia a scroller will impose at region bring
2839 * @param friction the bring in scroll friction
2841 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2842 * @ingroup Scrolling
2844 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
2847 * Set the amount of inertia a scroller will impose at region bring
2848 * animations, for all Elementary application windows.
2850 * @param friction the bring in scroll friction
2852 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2853 * @ingroup Scrolling
2855 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
2858 * Get the amount of inertia scrollers will impose at animations
2859 * triggered by Elementary widgets' zooming API.
2861 * @return the zoom friction
2863 * @ingroup Scrolling
2865 EAPI double elm_scroll_zoom_friction_get(void);
2868 * Set the amount of inertia scrollers will impose at animations
2869 * triggered by Elementary widgets' zooming API.
2871 * @param friction the zoom friction
2873 * @see elm_thumbscroll_zoom_friction_get()
2874 * @ingroup Scrolling
2876 EAPI void elm_scroll_zoom_friction_set(double friction);
2879 * Set the amount of inertia scrollers will impose at animations
2880 * triggered by Elementary widgets' zooming API, for all Elementary
2881 * application windows.
2883 * @param friction the zoom friction
2885 * @see elm_thumbscroll_zoom_friction_get()
2886 * @ingroup Scrolling
2888 EAPI void elm_scroll_zoom_friction_all_set(double friction);
2891 * Get whether scrollers should be draggable from any point in their
2894 * @return the thumb scroll state
2896 * @note This is the default behavior for touch screens, in general.
2897 * @note All other functions namespaced with "thumbscroll" will only
2898 * have effect if this mode is enabled.
2900 * @ingroup Scrolling
2902 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
2905 * Set whether scrollers should be draggable from any point in their
2908 * @param enabled the thumb scroll state
2910 * @see elm_thumbscroll_enabled_get()
2911 * @ingroup Scrolling
2913 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2916 * Set whether scrollers should be draggable from any point in their
2917 * views, for all Elementary application windows.
2919 * @param enabled the thumb scroll state
2921 * @see elm_thumbscroll_enabled_get()
2922 * @ingroup Scrolling
2924 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2927 * Get the number of pixels one should travel while dragging a
2928 * scroller's view to actually trigger scrolling.
2930 * @return the thumb scroll threshould
2932 * One would use higher values for touch screens, in general, because
2933 * of their inherent imprecision.
2934 * @ingroup Scrolling
2936 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
2939 * Set the number of pixels one should travel while dragging a
2940 * scroller's view to actually trigger scrolling.
2942 * @param threshold the thumb scroll threshould
2944 * @see elm_thumbscroll_threshould_get()
2945 * @ingroup Scrolling
2947 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2950 * Set the number of pixels one should travel while dragging a
2951 * scroller's view to actually trigger scrolling, for all Elementary
2952 * application windows.
2954 * @param threshold the thumb scroll threshould
2956 * @see elm_thumbscroll_threshould_get()
2957 * @ingroup Scrolling
2959 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2962 * Get the minimum speed of mouse cursor movement which will trigger
2963 * list self scrolling animation after a mouse up event
2966 * @return the thumb scroll momentum threshould
2968 * @ingroup Scrolling
2970 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
2973 * Set the minimum speed of mouse cursor movement which will trigger
2974 * list self scrolling animation after a mouse up event
2977 * @param threshold the thumb scroll momentum threshould
2979 * @see elm_thumbscroll_momentum_threshould_get()
2980 * @ingroup Scrolling
2982 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
2985 * Set the minimum speed of mouse cursor movement which will trigger
2986 * list self scrolling animation after a mouse up event
2987 * (pixels/second), for all Elementary application windows.
2989 * @param threshold the thumb scroll momentum threshould
2991 * @see elm_thumbscroll_momentum_threshould_get()
2992 * @ingroup Scrolling
2994 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
2997 * Get the amount of inertia a scroller will impose at self scrolling
3000 * @return the thumb scroll friction
3002 * @ingroup Scrolling
3004 EAPI double elm_scroll_thumbscroll_friction_get(void);
3007 * Set the amount of inertia a scroller will impose at self scrolling
3010 * @param friction the thumb scroll friction
3012 * @see elm_thumbscroll_friction_get()
3013 * @ingroup Scrolling
3015 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
3018 * Set the amount of inertia a scroller will impose at self scrolling
3019 * animations, for all Elementary application windows.
3021 * @param friction the thumb scroll friction
3023 * @see elm_thumbscroll_friction_get()
3024 * @ingroup Scrolling
3026 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
3029 * Get the amount of lag between your actual mouse cursor dragging
3030 * movement and a scroller's view movement itself, while pushing it
3031 * into bounce state manually.
3033 * @return the thumb scroll border friction
3035 * @ingroup Scrolling
3037 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
3040 * Set the amount of lag between your actual mouse cursor dragging
3041 * movement and a scroller's view movement itself, while pushing it
3042 * into bounce state manually.
3044 * @param friction the thumb scroll border friction. @c 0.0 for
3045 * perfect synchrony between two movements, @c 1.0 for maximum
3048 * @see elm_thumbscroll_border_friction_get()
3049 * @note parameter value will get bound to 0.0 - 1.0 interval, always
3051 * @ingroup Scrolling
3053 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
3056 * Set the amount of lag between your actual mouse cursor dragging
3057 * movement and a scroller's view movement itself, while pushing it
3058 * into bounce state manually, for all Elementary application windows.
3060 * @param friction the thumb scroll border friction. @c 0.0 for
3061 * perfect synchrony between two movements, @c 1.0 for maximum
3064 * @see elm_thumbscroll_border_friction_get()
3065 * @note parameter value will get bound to 0.0 - 1.0 interval, always
3067 * @ingroup Scrolling
3069 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
3072 * Get the sensitivity amount which is be multiplied by the length of
3075 * @return the thumb scroll sensitivity friction
3077 * @ingroup Scrolling
3079 EAPI double elm_scroll_thumbscroll_sensitivity_friction_get(void);
3082 * Set the sensitivity amount which is be multiplied by the length of
3085 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
3086 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
3089 * @see elm_thumbscroll_sensitivity_friction_get()
3090 * @note parameter value will get bound to 0.1 - 1.0 interval, always
3092 * @ingroup Scrolling
3094 EAPI void elm_scroll_thumbscroll_sensitivity_friction_set(double friction);
3097 * Set the sensitivity amount which is be multiplied by the length of
3098 * mouse dragging, for all Elementary application windows.
3100 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
3101 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
3104 * @see elm_thumbscroll_sensitivity_friction_get()
3105 * @note parameter value will get bound to 0.1 - 1.0 interval, always
3107 * @ingroup Scrolling
3109 EAPI void elm_scroll_thumbscroll_sensitivity_friction_all_set(double friction);
3116 * @defgroup Scrollhints Scrollhints
3118 * Objects when inside a scroller can scroll, but this may not always be
3119 * desirable in certain situations. This allows an object to hint to itself
3120 * and parents to "not scroll" in one of 2 ways. If any child object of a
3121 * scroller has pushed a scroll freeze or hold then it affects all parent
3122 * scrollers until all children have released them.
3124 * 1. To hold on scrolling. This means just flicking and dragging may no
3125 * longer scroll, but pressing/dragging near an edge of the scroller will
3126 * still scroll. This is automatically used by the entry object when
3129 * 2. To totally freeze scrolling. This means it stops. until
3136 * Push the scroll hold by 1
3138 * This increments the scroll hold count by one. If it is more than 0 it will
3139 * take effect on the parents of the indicated object.
3141 * @param obj The object
3142 * @ingroup Scrollhints
3144 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3147 * Pop the scroll hold by 1
3149 * This decrements the scroll hold count by one. If it is more than 0 it will
3150 * take effect on the parents of the indicated object.
3152 * @param obj The object
3153 * @ingroup Scrollhints
3155 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3158 * Push the scroll freeze by 1
3160 * This increments the scroll freeze count by one. If it is more
3161 * than 0 it will take effect on the parents of the indicated
3164 * @param obj The object
3165 * @ingroup Scrollhints
3167 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3170 * Pop the scroll freeze by 1
3172 * This decrements the scroll freeze count by one. If it is more
3173 * than 0 it will take effect on the parents of the indicated
3176 * @param obj The object
3177 * @ingroup Scrollhints
3179 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3182 * Lock the scrolling of the given widget (and thus all parents)
3184 * This locks the given object from scrolling in the X axis (and implicitly
3185 * also locks all parent scrollers too from doing the same).
3187 * @param obj The object
3188 * @param lock The lock state (1 == locked, 0 == unlocked)
3189 * @ingroup Scrollhints
3191 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3194 * Lock the scrolling of the given widget (and thus all parents)
3196 * This locks the given object from scrolling in the Y axis (and implicitly
3197 * also locks all parent scrollers too from doing the same).
3199 * @param obj The object
3200 * @param lock The lock state (1 == locked, 0 == unlocked)
3201 * @ingroup Scrollhints
3203 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3206 * Get the scrolling lock of the given widget
3208 * This gets the lock for X axis scrolling.
3210 * @param obj The object
3211 * @ingroup Scrollhints
3213 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3216 * Get the scrolling lock of the given widget
3218 * This gets the lock for X axis scrolling.
3220 * @param obj The object
3221 * @ingroup Scrollhints
3223 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3230 * Send a signal to the widget edje object.
3232 * This function sends a signal to the edje object of the obj. An
3233 * edje program can respond to a signal by specifying matching
3234 * 'signal' and 'source' fields.
3236 * @param obj The object
3237 * @param emission The signal's name.
3238 * @param source The signal's source.
3241 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
3244 * Add a callback for a signal emitted by widget edje object.
3246 * This function connects a callback function to a signal emitted by the
3247 * edje object of the obj.
3248 * Globs can occur in either the emission or source name.
3250 * @param obj The object
3251 * @param emission The signal's name.
3252 * @param source The signal's source.
3253 * @param func The callback function to be executed when the signal is
3255 * @param data A pointer to data to pass in to the callback function.
3258 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);
3261 * Remove a signal-triggered callback from a widget edje object.
3263 * This function removes a callback, previoulsy attached to a
3264 * signal emitted by the edje object of the obj. The parameters
3265 * emission, source and func must match exactly those passed to a
3266 * previous call to elm_object_signal_callback_add(). The data
3267 * pointer that was passed to this call will be returned.
3269 * @param obj The object
3270 * @param emission The signal's name.
3271 * @param source The signal's source.
3272 * @param func The callback function to be executed when the signal is
3274 * @return The data pointer
3277 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);
3280 * Add a callback for input events (key up, key down, mouse wheel)
3281 * on a given Elementary widget
3283 * @param obj The widget to add an event callback on
3284 * @param func The callback function to be executed when the event
3286 * @param data Data to pass in to @p func
3288 * Every widget in an Elementary interface set to receive focus,
3289 * with elm_object_focus_allow_set(), will propagate @b all of its
3290 * key up, key down and mouse wheel input events up to its parent
3291 * object, and so on. All of the focusable ones in this chain which
3292 * had an event callback set, with this call, will be able to treat
3293 * those events. There are two ways of making the propagation of
3294 * these event upwards in the tree of widgets to @b cease:
3295 * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
3296 * the event was @b not processed, so the propagation will go on.
3297 * - The @c event_info pointer passed to @p func will contain the
3298 * event's structure and, if you OR its @c event_flags inner
3299 * value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
3300 * one has already handled it, thus killing the event's
3303 * @note Your event callback will be issued on those events taking
3304 * place only if no other child widget of @obj has consumed the
3307 * @note Not to be confused with @c
3308 * evas_object_event_callback_add(), which will add event callbacks
3309 * per type on general Evas objects (no event propagation
3310 * infrastructure taken in account).
3312 * @note Not to be confused with @c
3313 * elm_object_signal_callback_add(), which will add callbacks to @b
3314 * signals coming from a widget's theme, not input events.
3316 * @note Not to be confused with @c
3317 * edje_object_signal_callback_add(), which does the same as
3318 * elm_object_signal_callback_add(), but directly on an Edje
3321 * @note Not to be confused with @c
3322 * evas_object_smart_callback_add(), which adds callbacks to smart
3323 * objects' <b>smart events</b>, and not input events.
3325 * @see elm_object_event_callback_del()
3329 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3332 * Remove an event callback from a widget.
3334 * This function removes a callback, previoulsy attached to event emission
3336 * The parameters func and data must match exactly those passed to
3337 * a previous call to elm_object_event_callback_add(). The data pointer that
3338 * was passed to this call will be returned.
3340 * @param obj The object
3341 * @param func The callback function to be executed when the event is
3343 * @param data Data to pass in to the callback function.
3344 * @return The data pointer
3347 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3350 * Adjust size of an element for finger usage.
3352 * @param times_w How many fingers should fit horizontally
3353 * @param w Pointer to the width size to adjust
3354 * @param times_h How many fingers should fit vertically
3355 * @param h Pointer to the height size to adjust
3357 * This takes width and height sizes (in pixels) as input and a
3358 * size multiple (which is how many fingers you want to place
3359 * within the area, being "finger" the size set by
3360 * elm_finger_size_set()), and adjusts the size to be large enough
3361 * to accommodate the resulting size -- if it doesn't already
3362 * accommodate it. On return the @p w and @p h sizes pointed to by
3363 * these parameters will be modified, on those conditions.
3365 * @note This is kind of a low level Elementary call, most useful
3366 * on size evaluation times for widgets. An external user wouldn't
3367 * be calling, most of the time.
3371 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
3374 * Get the duration for occuring long press event.
3376 * @return Timeout for long press event
3377 * @ingroup Longpress
3379 EAPI double elm_longpress_timeout_get(void);
3382 * Set the duration for occuring long press event.
3384 * @param lonpress_timeout Timeout for long press event
3385 * @ingroup Longpress
3387 EAPI void elm_longpress_timeout_set(double longpress_timeout);
3390 * @defgroup Debug Debug
3391 * don't use it unless you are sure
3397 * Print Tree object hierarchy in stdout
3399 * @param obj The root object
3402 EAPI void elm_object_tree_dump(const Evas_Object *top);
3405 * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3407 * @param obj The root object
3408 * @param file The path of output file
3411 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3418 * @defgroup Theme Theme
3420 * Elementary uses Edje to theme its widgets, naturally. But for the most
3421 * part this is hidden behind a simpler interface that lets the user set
3422 * extensions and choose the style of widgets in a much easier way.
3424 * Instead of thinking in terms of paths to Edje files and their groups
3425 * each time you want to change the appearance of a widget, Elementary
3426 * works so you can add any theme file with extensions or replace the
3427 * main theme at one point in the application, and then just set the style
3428 * of widgets with elm_object_style_set() and related functions. Elementary
3429 * will then look in its list of themes for a matching group and apply it,
3430 * and when the theme changes midway through the application, all widgets
3431 * will be updated accordingly.
3433 * There are three concepts you need to know to understand how Elementary
3434 * theming works: default theme, extensions and overlays.
3436 * Default theme, obviously enough, is the one that provides the default
3437 * look of all widgets. End users can change the theme used by Elementary
3438 * by setting the @c ELM_THEME environment variable before running an
3439 * application, or globally for all programs using the @c elementary_config
3440 * utility. Applications can change the default theme using elm_theme_set(),
3441 * but this can go against the user wishes, so it's not an adviced practice.
3443 * Ideally, applications should find everything they need in the already
3444 * provided theme, but there may be occasions when that's not enough and
3445 * custom styles are required to correctly express the idea. For this
3446 * cases, Elementary has extensions.
3448 * Extensions allow the application developer to write styles of its own
3449 * to apply to some widgets. This requires knowledge of how each widget
3450 * is themed, as extensions will always replace the entire group used by
3451 * the widget, so important signals and parts need to be there for the
3452 * object to behave properly (see documentation of Edje for details).
3453 * Once the theme for the extension is done, the application needs to add
3454 * it to the list of themes Elementary will look into, using
3455 * elm_theme_extension_add(), and set the style of the desired widgets as
3456 * he would normally with elm_object_style_set().
3458 * Overlays, on the other hand, can replace the look of all widgets by
3459 * overriding the default style. Like extensions, it's up to the application
3460 * developer to write the theme for the widgets it wants, the difference
3461 * being that when looking for the theme, Elementary will check first the
3462 * list of overlays, then the set theme and lastly the list of extensions,
3463 * so with overlays it's possible to replace the default view and every
3464 * widget will be affected. This is very much alike to setting the whole
3465 * theme for the application and will probably clash with the end user
3466 * options, not to mention the risk of ending up with not matching styles
3467 * across the program. Unless there's a very special reason to use them,
3468 * overlays should be avoided for the resons exposed before.
3470 * All these theme lists are handled by ::Elm_Theme instances. Elementary
3471 * keeps one default internally and every function that receives one of
3472 * these can be called with NULL to refer to this default (except for
3473 * elm_theme_free()). It's possible to create a new instance of a
3474 * ::Elm_Theme to set other theme for a specific widget (and all of its
3475 * children), but this is as discouraged, if not even more so, than using
3476 * overlays. Don't use this unless you really know what you are doing.
3478 * But to be less negative about things, you can look at the following
3480 * @li @ref theme_example_01 "Using extensions"
3481 * @li @ref theme_example_02 "Using overlays"
3486 * @typedef Elm_Theme
3488 * Opaque handler for the list of themes Elementary looks for when
3489 * rendering widgets.
3491 * Stay out of this unless you really know what you are doing. For most
3492 * cases, sticking to the default is all a developer needs.
3494 typedef struct _Elm_Theme Elm_Theme;
3497 * Create a new specific theme
3499 * This creates an empty specific theme that only uses the default theme. A
3500 * specific theme has its own private set of extensions and overlays too
3501 * (which are empty by default). Specific themes do not fall back to themes
3502 * of parent objects. They are not intended for this use. Use styles, overlays
3503 * and extensions when needed, but avoid specific themes unless there is no
3504 * other way (example: you want to have a preview of a new theme you are
3505 * selecting in a "theme selector" window. The preview is inside a scroller
3506 * and should display what the theme you selected will look like, but not
3507 * actually apply it yet. The child of the scroller will have a specific
3508 * theme set to show this preview before the user decides to apply it to all
3511 EAPI Elm_Theme *elm_theme_new(void);
3513 * Free a specific theme
3515 * @param th The theme to free
3517 * This frees a theme created with elm_theme_new().
3519 EAPI void elm_theme_free(Elm_Theme *th);
3521 * Copy the theme fom the source to the destination theme
3523 * @param th The source theme to copy from
3524 * @param thdst The destination theme to copy data to
3526 * This makes a one-time static copy of all the theme config, extensions
3527 * and overlays from @p th to @p thdst. If @p th references a theme, then
3528 * @p thdst is also set to reference it, with all the theme settings,
3529 * overlays and extensions that @p th had.
3531 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3533 * Tell the source theme to reference the ref theme
3535 * @param th The theme that will do the referencing
3536 * @param thref The theme that is the reference source
3538 * This clears @p th to be empty and then sets it to refer to @p thref
3539 * so @p th acts as an override to @p thref, but where its overrides
3540 * don't apply, it will fall through to @p thref for configuration.
3542 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3544 * Return the theme referred to
3546 * @param th The theme to get the reference from
3547 * @return The referenced theme handle
3549 * This gets the theme set as the reference theme by elm_theme_ref_set().
3550 * If no theme is set as a reference, NULL is returned.
3552 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
3554 * Return the default theme
3556 * @return The default theme handle
3558 * This returns the internal default theme setup handle that all widgets
3559 * use implicitly unless a specific theme is set. This is also often use
3560 * as a shorthand of NULL.
3562 EAPI Elm_Theme *elm_theme_default_get(void);
3564 * Prepends a theme overlay to the list of overlays
3566 * @param th The theme to add to, or if NULL, the default theme
3567 * @param item The Edje file path to be used
3569 * Use this if your application needs to provide some custom overlay theme
3570 * (An Edje file that replaces some default styles of widgets) where adding
3571 * new styles, or changing system theme configuration is not possible. Do
3572 * NOT use this instead of a proper system theme configuration. Use proper
3573 * configuration files, profiles, environment variables etc. to set a theme
3574 * so that the theme can be altered by simple confiugration by a user. Using
3575 * this call to achieve that effect is abusing the API and will create lots
3578 * @see elm_theme_extension_add()
3580 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
3582 * Delete a theme overlay from the list of overlays
3584 * @param th The theme to delete from, or if NULL, the default theme
3585 * @param item The name of the theme overlay
3587 * @see elm_theme_overlay_add()
3589 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
3591 * Appends a theme extension to the list of extensions.
3593 * @param th The theme to add to, or if NULL, the default theme
3594 * @param item The Edje file path to be used
3596 * This is intended when an application needs more styles of widgets or new
3597 * widget themes that the default does not provide (or may not provide). The
3598 * application has "extended" usage by coming up with new custom style names
3599 * for widgets for specific uses, but as these are not "standard", they are
3600 * not guaranteed to be provided by a default theme. This means the
3601 * application is required to provide these extra elements itself in specific
3602 * Edje files. This call adds one of those Edje files to the theme search
3603 * path to be search after the default theme. The use of this call is
3604 * encouraged when default styles do not meet the needs of the application.
3605 * Use this call instead of elm_theme_overlay_add() for almost all cases.
3607 * @see elm_object_style_set()
3609 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
3611 * Deletes a theme extension from the list of extensions.
3613 * @param th The theme to delete from, or if NULL, the default theme
3614 * @param item The name of the theme extension
3616 * @see elm_theme_extension_add()
3618 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
3620 * Set the theme search order for the given theme
3622 * @param th The theme to set the search order, or if NULL, the default theme
3623 * @param theme Theme search string
3625 * This sets the search string for the theme in path-notation from first
3626 * theme to search, to last, delimited by the : character. Example:
3628 * "shiny:/path/to/file.edj:default"
3630 * See the ELM_THEME environment variable for more information.
3632 * @see elm_theme_get()
3633 * @see elm_theme_list_get()
3635 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
3637 * Return the theme search order
3639 * @param th The theme to get the search order, or if NULL, the default theme
3640 * @return The internal search order path
3642 * This function returns a colon separated string of theme elements as
3643 * returned by elm_theme_list_get().
3645 * @see elm_theme_set()
3646 * @see elm_theme_list_get()
3648 EAPI const char *elm_theme_get(Elm_Theme *th);
3650 * Return a list of theme elements to be used in a theme.
3652 * @param th Theme to get the list of theme elements from.
3653 * @return The internal list of theme elements
3655 * This returns the internal list of theme elements (will only be valid as
3656 * long as the theme is not modified by elm_theme_set() or theme is not
3657 * freed by elm_theme_free(). This is a list of strings which must not be
3658 * altered as they are also internal. If @p th is NULL, then the default
3659 * theme element list is returned.
3661 * A theme element can consist of a full or relative path to a .edj file,
3662 * or a name, without extension, for a theme to be searched in the known
3663 * theme paths for Elemementary.
3665 * @see elm_theme_set()
3666 * @see elm_theme_get()
3668 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3670 * Return the full patrh for a theme element
3672 * @param f The theme element name
3673 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3674 * @return The full path to the file found.
3676 * This returns a string you should free with free() on success, NULL on
3677 * failure. This will search for the given theme element, and if it is a
3678 * full or relative path element or a simple searchable name. The returned
3679 * path is the full path to the file, if searched, and the file exists, or it
3680 * is simply the full path given in the element or a resolved path if
3681 * relative to home. The @p in_search_path boolean pointed to is set to
3682 * EINA_TRUE if the file was a searchable file andis in the search path,
3683 * and EINA_FALSE otherwise.
3685 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3687 * Flush the current theme.
3689 * @param th Theme to flush
3691 * This flushes caches that let elementary know where to find theme elements
3692 * in the given theme. If @p th is NULL, then the default theme is flushed.
3693 * Call this function if source theme data has changed in such a way as to
3694 * make any caches Elementary kept invalid.
3696 EAPI void elm_theme_flush(Elm_Theme *th);
3698 * This flushes all themes (default and specific ones).
3700 * This will flush all themes in the current application context, by calling
3701 * elm_theme_flush() on each of them.
3703 EAPI void elm_theme_full_flush(void);
3705 * Set the theme for all elementary using applications on the current display
3707 * @param theme The name of the theme to use. Format same as the ELM_THEME
3708 * environment variable.
3710 EAPI void elm_theme_all_set(const char *theme);
3712 * Return a list of theme elements in the theme search path
3714 * @return A list of strings that are the theme element names.
3716 * This lists all available theme files in the standard Elementary search path
3717 * for theme elements, and returns them in alphabetical order as theme
3718 * element names in a list of strings. Free this with
3719 * elm_theme_name_available_list_free() when you are done with the list.
3721 EAPI Eina_List *elm_theme_name_available_list_new(void);
3723 * Free the list returned by elm_theme_name_available_list_new()
3725 * This frees the list of themes returned by
3726 * elm_theme_name_available_list_new(). Once freed the list should no longer
3727 * be used. a new list mys be created.
3729 EAPI void elm_theme_name_available_list_free(Eina_List *list);
3731 * Set a specific theme to be used for this object and its children
3733 * @param obj The object to set the theme on
3734 * @param th The theme to set
3736 * This sets a specific theme that will be used for the given object and any
3737 * child objects it has. If @p th is NULL then the theme to be used is
3738 * cleared and the object will inherit its theme from its parent (which
3739 * ultimately will use the default theme if no specific themes are set).
3741 * Use special themes with great care as this will annoy users and make
3742 * configuration difficult. Avoid any custom themes at all if it can be
3745 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3747 * Get the specific theme to be used
3749 * @param obj The object to get the specific theme from
3750 * @return The specifc theme set.
3752 * This will return a specific theme set, or NULL if no specific theme is
3753 * set on that object. It will not return inherited themes from parents, only
3754 * the specific theme set for that specific object. See elm_object_theme_set()
3755 * for more information.
3757 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3760 * Get a data item from a theme
3762 * @param th The theme, or NULL for default theme
3763 * @param key The data key to search with
3764 * @return The data value, or NULL on failure
3766 * This function is used to return data items from edc in @p th, an overlay, or an extension.
3767 * It works the same way as edje_file_data_get() except that the return is stringshared.
3769 EAPI const char *elm_theme_data_get(Elm_Theme *th, const char *key) EINA_ARG_NONNULL(2);
3775 /** @defgroup Win Win
3777 * @image html img/widget/win/preview-00.png
3778 * @image latex img/widget/win/preview-00.eps
3780 * The window class of Elementary. Contains functions to manipulate
3781 * windows. The Evas engine used to render the window contents is specified
3782 * in the system or user elementary config files (whichever is found last),
3783 * and can be overridden with the ELM_ENGINE environment variable for
3784 * testing. Engines that may be supported (depending on Evas and Ecore-Evas
3785 * compilation setup and modules actually installed at runtime) are (listed
3786 * in order of best supported and most likely to be complete and work to
3789 * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3790 * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3792 * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3794 * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3796 * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3798 * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3799 * rendering using SDL as the buffer)
3800 * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3801 * GDI with software)
3802 * @li "dfb", "directfb" (Rendering to a DirectFB window)
3803 * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3804 * grayscale using dedicated 8bit software engine in X11)
3805 * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3806 * X11 using 16bit software engine)
3807 * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3808 * (Windows CE rendering via GDI with 16bit software renderer)
3809 * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3810 * buffer with 16bit software renderer)
3811 * @li "ews" (rendering to EWS - Ecore + Evas Single Process Windowing System)
3812 * @li "gl-cocoa", "gl_cocoa", "opengl-cocoa", "opengl_cocoa" (OpenGL rendering in Cocoa)
3813 * @li "psl1ght" (PS3 rendering using PSL1GHT)
3815 * All engines use a simple string to select the engine to render, EXCEPT
3816 * the "shot" engine. This actually encodes the output of the virtual
3817 * screenshot and how long to delay in the engine string. The engine string
3818 * is encoded in the following way:
3820 * "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3822 * Where options are separated by a ":" char if more than one option is
3823 * given, with delay, if provided being the first option and file the last
3824 * (order is important). The delay specifies how long to wait after the
3825 * window is shown before doing the virtual "in memory" rendering and then
3826 * save the output to the file specified by the file option (and then exit).
3827 * If no delay is given, the default is 0.5 seconds. If no file is given the
3828 * default output file is "out.png". Repeat option is for continous
3829 * capturing screenshots. Repeat range is from 1 to 999 and filename is
3830 * fixed to "out001.png" Some examples of using the shot engine:
3832 * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3833 * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3834 * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3835 * ELM_ENGINE="shot:delay=2.0" elementary_test
3836 * ELM_ENGINE="shot:" elementary_test
3838 * Signals that you can add callbacks for are:
3840 * @li "delete,request": the user requested to close the window. See
3841 * elm_win_autodel_set().
3842 * @li "focus,in": window got focus
3843 * @li "focus,out": window lost focus
3844 * @li "moved": window that holds the canvas was moved
3847 * @li @ref win_example_01
3852 * Defines the types of window that can be created
3854 * These are hints set on the window so that a running Window Manager knows
3855 * how the window should be handled and/or what kind of decorations it
3858 * Currently, only the X11 backed engines use them.
3860 typedef enum _Elm_Win_Type
3862 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3863 window. Almost every window will be created with this
3865 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3866 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3867 window holding desktop icons. */
3868 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3869 be kept on top of any other window by the Window
3871 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3873 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3874 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3876 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3877 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3878 entry in a menubar is clicked. Typically used
3879 with elm_win_override_set(). This hint exists
3880 for completion only, as the EFL way of
3881 implementing a menu would not normally use a
3882 separate window for its contents. */
3883 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3884 triggered by right-clicking an object. */
3885 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3886 explanatory text that typically appear after the
3887 mouse cursor hovers over an object for a while.
3888 Typically used with elm_win_override_set() and also
3889 not very commonly used in the EFL. */
3890 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3891 battery life or a new E-Mail received. */
3892 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3893 usually used in the EFL. */
3894 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3895 object being dragged across different windows, or even
3896 applications. Typically used with
3897 elm_win_override_set(). */
3898 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3899 buffer. No actual window is created for this
3900 type, instead the window and all of its
3901 contents will be rendered to an image buffer.
3902 This allows to have children window inside a
3903 parent one just like any other object would
3904 be, and do other things like applying @c
3905 Evas_Map effects to it. This is the only type
3906 of window that requires the @c parent
3907 parameter of elm_win_add() to be a valid @c
3912 * The differents layouts that can be requested for the virtual keyboard.
3914 * When the application window is being managed by Illume, it may request
3915 * any of the following layouts for the virtual keyboard.
3917 typedef enum _Elm_Win_Keyboard_Mode
3919 ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3920 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3921 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3922 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3923 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3924 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3925 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3926 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3927 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3928 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3929 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3930 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3931 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3932 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3933 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3934 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3935 } Elm_Win_Keyboard_Mode;
3938 * Available commands that can be sent to the Illume manager.
3940 * When running under an Illume session, a window may send commands to the
3941 * Illume manager to perform different actions.
3943 typedef enum _Elm_Illume_Command
3945 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3947 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3949 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3951 ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3952 } Elm_Illume_Command;
3955 * Adds a window object. If this is the first window created, pass NULL as
3958 * @param parent Parent object to add the window to, or NULL
3959 * @param name The name of the window
3960 * @param type The window type, one of #Elm_Win_Type.
3962 * The @p parent paramter can be @c NULL for every window @p type except
3963 * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3964 * which the image object will be created.
3966 * @return The created object, or NULL on failure
3968 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3970 * Adds a window object with standard setup
3972 * @param name The name of the window
3973 * @param title The title for the window
3975 * This creates a window like elm_win_add() but also puts in a standard
3976 * background with elm_bg_add(), as well as setting the window title to
3977 * @p title. The window type created is of type ELM_WIN_BASIC, with NULL
3978 * as the parent widget.
3980 * @return The created object, or NULL on failure
3982 * @see elm_win_add()
3984 EAPI Evas_Object *elm_win_util_standard_add(const char *name, const char *title);
3986 * Add @p subobj as a resize object of window @p obj.
3989 * Setting an object as a resize object of the window means that the
3990 * @p subobj child's size and position will be controlled by the window
3991 * directly. That is, the object will be resized to match the window size
3992 * and should never be moved or resized manually by the developer.
3994 * In addition, resize objects of the window control what the minimum size
3995 * of it will be, as well as whether it can or not be resized by the user.
3997 * For the end user to be able to resize a window by dragging the handles
3998 * or borders provided by the Window Manager, or using any other similar
3999 * mechanism, all of the resize objects in the window should have their
4000 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
4002 * @param obj The window object
4003 * @param subobj The resize object to add
4005 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
4007 * Delete @p subobj as a resize object of window @p obj.
4009 * This function removes the object @p subobj from the resize objects of
4010 * the window @p obj. It will not delete the object itself, which will be
4011 * left unmanaged and should be deleted by the developer, manually handled
4012 * or set as child of some other container.
4014 * @param obj The window object
4015 * @param subobj The resize object to add
4017 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
4019 * Set the title of the window
4021 * @param obj The window object
4022 * @param title The title to set
4024 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
4026 * Get the title of the window
4028 * The returned string is an internal one and should not be freed or
4029 * modified. It will also be rendered invalid if a new title is set or if
4030 * the window is destroyed.
4032 * @param obj The window object
4035 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4037 * Set the window's autodel state.
4039 * When closing the window in any way outside of the program control, like
4040 * pressing the X button in the titlebar or using a command from the
4041 * Window Manager, a "delete,request" signal is emitted to indicate that
4042 * this event occurred and the developer can take any action, which may
4043 * include, or not, destroying the window object.
4045 * When the @p autodel parameter is set, the window will be automatically
4046 * destroyed when this event occurs, after the signal is emitted.
4047 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
4048 * and is up to the program to do so when it's required.
4050 * @param obj The window object
4051 * @param autodel If true, the window will automatically delete itself when
4054 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
4056 * Get the window's autodel state.
4058 * @param obj The window object
4059 * @return If the window will automatically delete itself when closed
4061 * @see elm_win_autodel_set()
4063 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4065 * Activate a window object.
4067 * This function sends a request to the Window Manager to activate the
4068 * window pointed by @p obj. If honored by the WM, the window will receive
4069 * the keyboard focus.
4071 * @note This is just a request that a Window Manager may ignore, so calling
4072 * this function does not ensure in any way that the window will be the
4073 * active one after it.
4075 * @param obj The window object
4077 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4079 * Lower a window object.
4081 * Places the window pointed by @p obj at the bottom of the stack, so that
4082 * no other window is covered by it.
4084 * If elm_win_override_set() is not set, the Window Manager may ignore this
4087 * @param obj The window object
4089 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
4091 * Raise a window object.
4093 * Places the window pointed by @p obj at the top of the stack, so that it's
4094 * not covered by any other window.
4096 * If elm_win_override_set() is not set, the Window Manager may ignore this
4099 * @param obj The window object
4101 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
4103 * Set the borderless state of a window.
4105 * This function requests the Window Manager to not draw any decoration
4106 * around the window.
4108 * @param obj The window object
4109 * @param borderless If true, the window is borderless
4111 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
4113 * Get the borderless state of a window.
4115 * @param obj The window object
4116 * @return If true, the window is borderless
4118 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4120 * Set the shaped state of a window.
4122 * Shaped windows, when supported, will render the parts of the window that
4123 * has no content, transparent.
4125 * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
4126 * background object or cover the entire window in any other way, or the
4127 * parts of the canvas that have no data will show framebuffer artifacts.
4129 * @param obj The window object
4130 * @param shaped If true, the window is shaped
4132 * @see elm_win_alpha_set()
4134 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
4136 * Get the shaped state of a window.
4138 * @param obj The window object
4139 * @return If true, the window is shaped
4141 * @see elm_win_shaped_set()
4143 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4145 * Set the alpha channel state of a window.
4147 * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
4148 * possibly making parts of the window completely or partially transparent.
4149 * This is also subject to the underlying system supporting it, like for
4150 * example, running under a compositing manager. If no compositing is
4151 * available, enabling this option will instead fallback to using shaped
4152 * windows, with elm_win_shaped_set().
4154 * @param obj The window object
4155 * @param alpha If true, the window has an alpha channel
4157 * @see elm_win_alpha_set()
4159 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
4161 * Get the transparency state of a window.
4163 * @param obj The window object
4164 * @return If true, the window is transparent
4166 * @see elm_win_transparent_set()
4168 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4170 * Set the transparency state of a window.
4172 * Use elm_win_alpha_set() instead.
4174 * @param obj The window object
4175 * @param transparent If true, the window is transparent
4177 * @see elm_win_alpha_set()
4179 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
4181 * Get the alpha channel state of a window.
4183 * @param obj The window object
4184 * @return If true, the window has an alpha channel
4186 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4188 * Set the override state of a window.
4190 * A window with @p override set to EINA_TRUE will not be managed by the
4191 * Window Manager. This means that no decorations of any kind will be shown
4192 * for it, moving and resizing must be handled by the application, as well
4193 * as the window visibility.
4195 * This should not be used for normal windows, and even for not so normal
4196 * ones, it should only be used when there's a good reason and with a lot
4197 * of care. Mishandling override windows may result situations that
4198 * disrupt the normal workflow of the end user.
4200 * @param obj The window object
4201 * @param override If true, the window is overridden
4203 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
4205 * Get the override state of a window.
4207 * @param obj The window object
4208 * @return If true, the window is overridden
4210 * @see elm_win_override_set()
4212 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4214 * Set the fullscreen state of a window.
4216 * @param obj The window object
4217 * @param fullscreen If true, the window is fullscreen
4219 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
4221 * Get the fullscreen state of a window.
4223 * @param obj The window object
4224 * @return If true, the window is fullscreen
4226 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4228 * Set the maximized state of a window.
4230 * @param obj The window object
4231 * @param maximized If true, the window is maximized
4233 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
4235 * Get the maximized state of a window.
4237 * @param obj The window object
4238 * @return If true, the window is maximized
4240 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4242 * Set the iconified state of a window.
4244 * @param obj The window object
4245 * @param iconified If true, the window is iconified
4247 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
4249 * Get the iconified state of a window.
4251 * @param obj The window object
4252 * @return If true, the window is iconified
4254 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4256 * Set the layer of the window.
4258 * What this means exactly will depend on the underlying engine used.
4260 * In the case of X11 backed engines, the value in @p layer has the
4261 * following meanings:
4262 * @li < 3: The window will be placed below all others.
4263 * @li > 5: The window will be placed above all others.
4264 * @li other: The window will be placed in the default layer.
4266 * @param obj The window object
4267 * @param layer The layer of the window
4269 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
4271 * Get the layer of the window.
4273 * @param obj The window object
4274 * @return The layer of the window
4276 * @see elm_win_layer_set()
4278 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4280 * Set the rotation of the window.
4282 * Most engines only work with multiples of 90.
4284 * This function is used to set the orientation of the window @p obj to
4285 * match that of the screen. The window itself will be resized to adjust
4286 * to the new geometry of its contents. If you want to keep the window size,
4287 * see elm_win_rotation_with_resize_set().
4289 * @param obj The window object
4290 * @param rotation The rotation of the window, in degrees (0-360),
4291 * counter-clockwise.
4293 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4295 * Rotates the window and resizes it.
4297 * Like elm_win_rotation_set(), but it also resizes the window's contents so
4298 * that they fit inside the current window geometry.
4300 * @param obj The window object
4301 * @param layer The rotation of the window in degrees (0-360),
4302 * counter-clockwise.
4304 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4306 * Get the rotation of the window.
4308 * @param obj The window object
4309 * @return The rotation of the window in degrees (0-360)
4311 * @see elm_win_rotation_set()
4312 * @see elm_win_rotation_with_resize_set()
4314 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4316 * Set the sticky state of the window.
4318 * Hints the Window Manager that the window in @p obj should be left fixed
4319 * at its position even when the virtual desktop it's on moves or changes.
4321 * @param obj The window object
4322 * @param sticky If true, the window's sticky state is enabled
4324 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
4326 * Get the sticky state of the window.
4328 * @param obj The window object
4329 * @return If true, the window's sticky state is enabled
4331 * @see elm_win_sticky_set()
4333 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4335 * Set if this window is an illume conformant window
4337 * @param obj The window object
4338 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
4340 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
4342 * Get if this window is an illume conformant window
4344 * @param obj The window object
4345 * @return A boolean if this window is illume conformant or not
4347 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4349 * Set a window to be an illume quickpanel window
4351 * By default window objects are not quickpanel windows.
4353 * @param obj The window object
4354 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4356 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4358 * Get if this window is a quickpanel or not
4360 * @param obj The window object
4361 * @return A boolean if this window is a quickpanel or not
4363 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4365 * Set the major priority of a quickpanel window
4367 * @param obj The window object
4368 * @param priority The major priority for this quickpanel
4370 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4372 * Get the major priority of a quickpanel window
4374 * @param obj The window object
4375 * @return The major priority of this quickpanel
4377 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4379 * Set the minor priority of a quickpanel window
4381 * @param obj The window object
4382 * @param priority The minor priority for this quickpanel
4384 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4386 * Get the minor priority of a quickpanel window
4388 * @param obj The window object
4389 * @return The minor priority of this quickpanel
4391 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4393 * Set which zone this quickpanel should appear in
4395 * @param obj The window object
4396 * @param zone The requested zone for this quickpanel
4398 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4400 * Get which zone this quickpanel should appear in
4402 * @param obj The window object
4403 * @return The requested zone for this quickpanel
4405 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4407 * Set the window to be skipped by keyboard focus
4409 * This sets the window to be skipped by normal keyboard input. This means
4410 * a window manager will be asked to not focus this window as well as omit
4411 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4413 * Call this and enable it on a window BEFORE you show it for the first time,
4414 * otherwise it may have no effect.
4416 * Use this for windows that have only output information or might only be
4417 * interacted with by the mouse or fingers, and never for typing input.
4418 * Be careful that this may have side-effects like making the window
4419 * non-accessible in some cases unless the window is specially handled. Use
4422 * @param obj The window object
4423 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4425 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4427 * Send a command to the windowing environment
4429 * This is intended to work in touchscreen or small screen device
4430 * environments where there is a more simplistic window management policy in
4431 * place. This uses the window object indicated to select which part of the
4432 * environment to control (the part that this window lives in), and provides
4433 * a command and an optional parameter structure (use NULL for this if not
4436 * @param obj The window object that lives in the environment to control
4437 * @param command The command to send
4438 * @param params Optional parameters for the command
4440 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4442 * Get the inlined image object handle
4444 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4445 * then the window is in fact an evas image object inlined in the parent
4446 * canvas. You can get this object (be careful to not manipulate it as it
4447 * is under control of elementary), and use it to do things like get pixel
4448 * data, save the image to a file, etc.
4450 * @param obj The window object to get the inlined image from
4451 * @return The inlined image object, or NULL if none exists
4453 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4455 * Set the enabled status for the focus highlight in a window
4457 * This function will enable or disable the focus highlight only for the
4458 * given window, regardless of the global setting for it
4460 * @param obj The window where to enable the highlight
4461 * @param enabled The enabled value for the highlight
4463 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4465 * Get the enabled value of the focus highlight for this window
4467 * @param obj The window in which to check if the focus highlight is enabled
4469 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4471 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4473 * Set the style for the focus highlight on this window
4475 * Sets the style to use for theming the highlight of focused objects on
4476 * the given window. If @p style is NULL, the default will be used.
4478 * @param obj The window where to set the style
4479 * @param style The style to set
4481 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4483 * Get the style set for the focus highlight object
4485 * Gets the style set for this windows highilght object, or NULL if none
4488 * @param obj The window to retrieve the highlights style from
4490 * @return The style set or NULL if none was. Default is used in that case.
4492 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4494 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4495 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4496 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4497 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4498 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4499 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4500 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4502 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4503 * (blank mouse, private mouse obj, defaultmouse)
4507 * Sets the keyboard mode of the window.
4509 * @param obj The window object
4510 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4512 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4514 * Gets the keyboard mode of the window.
4516 * @param obj The window object
4517 * @return The mode, one of #Elm_Win_Keyboard_Mode
4519 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4521 * Sets whether the window is a keyboard.
4523 * @param obj The window object
4524 * @param is_keyboard If true, the window is a virtual keyboard
4526 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4528 * Gets whether the window is a keyboard.
4530 * @param obj The window object
4531 * @return If the window is a virtual keyboard
4533 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4536 * Get the screen position of a window.
4538 * @param obj The window object
4539 * @param x The int to store the x coordinate to
4540 * @param y The int to store the y coordinate to
4542 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4548 * @defgroup Inwin Inwin
4550 * @image html img/widget/inwin/preview-00.png
4551 * @image latex img/widget/inwin/preview-00.eps
4552 * @image html img/widget/inwin/preview-01.png
4553 * @image latex img/widget/inwin/preview-01.eps
4554 * @image html img/widget/inwin/preview-02.png
4555 * @image latex img/widget/inwin/preview-02.eps
4557 * An inwin is a window inside a window that is useful for a quick popup.
4558 * It does not hover.
4560 * It works by creating an object that will occupy the entire window, so it
4561 * must be created using an @ref Win "elm_win" as parent only. The inwin
4562 * object can be hidden or restacked below every other object if it's
4563 * needed to show what's behind it without destroying it. If this is done,
4564 * the elm_win_inwin_activate() function can be used to bring it back to
4565 * full visibility again.
4567 * There are three styles available in the default theme. These are:
4568 * @li default: The inwin is sized to take over most of the window it's
4570 * @li minimal: The size of the inwin will be the minimum necessary to show
4572 * @li minimal_vertical: Horizontally, the inwin takes as much space as
4573 * possible, but it's sized vertically the most it needs to fit its\
4576 * Some examples of Inwin can be found in the following:
4577 * @li @ref inwin_example_01
4582 * Adds an inwin to the current window
4584 * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4585 * Never call this function with anything other than the top-most window
4586 * as its parameter, unless you are fond of undefined behavior.
4588 * After creating the object, the widget will set itself as resize object
4589 * for the window with elm_win_resize_object_add(), so when shown it will
4590 * appear to cover almost the entire window (how much of it depends on its
4591 * content and the style used). It must not be added into other container
4592 * objects and it needs not be moved or resized manually.
4594 * @param parent The parent object
4595 * @return The new object or NULL if it cannot be created
4597 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4599 * Activates an inwin object, ensuring its visibility
4601 * This function will make sure that the inwin @p obj is completely visible
4602 * by calling evas_object_show() and evas_object_raise() on it, to bring it
4603 * to the front. It also sets the keyboard focus to it, which will be passed
4606 * The object's theme will also receive the signal "elm,action,show" with
4609 * @param obj The inwin to activate
4611 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4613 * Set the content of an inwin object.
4615 * Once the content object is set, a previously set one will be deleted.
4616 * If you want to keep that old content object, use the
4617 * elm_win_inwin_content_unset() function.
4619 * @param obj The inwin object
4620 * @param content The object to set as content
4622 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4624 * Get the content of an inwin object.
4626 * Return the content object which is set for this widget.
4628 * The returned object is valid as long as the inwin is still alive and no
4629 * other content is set on it. Deleting the object will notify the inwin
4630 * about it and this one will be left empty.
4632 * If you need to remove an inwin's content to be reused somewhere else,
4633 * see elm_win_inwin_content_unset().
4635 * @param obj The inwin object
4636 * @return The content that is being used
4638 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4640 * Unset the content of an inwin object.
4642 * Unparent and return the content object which was set for this widget.
4644 * @param obj The inwin object
4645 * @return The content that was being used
4647 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4651 /* X specific calls - won't work on non-x engines (return 0) */
4654 * Get the Ecore_X_Window of an Evas_Object
4656 * @param obj The object
4658 * @return The Ecore_X_Window of @p obj
4662 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4664 /* smart callbacks called:
4665 * "delete,request" - the user requested to delete the window
4666 * "focus,in" - window got focus
4667 * "focus,out" - window lost focus
4668 * "moved" - window that holds the canvas was moved
4674 * @image html img/widget/bg/preview-00.png
4675 * @image latex img/widget/bg/preview-00.eps
4677 * @brief Background object, used for setting a solid color, image or Edje
4678 * group as background to a window or any container object.
4680 * The bg object is used for setting a solid background to a window or
4681 * packing into any container object. It works just like an image, but has
4682 * some properties useful to a background, like setting it to tiled,
4683 * centered, scaled or stretched.
4685 * Default contents parts of the bg widget that you can use for are:
4686 * @li "overlay" - overlay of the bg
4688 * Here is some sample code using it:
4689 * @li @ref bg_01_example_page
4690 * @li @ref bg_02_example_page
4691 * @li @ref bg_03_example_page
4695 typedef enum _Elm_Bg_Option
4697 ELM_BG_OPTION_CENTER, /**< center the background */
4698 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
4699 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4700 ELM_BG_OPTION_TILE /**< tile background at its original size */
4704 * Add a new background to the parent
4706 * @param parent The parent object
4707 * @return The new object or NULL if it cannot be created
4711 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4714 * Set the file (image or edje) used for the background
4716 * @param obj The bg object
4717 * @param file The file path
4718 * @param group Optional key (group in Edje) within the file
4720 * This sets the image file used in the background object. The image (or edje)
4721 * will be stretched (retaining aspect if its an image file) to completely fill
4722 * the bg object. This may mean some parts are not visible.
4724 * @note Once the image of @p obj is set, a previously set one will be deleted,
4725 * even if @p file is NULL.
4729 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4732 * Get the file (image or edje) used for the background
4734 * @param obj The bg object
4735 * @param file The file path
4736 * @param group Optional key (group in Edje) within the file
4740 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4743 * Set the option used for the background image
4745 * @param obj The bg object
4746 * @param option The desired background option (TILE, SCALE)
4748 * This sets the option used for manipulating the display of the background
4749 * image. The image can be tiled or scaled.
4753 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4756 * Get the option used for the background image
4758 * @param obj The bg object
4759 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4763 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4765 * Set the option used for the background color
4767 * @param obj The bg object
4772 * This sets the color used for the background rectangle. Its range goes
4777 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4779 * Get the option used for the background color
4781 * @param obj The bg object
4788 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4791 * Set the overlay object used for the background object.
4793 * @param obj The bg object
4794 * @param overlay The overlay object
4796 * This provides a way for elm_bg to have an 'overlay' that will be on top
4797 * of the bg. Once the over object is set, a previously set one will be
4798 * deleted, even if you set the new one to NULL. If you want to keep that
4799 * old content object, use the elm_bg_overlay_unset() function.
4801 * @deprecated use elm_object_part_content_set() instead
4806 EINA_DEPRECATED EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4809 * Get the overlay object used for the background object.
4811 * @param obj The bg object
4812 * @return The content that is being used
4814 * Return the content object which is set for this widget
4816 * @deprecated use elm_object_part_content_get() instead
4820 EINA_DEPRECATED EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4823 * Get the overlay object used for the background object.
4825 * @param obj The bg object
4826 * @return The content that was being used
4828 * Unparent and return the overlay object which was set for this widget
4830 * @deprecated use elm_object_part_content_unset() instead
4834 EINA_DEPRECATED EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4837 * Set the size of the pixmap representation of the image.
4839 * This option just makes sense if an image is going to be set in the bg.
4841 * @param obj The bg object
4842 * @param w The new width of the image pixmap representation.
4843 * @param h The new height of the image pixmap representation.
4845 * This function sets a new size for pixmap representation of the given bg
4846 * image. It allows the image to be loaded already in the specified size,
4847 * reducing the memory usage and load time when loading a big image with load
4848 * size set to a smaller size.
4850 * NOTE: this is just a hint, the real size of the pixmap may differ
4851 * depending on the type of image being loaded, being bigger than requested.
4855 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4856 /* smart callbacks called:
4860 * @defgroup Icon Icon
4862 * @image html img/widget/icon/preview-00.png
4863 * @image latex img/widget/icon/preview-00.eps
4865 * An object that provides standard icon images (delete, edit, arrows, etc.)
4866 * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4868 * The icon image requested can be in the elementary theme, or in the
4869 * freedesktop.org paths. It's possible to set the order of preference from
4870 * where the image will be used.
4872 * This API is very similar to @ref Image, but with ready to use images.
4874 * Default images provided by the theme are described below.
4876 * The first list contains icons that were first intended to be used in
4877 * toolbars, but can be used in many other places too:
4893 * Now some icons that were designed to be used in menus (but again, you can
4894 * use them anywhere else):
4899 * @li menu/arrow_down
4900 * @li menu/arrow_left
4901 * @li menu/arrow_right
4910 * And here we have some media player specific icons:
4911 * @li media_player/forward
4912 * @li media_player/info
4913 * @li media_player/next
4914 * @li media_player/pause
4915 * @li media_player/play
4916 * @li media_player/prev
4917 * @li media_player/rewind
4918 * @li media_player/stop
4920 * Signals that you can add callbacks for are:
4922 * "clicked" - This is called when a user has clicked the icon
4924 * An example of usage for this API follows:
4925 * @li @ref tutorial_icon
4933 typedef enum _Elm_Icon_Type
4940 * @enum _Elm_Icon_Lookup_Order
4941 * @typedef Elm_Icon_Lookup_Order
4943 * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4944 * theme, FDO paths, or both?
4948 typedef enum _Elm_Icon_Lookup_Order
4950 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4951 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4952 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
4953 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
4954 } Elm_Icon_Lookup_Order;
4957 * Add a new icon object to the parent.
4959 * @param parent The parent object
4960 * @return The new object or NULL if it cannot be created
4962 * @see elm_icon_file_set()
4966 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4968 * Set the file that will be used as icon.
4970 * @param obj The icon object
4971 * @param file The path to file that will be used as icon image
4972 * @param group The group that the icon belongs to an edje file
4974 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4976 * @note The icon image set by this function can be changed by
4977 * elm_icon_standard_set().
4979 * @see elm_icon_file_get()
4983 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4985 * Set a location in memory to be used as an icon
4987 * @param obj The icon object
4988 * @param img The binary data that will be used as an image
4989 * @param size The size of binary data @p img
4990 * @param format Optional format of @p img to pass to the image loader
4991 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
4993 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4995 * @note The icon image set by this function can be changed by
4996 * elm_icon_standard_set().
5000 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);
5002 * Get the file that will be used as icon.
5004 * @param obj The icon object
5005 * @param file The path to file that will be used as the icon image
5006 * @param group The group that the icon belongs to, in edje file
5008 * @see elm_icon_file_set()
5012 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5013 EAPI void elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5015 * Set the icon by icon standards names.
5017 * @param obj The icon object
5018 * @param name The icon name
5020 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5022 * For example, freedesktop.org defines standard icon names such as "home",
5023 * "network", etc. There can be different icon sets to match those icon
5024 * keys. The @p name given as parameter is one of these "keys", and will be
5025 * used to look in the freedesktop.org paths and elementary theme. One can
5026 * change the lookup order with elm_icon_order_lookup_set().
5028 * If name is not found in any of the expected locations and it is the
5029 * absolute path of an image file, this image will be used.
5031 * @note The icon image set by this function can be changed by
5032 * elm_icon_file_set().
5034 * @see elm_icon_standard_get()
5035 * @see elm_icon_file_set()
5039 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
5041 * Get the icon name set by icon standard names.
5043 * @param obj The icon object
5044 * @return The icon name
5046 * If the icon image was set using elm_icon_file_set() instead of
5047 * elm_icon_standard_set(), then this function will return @c NULL.
5049 * @see elm_icon_standard_set()
5053 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5055 * Set the smooth scaling for an icon object.
5057 * @param obj The icon object
5058 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5059 * otherwise. Default is @c EINA_TRUE.
5061 * Set the scaling algorithm to be used when scaling the icon image. Smooth
5062 * scaling provides a better resulting image, but is slower.
5064 * The smooth scaling should be disabled when making animations that change
5065 * the icon size, since they will be faster. Animations that don't require
5066 * resizing of the icon can keep the smooth scaling enabled (even if the icon
5067 * is already scaled, since the scaled icon image will be cached).
5069 * @see elm_icon_smooth_get()
5073 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5075 * Get whether smooth scaling is enabled for an icon object.
5077 * @param obj The icon object
5078 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5080 * @see elm_icon_smooth_set()
5084 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5086 * Disable scaling of this object.
5088 * @param obj The icon object.
5089 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5090 * otherwise. Default is @c EINA_FALSE.
5092 * This function disables scaling of the icon object through the function
5093 * elm_object_scale_set(). However, this does not affect the object
5094 * size/resize in any way. For that effect, take a look at
5095 * elm_icon_scale_set().
5097 * @see elm_icon_no_scale_get()
5098 * @see elm_icon_scale_set()
5099 * @see elm_object_scale_set()
5103 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5105 * Get whether scaling is disabled on the object.
5107 * @param obj The icon object
5108 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5110 * @see elm_icon_no_scale_set()
5114 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5116 * Set if the object is (up/down) resizable.
5118 * @param obj The icon object
5119 * @param scale_up A bool to set if the object is resizable up. Default is
5121 * @param scale_down A bool to set if the object is resizable down. Default
5124 * This function limits the icon object resize ability. If @p scale_up is set to
5125 * @c EINA_FALSE, the object can't have its height or width resized to a value
5126 * higher than the original icon size. Same is valid for @p scale_down.
5128 * @see elm_icon_scale_get()
5132 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5134 * Get if the object is (up/down) resizable.
5136 * @param obj The icon object
5137 * @param scale_up A bool to set if the object is resizable up
5138 * @param scale_down A bool to set if the object is resizable down
5140 * @see elm_icon_scale_set()
5144 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5146 * Get the object's image size
5148 * @param obj The icon object
5149 * @param w A pointer to store the width in
5150 * @param h A pointer to store the height in
5154 EAPI void elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5156 * Set if the icon fill the entire object area.
5158 * @param obj The icon object
5159 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5160 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5162 * When the icon object is resized to a different aspect ratio from the
5163 * original icon image, the icon image will still keep its aspect. This flag
5164 * tells how the image should fill the object's area. They are: keep the
5165 * entire icon inside the limits of height and width of the object (@p
5166 * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
5167 * of the object, and the icon will fill the entire object (@p fill_outside
5170 * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
5171 * retain property to false. Thus, the icon image will always keep its
5172 * original aspect ratio.
5174 * @see elm_icon_fill_outside_get()
5175 * @see elm_image_fill_outside_set()
5179 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5181 * Get if the object is filled outside.
5183 * @param obj The icon object
5184 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5186 * @see elm_icon_fill_outside_set()
5190 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5192 * Set the prescale size for the icon.
5194 * @param obj The icon object
5195 * @param size The prescale size. This value is used for both width and
5198 * This function sets a new size for pixmap representation of the given
5199 * icon. It allows the icon to be loaded already in the specified size,
5200 * reducing the memory usage and load time when loading a big icon with load
5201 * size set to a smaller size.
5203 * It's equivalent to the elm_bg_load_size_set() function for bg.
5205 * @note this is just a hint, the real size of the pixmap may differ
5206 * depending on the type of icon being loaded, being bigger than requested.
5208 * @see elm_icon_prescale_get()
5209 * @see elm_bg_load_size_set()
5213 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5215 * Get the prescale size for the icon.
5217 * @param obj The icon object
5218 * @return The prescale size
5220 * @see elm_icon_prescale_set()
5224 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5226 * Gets the image object of the icon. DO NOT MODIFY THIS.
5228 * @param obj The icon object
5229 * @return The internal icon object
5233 EAPI Evas_Object *elm_icon_object_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5235 * Sets the icon lookup order used by elm_icon_standard_set().
5237 * @param obj The icon object
5238 * @param order The icon lookup order (can be one of
5239 * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
5240 * or ELM_ICON_LOOKUP_THEME)
5242 * @see elm_icon_order_lookup_get()
5243 * @see Elm_Icon_Lookup_Order
5247 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
5249 * Gets the icon lookup order.
5251 * @param obj The icon object
5252 * @return The icon lookup order
5254 * @see elm_icon_order_lookup_set()
5255 * @see Elm_Icon_Lookup_Order
5259 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5261 * Enable or disable preloading of the icon
5263 * @param obj The icon object
5264 * @param disable If EINA_TRUE, preloading will be disabled
5267 EAPI void elm_icon_preload_set(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
5269 * Get if the icon supports animation or not.
5271 * @param obj The icon object
5272 * @return @c EINA_TRUE if the icon supports animation,
5273 * @c EINA_FALSE otherwise.
5275 * Return if this elm icon's image can be animated. Currently Evas only
5276 * supports gif animation. If the return value is EINA_FALSE, other
5277 * elm_icon_animated_XXX APIs won't work.
5280 EAPI Eina_Bool elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5282 * Set animation mode of the icon.
5284 * @param obj The icon object
5285 * @param anim @c EINA_TRUE if the object do animation job,
5286 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5288 * Since the default animation mode is set to EINA_FALSE,
5289 * the icon is shown without animation.
5290 * This might be desirable when the application developer wants to show
5291 * a snapshot of the animated icon.
5292 * Set it to EINA_TRUE when the icon needs to be animated.
5295 EAPI void elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
5297 * Get animation mode of the icon.
5299 * @param obj The icon object
5300 * @return The animation mode of the icon object
5301 * @see elm_icon_animated_set
5304 EAPI Eina_Bool elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5306 * Set animation play mode of the icon.
5308 * @param obj The icon object
5309 * @param play @c EINA_TRUE the object play animation images,
5310 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5312 * To play elm icon's animation, set play to EINA_TURE.
5313 * For example, you make gif player using this set/get API and click event.
5315 * 1. Click event occurs
5316 * 2. Check play flag using elm_icon_animaged_play_get
5317 * 3. If elm icon was playing, set play to EINA_FALSE.
5318 * Then animation will be stopped and vice versa
5321 EAPI void elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
5323 * Get animation play mode of the icon.
5325 * @param obj The icon object
5326 * @return The play mode of the icon object
5328 * @see elm_icon_animated_play_get
5331 EAPI Eina_Bool elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5338 * @defgroup Image Image
5340 * @image html img/widget/image/preview-00.png
5341 * @image latex img/widget/image/preview-00.eps
5344 * An object that allows one to load an image file to it. It can be used
5345 * anywhere like any other elementary widget.
5347 * This widget provides most of the functionality provided from @ref Bg or @ref
5348 * Icon, but with a slightly different API (use the one that fits better your
5351 * The features not provided by those two other image widgets are:
5352 * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
5353 * @li change the object orientation with elm_image_orient_set();
5354 * @li and turning the image editable with elm_image_editable_set().
5356 * Signals that you can add callbacks for are:
5358 * @li @c "clicked" - This is called when a user has clicked the image
5360 * An example of usage for this API follows:
5361 * @li @ref tutorial_image
5370 * @enum _Elm_Image_Orient
5371 * @typedef Elm_Image_Orient
5373 * Possible orientation options for elm_image_orient_set().
5375 * @image html elm_image_orient_set.png
5376 * @image latex elm_image_orient_set.eps width=\textwidth
5380 typedef enum _Elm_Image_Orient
5382 ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
5383 ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
5384 ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
5385 ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5386 ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
5387 ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
5388 ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
5389 ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
5393 * Add a new image to the parent.
5395 * @param parent The parent object
5396 * @return The new object or NULL if it cannot be created
5398 * @see elm_image_file_set()
5402 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5404 * Set the file that will be used as image.
5406 * @param obj The image object
5407 * @param file The path to file that will be used as image
5408 * @param group The group that the image belongs in edje file (if it's an
5411 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5413 * @see elm_image_file_get()
5417 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5419 * Get the file that will be used as image.
5421 * @param obj The image object
5422 * @param file The path to file
5423 * @param group The group that the image belongs in edje file
5425 * @see elm_image_file_set()
5429 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5431 * Set the smooth effect for an image.
5433 * @param obj The image object
5434 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5435 * otherwise. Default is @c EINA_TRUE.
5437 * Set the scaling algorithm to be used when scaling the image. Smooth
5438 * scaling provides a better resulting image, but is slower.
5440 * The smooth scaling should be disabled when making animations that change
5441 * the image size, since it will be faster. Animations that don't require
5442 * resizing of the image can keep the smooth scaling enabled (even if the
5443 * image is already scaled, since the scaled image will be cached).
5445 * @see elm_image_smooth_get()
5449 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5451 * Get the smooth effect for an image.
5453 * @param obj The image object
5454 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5456 * @see elm_image_smooth_get()
5460 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5463 * Gets the current size of the image.
5465 * @param obj The image object.
5466 * @param w Pointer to store width, or NULL.
5467 * @param h Pointer to store height, or NULL.
5469 * This is the real size of the image, not the size of the object.
5471 * On error, neither w or h will be written.
5475 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5477 * Disable scaling of this object.
5479 * @param obj The image object.
5480 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5481 * otherwise. Default is @c EINA_FALSE.
5483 * This function disables scaling of the elm_image widget through the
5484 * function elm_object_scale_set(). However, this does not affect the widget
5485 * size/resize in any way. For that effect, take a look at
5486 * elm_image_scale_set().
5488 * @see elm_image_no_scale_get()
5489 * @see elm_image_scale_set()
5490 * @see elm_object_scale_set()
5494 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5496 * Get whether scaling is disabled on the object.
5498 * @param obj The image object
5499 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5501 * @see elm_image_no_scale_set()
5505 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5507 * Set if the object is (up/down) resizable.
5509 * @param obj The image object
5510 * @param scale_up A bool to set if the object is resizable up. Default is
5512 * @param scale_down A bool to set if the object is resizable down. Default
5515 * This function limits the image resize ability. If @p scale_up is set to
5516 * @c EINA_FALSE, the object can't have its height or width resized to a value
5517 * higher than the original image size. Same is valid for @p scale_down.
5519 * @see elm_image_scale_get()
5523 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5525 * Get if the object is (up/down) resizable.
5527 * @param obj The image object
5528 * @param scale_up A bool to set if the object is resizable up
5529 * @param scale_down A bool to set if the object is resizable down
5531 * @see elm_image_scale_set()
5535 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5537 * Set if the image fills the entire object area, when keeping the aspect ratio.
5539 * @param obj The image object
5540 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5541 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5543 * When the image should keep its aspect ratio even if resized to another
5544 * aspect ratio, there are two possibilities to resize it: keep the entire
5545 * image inside the limits of height and width of the object (@p fill_outside
5546 * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5547 * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5549 * @note This option will have no effect if
5550 * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5552 * @see elm_image_fill_outside_get()
5553 * @see elm_image_aspect_ratio_retained_set()
5557 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5559 * Get if the object is filled outside
5561 * @param obj The image object
5562 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5564 * @see elm_image_fill_outside_set()
5568 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5570 * Set the prescale size for the image
5572 * @param obj The image object
5573 * @param size The prescale size. This value is used for both width and
5576 * This function sets a new size for pixmap representation of the given
5577 * image. It allows the image to be loaded already in the specified size,
5578 * reducing the memory usage and load time when loading a big image with load
5579 * size set to a smaller size.
5581 * It's equivalent to the elm_bg_load_size_set() function for bg.
5583 * @note this is just a hint, the real size of the pixmap may differ
5584 * depending on the type of image being loaded, being bigger than requested.
5586 * @see elm_image_prescale_get()
5587 * @see elm_bg_load_size_set()
5591 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5593 * Get the prescale size for the image
5595 * @param obj The image object
5596 * @return The prescale size
5598 * @see elm_image_prescale_set()
5602 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5604 * Set the image orientation.
5606 * @param obj The image object
5607 * @param orient The image orientation @ref Elm_Image_Orient
5608 * Default is #ELM_IMAGE_ORIENT_NONE.
5610 * This function allows to rotate or flip the given image.
5612 * @see elm_image_orient_get()
5613 * @see @ref Elm_Image_Orient
5617 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5619 * Get the image orientation.
5621 * @param obj The image object
5622 * @return The image orientation @ref Elm_Image_Orient
5624 * @see elm_image_orient_set()
5625 * @see @ref Elm_Image_Orient
5629 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5631 * Make the image 'editable'.
5633 * @param obj Image object.
5634 * @param set Turn on or off editability. Default is @c EINA_FALSE.
5636 * This means the image is a valid drag target for drag and drop, and can be
5637 * cut or pasted too.
5641 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5643 * Check if the image 'editable'.
5645 * @param obj Image object.
5646 * @return Editability.
5648 * A return value of EINA_TRUE means the image is a valid drag target
5649 * for drag and drop, and can be cut or pasted too.
5653 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5655 * Get the basic Evas_Image object from this object (widget).
5657 * @param obj The image object to get the inlined image from
5658 * @return The inlined image object, or NULL if none exists
5660 * This function allows one to get the underlying @c Evas_Object of type
5661 * Image from this elementary widget. It can be useful to do things like get
5662 * the pixel data, save the image to a file, etc.
5664 * @note Be careful to not manipulate it, as it is under control of
5669 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5671 * Set whether the original aspect ratio of the image should be kept on resize.
5673 * @param obj The image object.
5674 * @param retained @c EINA_TRUE if the image should retain the aspect,
5675 * @c EINA_FALSE otherwise.
5677 * The original aspect ratio (width / height) of the image is usually
5678 * distorted to match the object's size. Enabling this option will retain
5679 * this original aspect, and the way that the image is fit into the object's
5680 * area depends on the option set by elm_image_fill_outside_set().
5682 * @see elm_image_aspect_ratio_retained_get()
5683 * @see elm_image_fill_outside_set()
5687 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5689 * Get if the object retains the original aspect ratio.
5691 * @param obj The image object.
5692 * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5697 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5707 * @image html img/widget/box/preview-00.png
5708 * @image latex img/widget/box/preview-00.eps width=\textwidth
5710 * @image html img/box.png
5711 * @image latex img/box.eps width=\textwidth
5713 * A box arranges objects in a linear fashion, governed by a layout function
5714 * that defines the details of this arrangement.
5716 * By default, the box will use an internal function to set the layout to
5717 * a single row, either vertical or horizontal. This layout is affected
5718 * by a number of parameters, such as the homogeneous flag set by
5719 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5720 * elm_box_align_set() and the hints set to each object in the box.
5722 * For this default layout, it's possible to change the orientation with
5723 * elm_box_horizontal_set(). The box will start in the vertical orientation,
5724 * placing its elements ordered from top to bottom. When horizontal is set,
5725 * the order will go from left to right. If the box is set to be
5726 * homogeneous, every object in it will be assigned the same space, that
5727 * of the largest object. Padding can be used to set some spacing between
5728 * the cell given to each object. The alignment of the box, set with
5729 * elm_box_align_set(), determines how the bounding box of all the elements
5730 * will be placed within the space given to the box widget itself.
5732 * The size hints of each object also affect how they are placed and sized
5733 * within the box. evas_object_size_hint_min_set() will give the minimum
5734 * size the object can have, and the box will use it as the basis for all
5735 * latter calculations. Elementary widgets set their own minimum size as
5736 * needed, so there's rarely any need to use it manually.
5738 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5739 * used to tell whether the object will be allocated the minimum size it
5740 * needs or if the space given to it should be expanded. It's important
5741 * to realize that expanding the size given to the object is not the same
5742 * thing as resizing the object. It could very well end being a small
5743 * widget floating in a much larger empty space. If not set, the weight
5744 * for objects will normally be 0.0 for both axis, meaning the widget will
5745 * not be expanded. To take as much space possible, set the weight to
5746 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5748 * Besides how much space each object is allocated, it's possible to control
5749 * how the widget will be placed within that space using
5750 * evas_object_size_hint_align_set(). By default, this value will be 0.5
5751 * for both axis, meaning the object will be centered, but any value from
5752 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5753 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5754 * is -1.0, means the object will be resized to fill the entire space it
5757 * In addition, customized functions to define the layout can be set, which
5758 * allow the application developer to organize the objects within the box
5759 * in any number of ways.
5761 * The special elm_box_layout_transition() function can be used
5762 * to switch from one layout to another, animating the motion of the
5763 * children of the box.
5765 * @note Objects should not be added to box objects using _add() calls.
5767 * Some examples on how to use boxes follow:
5768 * @li @ref box_example_01
5769 * @li @ref box_example_02
5774 * @typedef Elm_Box_Transition
5776 * Opaque handler containing the parameters to perform an animated
5777 * transition of the layout the box uses.
5779 * @see elm_box_transition_new()
5780 * @see elm_box_layout_set()
5781 * @see elm_box_layout_transition()
5783 typedef struct _Elm_Box_Transition Elm_Box_Transition;
5786 * Add a new box to the parent
5788 * By default, the box will be in vertical mode and non-homogeneous.
5790 * @param parent The parent object
5791 * @return The new object or NULL if it cannot be created
5793 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5795 * Set the horizontal orientation
5797 * By default, box object arranges their contents vertically from top to
5799 * By calling this function with @p horizontal as EINA_TRUE, the box will
5800 * become horizontal, arranging contents from left to right.
5802 * @note This flag is ignored if a custom layout function is set.
5804 * @param obj The box object
5805 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5806 * EINA_FALSE = vertical)
5808 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5810 * Get the horizontal orientation
5812 * @param obj The box object
5813 * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
5815 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5817 * Set the box to arrange its children homogeneously
5819 * If enabled, homogeneous layout makes all items the same size, according
5820 * to the size of the largest of its children.
5822 * @note This flag is ignored if a custom layout function is set.
5824 * @param obj The box object
5825 * @param homogeneous The homogeneous flag
5827 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5829 * Get whether the box is using homogeneous mode or not
5831 * @param obj The box object
5832 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5834 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5835 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5836 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5838 * Add an object to the beginning of the pack list
5840 * Pack @p subobj into the box @p obj, placing it first in the list of
5841 * children objects. The actual position the object will get on screen
5842 * depends on the layout used. If no custom layout is set, it will be at
5843 * the top or left, depending if the box is vertical or horizontal,
5846 * @param obj The box object
5847 * @param subobj The object to add to the box
5849 * @see elm_box_pack_end()
5850 * @see elm_box_pack_before()
5851 * @see elm_box_pack_after()
5852 * @see elm_box_unpack()
5853 * @see elm_box_unpack_all()
5854 * @see elm_box_clear()
5856 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5858 * Add an object at the end of the pack list
5860 * Pack @p subobj into the box @p obj, placing it last in the list of
5861 * children objects. The actual position the object will get on screen
5862 * depends on the layout used. If no custom layout is set, it will be at
5863 * the bottom or right, depending if the box is vertical or horizontal,
5866 * @param obj The box object
5867 * @param subobj The object to add to the box
5869 * @see elm_box_pack_start()
5870 * @see elm_box_pack_before()
5871 * @see elm_box_pack_after()
5872 * @see elm_box_unpack()
5873 * @see elm_box_unpack_all()
5874 * @see elm_box_clear()
5876 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5878 * Adds an object to the box before the indicated object
5880 * This will add the @p subobj to the box indicated before the object
5881 * indicated with @p before. If @p before is not already in the box, results
5882 * are undefined. Before means either to the left of the indicated object or
5883 * above it depending on orientation.
5885 * @param obj The box object
5886 * @param subobj The object to add to the box
5887 * @param before The object before which to add it
5889 * @see elm_box_pack_start()
5890 * @see elm_box_pack_end()
5891 * @see elm_box_pack_after()
5892 * @see elm_box_unpack()
5893 * @see elm_box_unpack_all()
5894 * @see elm_box_clear()
5896 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
5898 * Adds an object to the box after the indicated object
5900 * This will add the @p subobj to the box indicated after the object
5901 * indicated with @p after. If @p after is not already in the box, results
5902 * are undefined. After means either to the right of the indicated object or
5903 * below it depending on orientation.
5905 * @param obj The box object
5906 * @param subobj The object to add to the box
5907 * @param after The object after which to add it
5909 * @see elm_box_pack_start()
5910 * @see elm_box_pack_end()
5911 * @see elm_box_pack_before()
5912 * @see elm_box_unpack()
5913 * @see elm_box_unpack_all()
5914 * @see elm_box_clear()
5916 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
5918 * Clear the box of all children
5920 * Remove all the elements contained by the box, deleting the respective
5923 * @param obj The box object
5925 * @see elm_box_unpack()
5926 * @see elm_box_unpack_all()
5928 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5932 * Remove the object given by @p subobj from the box @p obj without
5935 * @param obj The box object
5937 * @see elm_box_unpack_all()
5938 * @see elm_box_clear()
5940 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5942 * Remove all items from the box, without deleting them
5944 * Clear the box from all children, but don't delete the respective objects.
5945 * If no other references of the box children exist, the objects will never
5946 * be deleted, and thus the application will leak the memory. Make sure
5947 * when using this function that you hold a reference to all the objects
5948 * in the box @p obj.
5950 * @param obj The box object
5952 * @see elm_box_clear()
5953 * @see elm_box_unpack()
5955 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5957 * Retrieve a list of the objects packed into the box
5959 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
5960 * The order of the list corresponds to the packing order the box uses.
5962 * You must free this list with eina_list_free() once you are done with it.
5964 * @param obj The box object
5966 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5968 * Set the space (padding) between the box's elements.
5970 * Extra space in pixels that will be added between a box child and its
5971 * neighbors after its containing cell has been calculated. This padding
5972 * is set for all elements in the box, besides any possible padding that
5973 * individual elements may have through their size hints.
5975 * @param obj The box object
5976 * @param horizontal The horizontal space between elements
5977 * @param vertical The vertical space between elements
5979 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5981 * Get the space (padding) between the box's elements.
5983 * @param obj The box object
5984 * @param horizontal The horizontal space between elements
5985 * @param vertical The vertical space between elements
5987 * @see elm_box_padding_set()
5989 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5991 * Set the alignment of the whole bouding box of contents.
5993 * Sets how the bounding box containing all the elements of the box, after
5994 * their sizes and position has been calculated, will be aligned within
5995 * the space given for the whole box widget.
5997 * @param obj The box object
5998 * @param horizontal The horizontal alignment of elements
5999 * @param vertical The vertical alignment of elements
6001 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
6003 * Get the alignment of the whole bouding box of contents.
6005 * @param obj The box object
6006 * @param horizontal The horizontal alignment of elements
6007 * @param vertical The vertical alignment of elements
6009 * @see elm_box_align_set()
6011 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
6014 * Force the box to recalculate its children packing.
6016 * If any children was added or removed, box will not calculate the
6017 * values immediately rather leaving it to the next main loop
6018 * iteration. While this is great as it would save lots of
6019 * recalculation, whenever you need to get the position of a just
6020 * added item you must force recalculate before doing so.
6022 * @param obj The box object.
6024 EAPI void elm_box_recalculate(Evas_Object *obj);
6027 * Set the layout defining function to be used by the box
6029 * Whenever anything changes that requires the box in @p obj to recalculate
6030 * the size and position of its elements, the function @p cb will be called
6031 * to determine what the layout of the children will be.
6033 * Once a custom function is set, everything about the children layout
6034 * is defined by it. The flags set by elm_box_horizontal_set() and
6035 * elm_box_homogeneous_set() no longer have any meaning, and the values
6036 * given by elm_box_padding_set() and elm_box_align_set() are up to this
6037 * layout function to decide if they are used and how. These last two
6038 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
6039 * passed to @p cb. The @c Evas_Object the function receives is not the
6040 * Elementary widget, but the internal Evas Box it uses, so none of the
6041 * functions described here can be used on it.
6043 * Any of the layout functions in @c Evas can be used here, as well as the
6044 * special elm_box_layout_transition().
6046 * The final @p data argument received by @p cb is the same @p data passed
6047 * here, and the @p free_data function will be called to free it
6048 * whenever the box is destroyed or another layout function is set.
6050 * Setting @p cb to NULL will revert back to the default layout function.
6052 * @param obj The box object
6053 * @param cb The callback function used for layout
6054 * @param data Data that will be passed to layout function
6055 * @param free_data Function called to free @p data
6057 * @see elm_box_layout_transition()
6059 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);
6061 * Special layout function that animates the transition from one layout to another
6063 * Normally, when switching the layout function for a box, this will be
6064 * reflected immediately on screen on the next render, but it's also
6065 * possible to do this through an animated transition.
6067 * This is done by creating an ::Elm_Box_Transition and setting the box
6068 * layout to this function.
6072 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
6073 * evas_object_box_layout_vertical, // start
6074 * NULL, // data for initial layout
6075 * NULL, // free function for initial data
6076 * evas_object_box_layout_horizontal, // end
6077 * NULL, // data for final layout
6078 * NULL, // free function for final data
6079 * anim_end, // will be called when animation ends
6080 * NULL); // data for anim_end function\
6081 * elm_box_layout_set(box, elm_box_layout_transition, t,
6082 * elm_box_transition_free);
6085 * @note This function can only be used with elm_box_layout_set(). Calling
6086 * it directly will not have the expected results.
6088 * @see elm_box_transition_new
6089 * @see elm_box_transition_free
6090 * @see elm_box_layout_set
6092 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
6094 * Create a new ::Elm_Box_Transition to animate the switch of layouts
6096 * If you want to animate the change from one layout to another, you need
6097 * to set the layout function of the box to elm_box_layout_transition(),
6098 * passing as user data to it an instance of ::Elm_Box_Transition with the
6099 * necessary information to perform this animation. The free function to
6100 * set for the layout is elm_box_transition_free().
6102 * The parameters to create an ::Elm_Box_Transition sum up to how long
6103 * will it be, in seconds, a layout function to describe the initial point,
6104 * another for the final position of the children and one function to be
6105 * called when the whole animation ends. This last function is useful to
6106 * set the definitive layout for the box, usually the same as the end
6107 * layout for the animation, but could be used to start another transition.
6109 * @param start_layout The layout function that will be used to start the animation
6110 * @param start_layout_data The data to be passed the @p start_layout function
6111 * @param start_layout_free_data Function to free @p start_layout_data
6112 * @param end_layout The layout function that will be used to end the animation
6113 * @param end_layout_free_data The data to be passed the @p end_layout function
6114 * @param end_layout_free_data Function to free @p end_layout_data
6115 * @param transition_end_cb Callback function called when animation ends
6116 * @param transition_end_data Data to be passed to @p transition_end_cb
6117 * @return An instance of ::Elm_Box_Transition
6119 * @see elm_box_transition_new
6120 * @see elm_box_layout_transition
6122 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);
6124 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
6126 * This function is mostly useful as the @c free_data parameter in
6127 * elm_box_layout_set() when elm_box_layout_transition().
6129 * @param data The Elm_Box_Transition instance to be freed.
6131 * @see elm_box_transition_new
6132 * @see elm_box_layout_transition
6134 EAPI void elm_box_transition_free(void *data);
6141 * @defgroup Button Button
6143 * @image html img/widget/button/preview-00.png
6144 * @image latex img/widget/button/preview-00.eps
6145 * @image html img/widget/button/preview-01.png
6146 * @image latex img/widget/button/preview-01.eps
6147 * @image html img/widget/button/preview-02.png
6148 * @image latex img/widget/button/preview-02.eps
6150 * This is a push-button. Press it and run some function. It can contain
6151 * a simple label and icon object and it also has an autorepeat feature.
6153 * This widgets emits the following signals:
6154 * @li "clicked": the user clicked the button (press/release).
6155 * @li "repeated": the user pressed the button without releasing it.
6156 * @li "pressed": button was pressed.
6157 * @li "unpressed": button was released after being pressed.
6158 * In all three cases, the @c event parameter of the callback will be
6161 * Also, defined in the default theme, the button has the following styles
6163 * @li default: a normal button.
6164 * @li anchor: Like default, but the button fades away when the mouse is not
6165 * over it, leaving only the text or icon.
6166 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
6167 * continuous look across its options.
6168 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
6170 * Default contents parts of the button widget that you can use for are:
6171 * @li "icon" - A icon of the button
6173 * Default text parts of the button widget that you can use for are:
6174 * @li "default" - Label of the button
6176 * Follow through a complete example @ref button_example_01 "here".
6180 * Add a new button to the parent's canvas
6182 * @param parent The parent object
6183 * @return The new object or NULL if it cannot be created
6185 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6187 * Set the label used in the button
6189 * The passed @p label can be NULL to clean any existing text in it and
6190 * leave the button as an icon only object.
6192 * @param obj The button object
6193 * @param label The text will be written on the button
6194 * @deprecated use elm_object_text_set() instead.
6196 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6198 * Get the label set for the button
6200 * The string returned is an internal pointer and should not be freed or
6201 * altered. It will also become invalid when the button is destroyed.
6202 * The string returned, if not NULL, is a stringshare, so if you need to
6203 * keep it around even after the button is destroyed, you can use
6204 * eina_stringshare_ref().
6206 * @param obj The button object
6207 * @return The text set to the label, or NULL if nothing is set
6208 * @deprecated use elm_object_text_set() instead.
6210 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6212 * Set the icon used for the button
6214 * Setting a new icon will delete any other that was previously set, making
6215 * any reference to them invalid. If you need to maintain the previous
6216 * object alive, unset it first with elm_button_icon_unset().
6218 * @param obj The button object
6219 * @param icon The icon object for the button
6220 * @deprecated use elm_object_part_content_set() instead.
6222 EINA_DEPRECATED EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6224 * Get the icon used for the button
6226 * Return the icon object which is set for this widget. If the button is
6227 * destroyed or another icon is set, the returned object will be deleted
6228 * and any reference to it will be invalid.
6230 * @param obj The button object
6231 * @return The icon object that is being used
6233 * @deprecated use elm_object_part_content_get() instead
6235 EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6237 * Remove the icon set without deleting it and return the object
6239 * This function drops the reference the button holds of the icon object
6240 * and returns this last object. It is used in case you want to remove any
6241 * icon, or set another one, without deleting the actual object. The button
6242 * will be left without an icon set.
6244 * @param obj The button object
6245 * @return The icon object that was being used
6246 * @deprecated use elm_object_part_content_unset() instead.
6248 EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6250 * Turn on/off the autorepeat event generated when the button is kept pressed
6252 * When off, no autorepeat is performed and buttons emit a normal @c clicked
6253 * signal when they are clicked.
6255 * When on, keeping a button pressed will continuously emit a @c repeated
6256 * signal until the button is released. The time it takes until it starts
6257 * emitting the signal is given by
6258 * elm_button_autorepeat_initial_timeout_set(), and the time between each
6259 * new emission by elm_button_autorepeat_gap_timeout_set().
6261 * @param obj The button object
6262 * @param on A bool to turn on/off the event
6264 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6266 * Get whether the autorepeat feature is enabled
6268 * @param obj The button object
6269 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6271 * @see elm_button_autorepeat_set()
6273 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6275 * Set the initial timeout before the autorepeat event is generated
6277 * Sets the timeout, in seconds, since the button is pressed until the
6278 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6279 * won't be any delay and the even will be fired the moment the button is
6282 * @param obj The button object
6283 * @param t Timeout in seconds
6285 * @see elm_button_autorepeat_set()
6286 * @see elm_button_autorepeat_gap_timeout_set()
6288 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6290 * Get the initial timeout before the autorepeat event is generated
6292 * @param obj The button object
6293 * @return Timeout in seconds
6295 * @see elm_button_autorepeat_initial_timeout_set()
6297 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6299 * Set the interval between each generated autorepeat event
6301 * After the first @c repeated event is fired, all subsequent ones will
6302 * follow after a delay of @p t seconds for each.
6304 * @param obj The button object
6305 * @param t Interval in seconds
6307 * @see elm_button_autorepeat_initial_timeout_set()
6309 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6311 * Get the interval between each generated autorepeat event
6313 * @param obj The button object
6314 * @return Interval in seconds
6316 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6322 * @defgroup File_Selector_Button File Selector Button
6324 * @image html img/widget/fileselector_button/preview-00.png
6325 * @image latex img/widget/fileselector_button/preview-00.eps
6326 * @image html img/widget/fileselector_button/preview-01.png
6327 * @image latex img/widget/fileselector_button/preview-01.eps
6328 * @image html img/widget/fileselector_button/preview-02.png
6329 * @image latex img/widget/fileselector_button/preview-02.eps
6331 * This is a button that, when clicked, creates an Elementary
6332 * window (or inner window) <b> with a @ref Fileselector "file
6333 * selector widget" within</b>. When a file is chosen, the (inner)
6334 * window is closed and the button emits a signal having the
6335 * selected file as it's @c event_info.
6337 * This widget encapsulates operations on its internal file
6338 * selector on its own API. There is less control over its file
6339 * selector than that one would have instatiating one directly.
6341 * The following styles are available for this button:
6344 * @li @c "hoversel_vertical"
6345 * @li @c "hoversel_vertical_entry"
6347 * Smart callbacks one can register to:
6348 * - @c "file,chosen" - the user has selected a path, whose string
6349 * pointer comes as the @c event_info data (a stringshared
6352 * Here is an example on its usage:
6353 * @li @ref fileselector_button_example
6355 * @see @ref File_Selector_Entry for a similar widget.
6360 * Add a new file selector button widget to the given parent
6361 * Elementary (container) object
6363 * @param parent The parent object
6364 * @return a new file selector button widget handle or @c NULL, on
6367 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6370 * Set the label for a given file selector button widget
6372 * @param obj The file selector button widget
6373 * @param label The text label to be displayed on @p obj
6375 * @deprecated use elm_object_text_set() instead.
6377 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6380 * Get the label set for a given file selector button widget
6382 * @param obj The file selector button widget
6383 * @return The button label
6385 * @deprecated use elm_object_text_set() instead.
6387 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6390 * Set the icon on a given file selector button widget
6392 * @param obj The file selector button widget
6393 * @param icon The icon object for the button
6395 * Once the icon object is set, a previously set one will be
6396 * deleted. If you want to keep the latter, use the
6397 * elm_fileselector_button_icon_unset() function.
6399 * @see elm_fileselector_button_icon_get()
6401 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6404 * Get the icon set for a given file selector button widget
6406 * @param obj The file selector button widget
6407 * @return The icon object currently set on @p obj or @c NULL, if
6410 * @see elm_fileselector_button_icon_set()
6412 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6415 * Unset the icon used in a given file selector button widget
6417 * @param obj The file selector button widget
6418 * @return The icon object that was being used on @p obj or @c
6421 * Unparent and return the icon object which was set for this
6424 * @see elm_fileselector_button_icon_set()
6426 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6429 * Set the title for a given file selector button widget's window
6431 * @param obj The file selector button widget
6432 * @param title The title string
6434 * This will change the window's title, when the file selector pops
6435 * out after a click on the button. Those windows have the default
6436 * (unlocalized) value of @c "Select a file" as titles.
6438 * @note It will only take any effect if the file selector
6439 * button widget is @b not under "inwin mode".
6441 * @see elm_fileselector_button_window_title_get()
6443 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6446 * Get the title set for a given file selector button widget's
6449 * @param obj The file selector button widget
6450 * @return Title of the file selector button's window
6452 * @see elm_fileselector_button_window_title_get() for more details
6454 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6457 * Set the size of a given file selector button widget's window,
6458 * holding the file selector itself.
6460 * @param obj The file selector button widget
6461 * @param width The window's width
6462 * @param height The window's height
6464 * @note it will only take any effect if the file selector button
6465 * widget is @b not under "inwin mode". The default size for the
6466 * window (when applicable) is 400x400 pixels.
6468 * @see elm_fileselector_button_window_size_get()
6470 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6473 * Get the size of a given file selector button widget's window,
6474 * holding the file selector itself.
6476 * @param obj The file selector button widget
6477 * @param width Pointer into which to store the width value
6478 * @param height Pointer into which to store the height value
6480 * @note Use @c NULL pointers on the size values you're not
6481 * interested in: they'll be ignored by the function.
6483 * @see elm_fileselector_button_window_size_set(), for more details
6485 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6488 * Set the initial file system path for a given file selector
6491 * @param obj The file selector button widget
6492 * @param path The path string
6494 * It must be a <b>directory</b> path, which will have the contents
6495 * displayed initially in the file selector's view, when invoked
6496 * from @p obj. The default initial path is the @c "HOME"
6497 * environment variable's value.
6499 * @see elm_fileselector_button_path_get()
6501 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6504 * Get the initial file system path set for a given file selector
6507 * @param obj The file selector button widget
6508 * @return path The path string
6510 * @see elm_fileselector_button_path_set() for more details
6512 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6515 * Enable/disable a tree view in the given file selector button
6516 * widget's internal file selector
6518 * @param obj The file selector button widget
6519 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6522 * This has the same effect as elm_fileselector_expandable_set(),
6523 * but now applied to a file selector button's internal file
6526 * @note There's no way to put a file selector button's internal
6527 * file selector in "grid mode", as one may do with "pure" file
6530 * @see elm_fileselector_expandable_get()
6532 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6535 * Get whether tree view is enabled for the given file selector
6536 * button widget's internal file selector
6538 * @param obj The file selector button widget
6539 * @return @c EINA_TRUE if @p obj widget's internal file selector
6540 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6542 * @see elm_fileselector_expandable_set() for more details
6544 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6547 * Set whether a given file selector button widget's internal file
6548 * selector is to display folders only or the directory contents,
6551 * @param obj The file selector button widget
6552 * @param only @c EINA_TRUE to make @p obj widget's internal file
6553 * selector only display directories, @c EINA_FALSE to make files
6554 * to be displayed in it too
6556 * This has the same effect as elm_fileselector_folder_only_set(),
6557 * but now applied to a file selector button's internal file
6560 * @see elm_fileselector_folder_only_get()
6562 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6565 * Get whether a given file selector button widget's internal file
6566 * selector is displaying folders only or the directory contents,
6569 * @param obj The file selector button widget
6570 * @return @c EINA_TRUE if @p obj widget's internal file
6571 * selector is only displaying directories, @c EINA_FALSE if files
6572 * are being displayed in it too (and on errors)
6574 * @see elm_fileselector_button_folder_only_set() for more details
6576 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6579 * Enable/disable the file name entry box where the user can type
6580 * in a name for a file, in a given file selector button widget's
6581 * internal file selector.
6583 * @param obj The file selector button widget
6584 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6585 * file selector a "saving dialog", @c EINA_FALSE otherwise
6587 * This has the same effect as elm_fileselector_is_save_set(),
6588 * but now applied to a file selector button's internal file
6591 * @see elm_fileselector_is_save_get()
6593 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6596 * Get whether the given file selector button widget's internal
6597 * file selector is in "saving dialog" mode
6599 * @param obj The file selector button widget
6600 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6601 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6604 * @see elm_fileselector_button_is_save_set() for more details
6606 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6609 * Set whether a given file selector button widget's internal file
6610 * selector will raise an Elementary "inner window", instead of a
6611 * dedicated Elementary window. By default, it won't.
6613 * @param obj The file selector button widget
6614 * @param value @c EINA_TRUE to make it use an inner window, @c
6615 * EINA_TRUE to make it use a dedicated window
6617 * @see elm_win_inwin_add() for more information on inner windows
6618 * @see elm_fileselector_button_inwin_mode_get()
6620 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6623 * Get whether a given file selector button widget's internal file
6624 * selector will raise an Elementary "inner window", instead of a
6625 * dedicated Elementary window.
6627 * @param obj The file selector button widget
6628 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6629 * if it will use a dedicated window
6631 * @see elm_fileselector_button_inwin_mode_set() for more details
6633 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6640 * @defgroup File_Selector_Entry File Selector Entry
6642 * @image html img/widget/fileselector_entry/preview-00.png
6643 * @image latex img/widget/fileselector_entry/preview-00.eps
6645 * This is an entry made to be filled with or display a <b>file
6646 * system path string</b>. Besides the entry itself, the widget has
6647 * a @ref File_Selector_Button "file selector button" on its side,
6648 * which will raise an internal @ref Fileselector "file selector widget",
6649 * when clicked, for path selection aided by file system
6652 * This file selector may appear in an Elementary window or in an
6653 * inner window. When a file is chosen from it, the (inner) window
6654 * is closed and the selected file's path string is exposed both as
6655 * an smart event and as the new text on the entry.
6657 * This widget encapsulates operations on its internal file
6658 * selector on its own API. There is less control over its file
6659 * selector than that one would have instatiating one directly.
6661 * Smart callbacks one can register to:
6662 * - @c "changed" - The text within the entry was changed
6663 * - @c "activated" - The entry has had editing finished and
6664 * changes are to be "committed"
6665 * - @c "press" - The entry has been clicked
6666 * - @c "longpressed" - The entry has been clicked (and held) for a
6668 * - @c "clicked" - The entry has been clicked
6669 * - @c "clicked,double" - The entry has been double clicked
6670 * - @c "focused" - The entry has received focus
6671 * - @c "unfocused" - The entry has lost focus
6672 * - @c "selection,paste" - A paste action has occurred on the
6674 * - @c "selection,copy" - A copy action has occurred on the entry
6675 * - @c "selection,cut" - A cut action has occurred on the entry
6676 * - @c "unpressed" - The file selector entry's button was released
6677 * after being pressed.
6678 * - @c "file,chosen" - The user has selected a path via the file
6679 * selector entry's internal file selector, whose string pointer
6680 * comes as the @c event_info data (a stringshared string)
6682 * Here is an example on its usage:
6683 * @li @ref fileselector_entry_example
6685 * @see @ref File_Selector_Button for a similar widget.
6690 * Add a new file selector entry widget to the given parent
6691 * Elementary (container) object
6693 * @param parent The parent object
6694 * @return a new file selector entry widget handle or @c NULL, on
6697 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6700 * Set the label for a given file selector entry widget's button
6702 * @param obj The file selector entry widget
6703 * @param label The text label to be displayed on @p obj widget's
6706 * @deprecated use elm_object_text_set() instead.
6708 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6711 * Get the label set for a given file selector entry widget's button
6713 * @param obj The file selector entry widget
6714 * @return The widget button's label
6716 * @deprecated use elm_object_text_set() instead.
6718 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6721 * Set the icon on a given file selector entry widget's button
6723 * @param obj The file selector entry widget
6724 * @param icon The icon object for the entry's button
6726 * Once the icon object is set, a previously set one will be
6727 * deleted. If you want to keep the latter, use the
6728 * elm_fileselector_entry_button_icon_unset() function.
6730 * @see elm_fileselector_entry_button_icon_get()
6732 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6735 * Get the icon set for a given file selector entry widget's button
6737 * @param obj The file selector entry widget
6738 * @return The icon object currently set on @p obj widget's button
6739 * or @c NULL, if none is
6741 * @see elm_fileselector_entry_button_icon_set()
6743 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6746 * Unset the icon used in a given file selector entry widget's
6749 * @param obj The file selector entry widget
6750 * @return The icon object that was being used on @p obj widget's
6751 * button or @c NULL, on errors
6753 * Unparent and return the icon object which was set for this
6756 * @see elm_fileselector_entry_button_icon_set()
6758 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6761 * Set the title for a given file selector entry widget's window
6763 * @param obj The file selector entry widget
6764 * @param title The title string
6766 * This will change the window's title, when the file selector pops
6767 * out after a click on the entry's button. Those windows have the
6768 * default (unlocalized) value of @c "Select a file" as titles.
6770 * @note It will only take any effect if the file selector
6771 * entry widget is @b not under "inwin mode".
6773 * @see elm_fileselector_entry_window_title_get()
6775 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6778 * Get the title set for a given file selector entry widget's
6781 * @param obj The file selector entry widget
6782 * @return Title of the file selector entry's window
6784 * @see elm_fileselector_entry_window_title_get() for more details
6786 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6789 * Set the size of a given file selector entry widget's window,
6790 * holding the file selector itself.
6792 * @param obj The file selector entry widget
6793 * @param width The window's width
6794 * @param height The window's height
6796 * @note it will only take any effect if the file selector entry
6797 * widget is @b not under "inwin mode". The default size for the
6798 * window (when applicable) is 400x400 pixels.
6800 * @see elm_fileselector_entry_window_size_get()
6802 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6805 * Get the size of a given file selector entry widget's window,
6806 * holding the file selector itself.
6808 * @param obj The file selector entry widget
6809 * @param width Pointer into which to store the width value
6810 * @param height Pointer into which to store the height value
6812 * @note Use @c NULL pointers on the size values you're not
6813 * interested in: they'll be ignored by the function.
6815 * @see elm_fileselector_entry_window_size_set(), for more details
6817 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6820 * Set the initial file system path and the entry's path string for
6821 * a given file selector entry widget
6823 * @param obj The file selector entry widget
6824 * @param path The path string
6826 * It must be a <b>directory</b> path, which will have the contents
6827 * displayed initially in the file selector's view, when invoked
6828 * from @p obj. The default initial path is the @c "HOME"
6829 * environment variable's value.
6831 * @see elm_fileselector_entry_path_get()
6833 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6836 * Get the entry's path string for a given file selector entry
6839 * @param obj The file selector entry widget
6840 * @return path The path string
6842 * @see elm_fileselector_entry_path_set() for more details
6844 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6847 * Enable/disable a tree view in the given file selector entry
6848 * widget's internal file selector
6850 * @param obj The file selector entry widget
6851 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6854 * This has the same effect as elm_fileselector_expandable_set(),
6855 * but now applied to a file selector entry's internal file
6858 * @note There's no way to put a file selector entry's internal
6859 * file selector in "grid mode", as one may do with "pure" file
6862 * @see elm_fileselector_expandable_get()
6864 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6867 * Get whether tree view is enabled for the given file selector
6868 * entry widget's internal file selector
6870 * @param obj The file selector entry widget
6871 * @return @c EINA_TRUE if @p obj widget's internal file selector
6872 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6874 * @see elm_fileselector_expandable_set() for more details
6876 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6879 * Set whether a given file selector entry widget's internal file
6880 * selector is to display folders only or the directory contents,
6883 * @param obj The file selector entry widget
6884 * @param only @c EINA_TRUE to make @p obj widget's internal file
6885 * selector only display directories, @c EINA_FALSE to make files
6886 * to be displayed in it too
6888 * This has the same effect as elm_fileselector_folder_only_set(),
6889 * but now applied to a file selector entry's internal file
6892 * @see elm_fileselector_folder_only_get()
6894 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6897 * Get whether a given file selector entry widget's internal file
6898 * selector is displaying folders only or the directory contents,
6901 * @param obj The file selector entry widget
6902 * @return @c EINA_TRUE if @p obj widget's internal file
6903 * selector is only displaying directories, @c EINA_FALSE if files
6904 * are being displayed in it too (and on errors)
6906 * @see elm_fileselector_entry_folder_only_set() for more details
6908 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6911 * Enable/disable the file name entry box where the user can type
6912 * in a name for a file, in a given file selector entry widget's
6913 * internal file selector.
6915 * @param obj The file selector entry widget
6916 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6917 * file selector a "saving dialog", @c EINA_FALSE otherwise
6919 * This has the same effect as elm_fileselector_is_save_set(),
6920 * but now applied to a file selector entry's internal file
6923 * @see elm_fileselector_is_save_get()
6925 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6928 * Get whether the given file selector entry widget's internal
6929 * file selector is in "saving dialog" mode
6931 * @param obj The file selector entry widget
6932 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6933 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6936 * @see elm_fileselector_entry_is_save_set() for more details
6938 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6941 * Set whether a given file selector entry widget's internal file
6942 * selector will raise an Elementary "inner window", instead of a
6943 * dedicated Elementary window. By default, it won't.
6945 * @param obj The file selector entry widget
6946 * @param value @c EINA_TRUE to make it use an inner window, @c
6947 * EINA_TRUE to make it use a dedicated window
6949 * @see elm_win_inwin_add() for more information on inner windows
6950 * @see elm_fileselector_entry_inwin_mode_get()
6952 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6955 * Get whether a given file selector entry widget's internal file
6956 * selector will raise an Elementary "inner window", instead of a
6957 * dedicated Elementary window.
6959 * @param obj The file selector entry widget
6960 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6961 * if it will use a dedicated window
6963 * @see elm_fileselector_entry_inwin_mode_set() for more details
6965 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6968 * Set the initial file system path for a given file selector entry
6971 * @param obj The file selector entry widget
6972 * @param path The path string
6974 * It must be a <b>directory</b> path, which will have the contents
6975 * displayed initially in the file selector's view, when invoked
6976 * from @p obj. The default initial path is the @c "HOME"
6977 * environment variable's value.
6979 * @see elm_fileselector_entry_path_get()
6981 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6984 * Get the parent directory's path to the latest file selection on
6985 * a given filer selector entry widget
6987 * @param obj The file selector object
6988 * @return The (full) path of the directory of the last selection
6989 * on @p obj widget, a @b stringshared string
6991 * @see elm_fileselector_entry_path_set()
6993 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7000 * @defgroup Scroller Scroller
7002 * A scroller holds a single object and "scrolls it around". This means that
7003 * it allows the user to use a scrollbar (or a finger) to drag the viewable
7004 * region around, allowing to move through a much larger object that is
7005 * contained in the scroller. The scroller will always have a small minimum
7006 * size by default as it won't be limited by the contents of the scroller.
7008 * Signals that you can add callbacks for are:
7009 * @li "edge,left" - the left edge of the content has been reached
7010 * @li "edge,right" - the right edge of the content has been reached
7011 * @li "edge,top" - the top edge of the content has been reached
7012 * @li "edge,bottom" - the bottom edge of the content has been reached
7013 * @li "scroll" - the content has been scrolled (moved)
7014 * @li "scroll,anim,start" - scrolling animation has started
7015 * @li "scroll,anim,stop" - scrolling animation has stopped
7016 * @li "scroll,drag,start" - dragging the contents around has started
7017 * @li "scroll,drag,stop" - dragging the contents around has stopped
7018 * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
7021 * @note When Elemementary is in embedded mode the scrollbars will not be
7022 * dragable, they appear merely as indicators of how much has been scrolled.
7023 * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
7024 * fingerscroll) won't work.
7026 * Default contents parts of the scroller widget that you can use for are:
7027 * @li "default" - A content of the scroller
7029 * In @ref tutorial_scroller you'll find an example of how to use most of
7034 * @brief Type that controls when scrollbars should appear.
7036 * @see elm_scroller_policy_set()
7038 typedef enum _Elm_Scroller_Policy
7040 ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
7041 ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
7042 ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
7043 ELM_SCROLLER_POLICY_LAST
7044 } Elm_Scroller_Policy;
7046 * @brief Add a new scroller to the parent
7048 * @param parent The parent object
7049 * @return The new object or NULL if it cannot be created
7051 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7053 * @brief Set the content of the scroller widget (the object to be scrolled around).
7055 * @param obj The scroller object
7056 * @param content The new content object
7058 * Once the content object is set, a previously set one will be deleted.
7059 * If you want to keep that old content object, use the
7060 * elm_scroller_content_unset() function.
7061 * @deprecated use elm_object_content_set() instead
7063 EINA_DEPRECATED EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
7065 * @brief Get the content of the scroller widget
7067 * @param obj The slider object
7068 * @return The content that is being used
7070 * Return the content object which is set for this widget
7072 * @see elm_scroller_content_set()
7073 * @deprecated use elm_object_content_get() instead.
7075 EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7077 * @brief Unset the content of the scroller widget
7079 * @param obj The slider object
7080 * @return The content that was being used
7082 * Unparent and return the content object which was set for this widget
7084 * @see elm_scroller_content_set()
7085 * @deprecated use elm_object_content_unset() instead.
7087 EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7089 * @brief Set custom theme elements for the scroller
7091 * @param obj The scroller object
7092 * @param widget The widget name to use (default is "scroller")
7093 * @param base The base name to use (default is "base")
7095 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
7097 * @brief Make the scroller minimum size limited to the minimum size of the content
7099 * @param obj The scroller object
7100 * @param w Enable limiting minimum size horizontally
7101 * @param h Enable limiting minimum size vertically
7103 * By default the scroller will be as small as its design allows,
7104 * irrespective of its content. This will make the scroller minimum size the
7105 * right size horizontally and/or vertically to perfectly fit its content in
7108 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
7110 * @brief Show a specific virtual region within the scroller content object
7112 * @param obj The scroller object
7113 * @param x X coordinate of the region
7114 * @param y Y coordinate of the region
7115 * @param w Width of the region
7116 * @param h Height of the region
7118 * This will ensure all (or part if it does not fit) of the designated
7119 * region in the virtual content object (0, 0 starting at the top-left of the
7120 * virtual content object) is shown within the scroller.
7122 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);
7124 * @brief Set the scrollbar visibility policy
7126 * @param obj The scroller object
7127 * @param policy_h Horizontal scrollbar policy
7128 * @param policy_v Vertical scrollbar policy
7130 * This sets the scrollbar visibility policy for the given scroller.
7131 * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
7132 * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
7133 * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
7134 * respectively for the horizontal and vertical scrollbars.
7136 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
7138 * @brief Gets scrollbar visibility policy
7140 * @param obj The scroller object
7141 * @param policy_h Horizontal scrollbar policy
7142 * @param policy_v Vertical scrollbar policy
7144 * @see elm_scroller_policy_set()
7146 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
7148 * @brief Get the currently visible content region
7150 * @param obj The scroller object
7151 * @param x X coordinate of the region
7152 * @param y Y coordinate of the region
7153 * @param w Width of the region
7154 * @param h Height of the region
7156 * This gets the current region in the content object that is visible through
7157 * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
7158 * w, @p h values pointed to.
7160 * @note All coordinates are relative to the content.
7162 * @see elm_scroller_region_show()
7164 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);
7166 * @brief Get the size of the content object
7168 * @param obj The scroller object
7169 * @param w Width of the content object.
7170 * @param h Height of the content object.
7172 * This gets the size of the content object of the scroller.
7174 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7176 * @brief Set bouncing behavior
7178 * @param obj The scroller object
7179 * @param h_bounce Allow bounce horizontally
7180 * @param v_bounce Allow bounce vertically
7182 * When scrolling, the scroller may "bounce" when reaching an edge of the
7183 * content object. This is a visual way to indicate the end has been reached.
7184 * This is enabled by default for both axis. This API will set if it is enabled
7185 * for the given axis with the boolean parameters for each axis.
7187 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7189 * @brief Get the bounce behaviour
7191 * @param obj The Scroller object
7192 * @param h_bounce Will the scroller bounce horizontally or not
7193 * @param v_bounce Will the scroller bounce vertically or not
7195 * @see elm_scroller_bounce_set()
7197 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7199 * @brief Set scroll page size relative to viewport size.
7201 * @param obj The scroller object
7202 * @param h_pagerel The horizontal page relative size
7203 * @param v_pagerel The vertical page relative size
7205 * The scroller is capable of limiting scrolling by the user to "pages". That
7206 * is to jump by and only show a "whole page" at a time as if the continuous
7207 * area of the scroller content is split into page sized pieces. This sets
7208 * the size of a page relative to the viewport of the scroller. 1.0 is "1
7209 * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7210 * axis. This is mutually exclusive with page size
7211 * (see elm_scroller_page_size_set() for more information). Likewise 0.5
7212 * is "half a viewport". Sane usable values are normally between 0.0 and 1.0
7213 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7216 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7218 * @brief Set scroll page size.
7220 * @param obj The scroller object
7221 * @param h_pagesize The horizontal page size
7222 * @param v_pagesize The vertical page size
7224 * This sets the page size to an absolute fixed value, with 0 turning it off
7227 * @see elm_scroller_page_relative_set()
7229 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7231 * @brief Get scroll current page number.
7233 * @param obj The scroller object
7234 * @param h_pagenumber The horizontal page number
7235 * @param v_pagenumber The vertical page number
7237 * The page number starts from 0. 0 is the first page.
7238 * Current page means the page which meets the top-left of the viewport.
7239 * If there are two or more pages in the viewport, it returns the number of the page
7240 * which meets the top-left of the viewport.
7242 * @see elm_scroller_last_page_get()
7243 * @see elm_scroller_page_show()
7244 * @see elm_scroller_page_brint_in()
7246 EAPI void elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7248 * @brief Get scroll last page number.
7250 * @param obj The scroller object
7251 * @param h_pagenumber The horizontal page number
7252 * @param v_pagenumber The vertical page number
7254 * The page number starts from 0. 0 is the first page.
7255 * This returns the last page number among the pages.
7257 * @see elm_scroller_current_page_get()
7258 * @see elm_scroller_page_show()
7259 * @see elm_scroller_page_brint_in()
7261 EAPI void elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7263 * Show a specific virtual region within the scroller content object by page number.
7265 * @param obj The scroller object
7266 * @param h_pagenumber The horizontal page number
7267 * @param v_pagenumber The vertical page number
7269 * 0, 0 of the indicated page is located at the top-left of the viewport.
7270 * This will jump to the page directly without animation.
7275 * sc = elm_scroller_add(win);
7276 * elm_scroller_content_set(sc, content);
7277 * elm_scroller_page_relative_set(sc, 1, 0);
7278 * elm_scroller_current_page_get(sc, &h_page, &v_page);
7279 * elm_scroller_page_show(sc, h_page + 1, v_page);
7282 * @see elm_scroller_page_bring_in()
7284 EAPI void elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7286 * Show a specific virtual region within the scroller content object by page number.
7288 * @param obj The scroller object
7289 * @param h_pagenumber The horizontal page number
7290 * @param v_pagenumber The vertical page number
7292 * 0, 0 of the indicated page is located at the top-left of the viewport.
7293 * This will slide to the page with animation.
7298 * sc = elm_scroller_add(win);
7299 * elm_scroller_content_set(sc, content);
7300 * elm_scroller_page_relative_set(sc, 1, 0);
7301 * elm_scroller_last_page_get(sc, &h_page, &v_page);
7302 * elm_scroller_page_bring_in(sc, h_page, v_page);
7305 * @see elm_scroller_page_show()
7307 EAPI void elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7309 * @brief Show a specific virtual region within the scroller content object.
7311 * @param obj The scroller object
7312 * @param x X coordinate of the region
7313 * @param y Y coordinate of the region
7314 * @param w Width of the region
7315 * @param h Height of the region
7317 * This will ensure all (or part if it does not fit) of the designated
7318 * region in the virtual content object (0, 0 starting at the top-left of the
7319 * virtual content object) is shown within the scroller. Unlike
7320 * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7321 * to this location (if configuration in general calls for transitions). It
7322 * may not jump immediately to the new location and make take a while and
7323 * show other content along the way.
7325 * @see elm_scroller_region_show()
7327 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);
7329 * @brief Set event propagation on a scroller
7331 * @param obj The scroller object
7332 * @param propagation If propagation is enabled or not
7334 * This enables or disabled event propagation from the scroller content to
7335 * the scroller and its parent. By default event propagation is disabled.
7337 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation) EINA_ARG_NONNULL(1);
7339 * @brief Get event propagation for a scroller
7341 * @param obj The scroller object
7342 * @return The propagation state
7344 * This gets the event propagation for a scroller.
7346 * @see elm_scroller_propagate_events_set()
7348 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7350 * @brief Set scrolling gravity on a scroller
7352 * @param obj The scroller object
7353 * @param x The scrolling horizontal gravity
7354 * @param y The scrolling vertical gravity
7356 * The gravity, defines how the scroller will adjust its view
7357 * when the size of the scroller contents increase.
7359 * The scroller will adjust the view to glue itself as follows.
7361 * x=0.0, for showing the left most region of the content.
7362 * x=1.0, for showing the right most region of the content.
7363 * y=0.0, for showing the bottom most region of the content.
7364 * y=1.0, for showing the top most region of the content.
7366 * Default values for x and y are 0.0
7368 EAPI void elm_scroller_gravity_set(Evas_Object *obj, double x, double y) EINA_ARG_NONNULL(1);
7370 * @brief Get scrolling gravity values for a scroller
7372 * @param obj The scroller object
7373 * @param x The scrolling horizontal gravity
7374 * @param y The scrolling vertical gravity
7376 * This gets gravity values for a scroller.
7378 * @see elm_scroller_gravity_set()
7381 EAPI void elm_scroller_gravity_get(const Evas_Object *obj, double *x, double *y) EINA_ARG_NONNULL(1);
7387 * @defgroup Label Label
7389 * @image html img/widget/label/preview-00.png
7390 * @image latex img/widget/label/preview-00.eps
7392 * @brief Widget to display text, with simple html-like markup.
7394 * The Label widget @b doesn't allow text to overflow its boundaries, if the
7395 * text doesn't fit the geometry of the label it will be ellipsized or be
7396 * cut. Elementary provides several themes for this widget:
7397 * @li default - No animation
7398 * @li marker - Centers the text in the label and make it bold by default
7399 * @li slide_long - The entire text appears from the right of the screen and
7400 * slides until it disappears in the left of the screen(reappering on the
7402 * @li slide_short - The text appears in the left of the label and slides to
7403 * the right to show the overflow. When all of the text has been shown the
7404 * position is reset.
7405 * @li slide_bounce - The text appears in the left of the label and slides to
7406 * the right to show the overflow. When all of the text has been shown the
7407 * animation reverses, moving the text to the left.
7409 * Custom themes can of course invent new markup tags and style them any way
7412 * The following signals may be emitted by the label widget:
7413 * @li "language,changed": The program's language changed.
7415 * See @ref tutorial_label for a demonstration of how to use a label widget.
7419 * @brief Add a new label to the parent
7421 * @param parent The parent object
7422 * @return The new object or NULL if it cannot be created
7424 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7426 * @brief Set the label on the label object
7428 * @param obj The label object
7429 * @param label The label will be used on the label object
7430 * @deprecated See elm_object_text_set()
7432 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 */
7434 * @brief Get the label used on the label object
7436 * @param obj The label object
7437 * @return The string inside the label
7438 * @deprecated See elm_object_text_get()
7440 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7442 * @brief Set the wrapping behavior of the label
7444 * @param obj The label object
7445 * @param wrap To wrap text or not
7447 * By default no wrapping is done. Possible values for @p wrap are:
7448 * @li ELM_WRAP_NONE - No wrapping
7449 * @li ELM_WRAP_CHAR - wrap between characters
7450 * @li ELM_WRAP_WORD - wrap between words
7451 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7453 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7455 * @brief Get the wrapping behavior of the label
7457 * @param obj The label object
7460 * @see elm_label_line_wrap_set()
7462 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7464 * @brief Set wrap width of the label
7466 * @param obj The label object
7467 * @param w The wrap width in pixels at a minimum where words need to wrap
7469 * This function sets the maximum width size hint of the label.
7471 * @warning This is only relevant if the label is inside a container.
7473 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7475 * @brief Get wrap width of the label
7477 * @param obj The label object
7478 * @return The wrap width in pixels at a minimum where words need to wrap
7480 * @see elm_label_wrap_width_set()
7482 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7484 * @brief Set wrap height of the label
7486 * @param obj The label object
7487 * @param h The wrap height in pixels at a minimum where words need to wrap
7489 * This function sets the maximum height size hint of the label.
7491 * @warning This is only relevant if the label is inside a container.
7493 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7495 * @brief get wrap width of the label
7497 * @param obj The label object
7498 * @return The wrap height in pixels at a minimum where words need to wrap
7500 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7502 * @brief Set the font size on the label object.
7504 * @param obj The label object
7505 * @param size font size
7507 * @warning NEVER use this. It is for hyper-special cases only. use styles
7508 * instead. e.g. "big", "medium", "small" - or better name them by use:
7509 * "title", "footnote", "quote" etc.
7511 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7513 * @brief Set the text color on the label object
7515 * @param obj The label object
7516 * @param r Red property background color of The label object
7517 * @param g Green property background color of The label object
7518 * @param b Blue property background color of The label object
7519 * @param a Alpha property background color of The label object
7521 * @warning NEVER use this. It is for hyper-special cases only. use styles
7522 * instead. e.g. "big", "medium", "small" - or better name them by use:
7523 * "title", "footnote", "quote" etc.
7525 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);
7527 * @brief Set the text align on the label object
7529 * @param obj The label object
7530 * @param align align mode ("left", "center", "right")
7532 * @warning NEVER use this. It is for hyper-special cases only. use styles
7533 * instead. e.g. "big", "medium", "small" - or better name them by use:
7534 * "title", "footnote", "quote" etc.
7536 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7538 * @brief Set background color of the label
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 alpha 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_background_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 ellipsis behavior of the label
7554 * @param obj The label object
7555 * @param ellipsis To ellipsis text or not
7557 * If set to true and the text doesn't fit in the label an ellipsis("...")
7558 * will be shown at the end of the widget.
7560 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7561 * choosen wrap method was ELM_WRAP_WORD.
7563 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7565 * @brief Set the text slide of the label
7567 * @param obj The label object
7568 * @param slide To start slide or stop
7570 * If set to true, the text of the label will slide/scroll through the length of
7573 * @warning This only works with the themes "slide_short", "slide_long" and
7576 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7578 * @brief Get the text slide mode of the label
7580 * @param obj The label object
7581 * @return slide slide mode value
7583 * @see elm_label_slide_set()
7585 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7587 * @brief Set the slide duration(speed) of the label
7589 * @param obj The label object
7590 * @return The duration in seconds in moving text from slide begin position
7591 * to slide end position
7593 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7595 * @brief Get the slide duration(speed) of the label
7597 * @param obj The label object
7598 * @return The duration time in moving text from slide begin position to slide end position
7600 * @see elm_label_slide_duration_set()
7602 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7608 * @defgroup Toggle Toggle
7610 * @image html img/widget/toggle/preview-00.png
7611 * @image latex img/widget/toggle/preview-00.eps
7613 * @brief A toggle is a slider which can be used to toggle between
7614 * two values. It has two states: on and off.
7616 * This widget is deprecated. Please use elm_check_add() instead using the
7617 * toggle style like:
7620 * obj = elm_check_add(parent);
7621 * elm_object_style_set(obj, "toggle");
7622 * elm_object_part_text_set(obj, "on", "ON");
7623 * elm_object_part_text_set(obj, "off", "OFF");
7626 * Signals that you can add callbacks for are:
7627 * @li "changed" - Whenever the toggle value has been changed. Is not called
7628 * until the toggle is released by the cursor (assuming it
7629 * has been triggered by the cursor in the first place).
7631 * Default contents parts of the toggle widget that you can use for are:
7632 * @li "icon" - A icon of the toggle
7634 * Default text parts of the toggle widget that you can use for are:
7635 * @li "elm.text" - Label of the toggle
7637 * @ref tutorial_toggle show how to use a toggle.
7641 * @brief Add a toggle to @p parent.
7643 * @param parent The parent object
7645 * @return The toggle object
7647 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7649 * @brief Sets the label to be displayed with the toggle.
7651 * @param obj The toggle object
7652 * @param label The label to be displayed
7654 * @deprecated use elm_object_text_set() instead.
7656 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7658 * @brief Gets the label of the toggle
7660 * @param obj toggle object
7661 * @return The label of the toggle
7663 * @deprecated use elm_object_text_get() instead.
7665 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7667 * @brief Set the icon used for the toggle
7669 * @param obj The toggle object
7670 * @param icon The icon object for the button
7672 * Once the icon object is set, a previously set one will be deleted
7673 * If you want to keep that old content object, use the
7674 * elm_toggle_icon_unset() function.
7676 * @deprecated use elm_object_part_content_set() instead.
7678 EINA_DEPRECATED EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7680 * @brief Get the icon used for the toggle
7682 * @param obj The toggle object
7683 * @return The icon object that is being used
7685 * Return the icon object which is set for this widget.
7687 * @see elm_toggle_icon_set()
7689 * @deprecated use elm_object_part_content_get() instead.
7691 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7693 * @brief Unset the icon used for the toggle
7695 * @param obj The toggle object
7696 * @return The icon object that was being used
7698 * Unparent and return the icon object which was set for this widget.
7700 * @see elm_toggle_icon_set()
7702 * @deprecated use elm_object_part_content_unset() instead.
7704 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7706 * @brief Sets the labels to be associated with the on and off states of the toggle.
7708 * @param obj The toggle object
7709 * @param onlabel The label displayed when the toggle is in the "on" state
7710 * @param offlabel The label displayed when the toggle is in the "off" state
7712 * @deprecated use elm_object_part_text_set() for "on" and "off" parts
7715 EINA_DEPRECATED EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7717 * @brief Gets the labels associated with the on and off states of the
7720 * @param obj The toggle object
7721 * @param onlabel A char** to place the onlabel of @p obj into
7722 * @param offlabel A char** to place the offlabel of @p obj into
7724 * @deprecated use elm_object_part_text_get() for "on" and "off" parts
7727 EINA_DEPRECATED EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7729 * @brief Sets the state of the toggle to @p state.
7731 * @param obj The toggle object
7732 * @param state The state of @p obj
7734 * @deprecated use elm_check_state_set() instead.
7736 EINA_DEPRECATED EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7738 * @brief Gets the state of the toggle to @p state.
7740 * @param obj The toggle object
7741 * @return The state of @p obj
7743 * @deprecated use elm_check_state_get() instead.
7745 EINA_DEPRECATED EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7747 * @brief Sets the state pointer of the toggle to @p statep.
7749 * @param obj The toggle object
7750 * @param statep The state pointer of @p obj
7752 * @deprecated use elm_check_state_pointer_set() instead.
7754 EINA_DEPRECATED EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7760 * @defgroup Frame Frame
7762 * @image html img/widget/frame/preview-00.png
7763 * @image latex img/widget/frame/preview-00.eps
7765 * @brief Frame is a widget that holds some content and has a title.
7767 * The default look is a frame with a title, but Frame supports multple
7775 * @li outdent_bottom
7777 * Of all this styles only default shows the title. Frame emits no signals.
7779 * Default contents parts of the frame widget that you can use for are:
7780 * @li "default" - A content of the frame
7782 * Default text parts of the frame widget that you can use for are:
7783 * @li "elm.text" - Label of the frame
7785 * For a detailed example see the @ref tutorial_frame.
7790 * @brief Add a new frame to the parent
7792 * @param parent The parent object
7793 * @return The new object or NULL if it cannot be created
7795 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7797 * @brief Set the frame label
7799 * @param obj The frame object
7800 * @param label The label of this frame object
7802 * @deprecated use elm_object_text_set() instead.
7804 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7806 * @brief Get the frame label
7808 * @param obj The frame object
7810 * @return The label of this frame objet or NULL if unable to get frame
7812 * @deprecated use elm_object_text_get() instead.
7814 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7816 * @brief Set the content of the frame widget
7818 * Once the content object is set, a previously set one will be deleted.
7819 * If you want to keep that old content object, use the
7820 * elm_frame_content_unset() function.
7822 * @param obj The frame object
7823 * @param content The content will be filled in this frame object
7825 * @deprecated use elm_object_content_set() instead.
7827 EINA_DEPRECATED EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7829 * @brief Get the content of the frame widget
7831 * Return the content object which is set for this widget
7833 * @param obj The frame object
7834 * @return The content that is being used
7836 * @deprecated use elm_object_content_get() instead.
7838 EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7840 * @brief Unset the content of the frame widget
7842 * Unparent and return the content object which was set for this widget
7844 * @param obj The frame object
7845 * @return The content that was being used
7847 * @deprecated use elm_object_content_unset() instead.
7849 EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7855 * @defgroup Table Table
7857 * A container widget to arrange other widgets in a table where items can
7858 * also span multiple columns or rows - even overlap (and then be raised or
7859 * lowered accordingly to adjust stacking if they do overlap).
7861 * For a Table widget the row/column count is not fixed.
7862 * The table widget adjusts itself when subobjects are added to it dynamically.
7864 * The followin are examples of how to use a table:
7865 * @li @ref tutorial_table_01
7866 * @li @ref tutorial_table_02
7871 * @brief Add a new table to the parent
7873 * @param parent The parent object
7874 * @return The new object or NULL if it cannot be created
7876 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7878 * @brief Set the homogeneous layout in the table
7880 * @param obj The layout object
7881 * @param homogeneous A boolean to set if the layout is homogeneous in the
7882 * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7884 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7886 * @brief Get the current table homogeneous mode.
7888 * @param obj The table object
7889 * @return A boolean to indicating if the layout is homogeneous in the table
7890 * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7892 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7894 * @warning <b>Use elm_table_homogeneous_set() instead</b>
7896 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7898 * @warning <b>Use elm_table_homogeneous_get() instead</b>
7900 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7902 * @brief Set padding between cells.
7904 * @param obj The layout object.
7905 * @param horizontal set the horizontal padding.
7906 * @param vertical set the vertical padding.
7908 * Default value is 0.
7910 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7912 * @brief Get padding between cells.
7914 * @param obj The layout object.
7915 * @param horizontal set the horizontal padding.
7916 * @param vertical set the vertical padding.
7918 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7920 * @brief Add a subobject on the table with the coordinates passed
7922 * @param obj The table object
7923 * @param subobj The subobject to be added to the table
7924 * @param x Row number
7925 * @param y Column number
7929 * @note All positioning inside the table is relative to rows and columns, so
7930 * a value of 0 for x and y, means the top left cell of the table, and a
7931 * value of 1 for w and h means @p subobj only takes that 1 cell.
7933 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7935 * @brief Remove child from table.
7937 * @param obj The table object
7938 * @param subobj The subobject
7940 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
7942 * @brief Faster way to remove all child objects from a table object.
7944 * @param obj The table object
7945 * @param clear If true, will delete children, else just remove from table.
7947 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
7949 * @brief Set the packing location of an existing child of the table
7951 * @param subobj The subobject to be modified in the table
7952 * @param x Row number
7953 * @param y Column number
7957 * Modifies the position of an object already in the table.
7959 * @note All positioning inside the table is relative to rows and columns, so
7960 * a value of 0 for x and y, means the top left cell of the table, and a
7961 * value of 1 for w and h means @p subobj only takes that 1 cell.
7963 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7965 * @brief Get the packing location of an existing child of the table
7967 * @param subobj The subobject to be modified in the table
7968 * @param x Row number
7969 * @param y Column number
7973 * @see elm_table_pack_set()
7975 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
7980 /* TEMPORARY: DOCS WILL BE FILLED IN WITH CNP/SED */
7981 typedef struct Elm_Gen_Item Elm_Gen_Item;
7982 typedef struct _Elm_Gen_Item_Class Elm_Gen_Item_Class;
7983 typedef struct _Elm_Gen_Item_Class_Func Elm_Gen_Item_Class_Func; /**< Class functions for gen item classes. */
7984 typedef char *(*Elm_Gen_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gen item classes. */
7985 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. */
7986 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. */
7987 typedef void (*Elm_Gen_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for gen item classes. */
7988 struct _Elm_Gen_Item_Class
7990 const char *item_style;
7991 struct _Elm_Gen_Item_Class_Func
7993 Elm_Gen_Item_Label_Get_Cb label_get;
7994 Elm_Gen_Item_Content_Get_Cb content_get;
7995 Elm_Gen_Item_State_Get_Cb state_get;
7996 Elm_Gen_Item_Del_Cb del;
7999 EAPI void elm_gen_clear(Evas_Object *obj);
8000 EAPI void elm_gen_item_selected_set(Elm_Gen_Item *it, Eina_Bool selected);
8001 EAPI Eina_Bool elm_gen_item_selected_get(const Elm_Gen_Item *it);
8002 EAPI void elm_gen_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select);
8003 EAPI Eina_Bool elm_gen_always_select_mode_get(const Evas_Object *obj);
8004 EAPI void elm_gen_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select);
8005 EAPI Eina_Bool elm_gen_no_select_mode_get(const Evas_Object *obj);
8006 EAPI void elm_gen_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
8007 EAPI void elm_gen_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
8008 EAPI void elm_gen_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel);
8009 EAPI void elm_gen_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel);
8010 EAPI void elm_gen_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize);
8011 EAPI void elm_gen_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
8012 EAPI void elm_gen_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
8013 EAPI void elm_gen_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
8014 EAPI void elm_gen_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
8015 EAPI Elm_Gen_Item *elm_gen_first_item_get(const Evas_Object *obj);
8016 EAPI Elm_Gen_Item *elm_gen_last_item_get(const Evas_Object *obj);
8017 EAPI Elm_Gen_Item *elm_gen_item_next_get(const Elm_Gen_Item *it);
8018 EAPI Elm_Gen_Item *elm_gen_item_prev_get(const Elm_Gen_Item *it);
8019 EAPI Evas_Object *elm_gen_item_widget_get(const Elm_Gen_Item *it);
8022 * @defgroup Gengrid Gengrid (Generic grid)
8024 * This widget aims to position objects in a grid layout while
8025 * actually creating and rendering only the visible ones, using the
8026 * same idea as the @ref Genlist "genlist": the user defines a @b
8027 * class for each item, specifying functions that will be called at
8028 * object creation, deletion, etc. When those items are selected by
8029 * the user, a callback function is issued. Users may interact with
8030 * a gengrid via the mouse (by clicking on items to select them and
8031 * clicking on the grid's viewport and swiping to pan the whole
8032 * view) or via the keyboard, navigating through item with the
8035 * @section Gengrid_Layouts Gengrid layouts
8037 * Gengrid may layout its items in one of two possible layouts:
8041 * When in "horizontal mode", items will be placed in @b columns,
8042 * from top to bottom and, when the space for a column is filled,
8043 * another one is started on the right, thus expanding the grid
8044 * horizontally, making for horizontal scrolling. When in "vertical
8045 * mode" , though, items will be placed in @b rows, from left to
8046 * right and, when the space for a row is filled, another one is
8047 * started below, thus expanding the grid vertically (and making
8048 * for vertical scrolling).
8050 * @section Gengrid_Items Gengrid items
8052 * An item in a gengrid can have 0 or more text labels (they can be
8053 * regular text or textblock Evas objects - that's up to the style
8054 * to determine), 0 or more icons (which are simply objects
8055 * swallowed into the gengrid item's theming Edje object) and 0 or
8056 * more <b>boolean states</b>, which have the behavior left to the
8057 * user to define. The Edje part names for each of these properties
8058 * will be looked up, in the theme file for the gengrid, under the
8059 * Edje (string) data items named @c "labels", @c "icons" and @c
8060 * "states", respectively. For each of those properties, if more
8061 * than one part is provided, they must have names listed separated
8062 * by spaces in the data fields. For the default gengrid item
8063 * theme, we have @b one label part (@c "elm.text"), @b two icon
8064 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
8067 * A gengrid item may be at one of several styles. Elementary
8068 * provides one by default - "default", but this can be extended by
8069 * system or application custom themes/overlays/extensions (see
8070 * @ref Theme "themes" for more details).
8072 * @section Gengrid_Item_Class Gengrid item classes
8074 * In order to have the ability to add and delete items on the fly,
8075 * gengrid implements a class (callback) system where the
8076 * application provides a structure with information about that
8077 * type of item (gengrid may contain multiple different items with
8078 * different classes, states and styles). Gengrid will call the
8079 * functions in this struct (methods) when an item is "realized"
8080 * (i.e., created dynamically, while the user is scrolling the
8081 * grid). All objects will simply be deleted when no longer needed
8082 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
8083 * contains the following members:
8084 * - @c item_style - This is a constant string and simply defines
8085 * the name of the item style. It @b must be specified and the
8086 * default should be @c "default".
8087 * - @c func.label_get - This function is called when an item
8088 * object is actually created. The @c data parameter will point to
8089 * the same data passed to elm_gengrid_item_append() and related
8090 * item creation functions. The @c obj parameter is the gengrid
8091 * object itself, while the @c part one is the name string of one
8092 * of the existing text parts in the Edje group implementing the
8093 * item's theme. This function @b must return a strdup'()ed string,
8094 * as the caller will free() it when done. See
8095 * #Elm_Gengrid_Item_Label_Get_Cb.
8096 * - @c func.content_get - This function is called when an item object
8097 * is actually created. The @c data parameter will point to the
8098 * same data passed to elm_gengrid_item_append() and related item
8099 * creation functions. The @c obj parameter is the gengrid object
8100 * itself, while the @c part one is the name string of one of the
8101 * existing (content) swallow parts in the Edje group implementing the
8102 * item's theme. It must return @c NULL, when no content is desired,
8103 * or a valid object handle, otherwise. The object will be deleted
8104 * by the gengrid on its deletion or when the item is "unrealized".
8105 * See #Elm_Gengrid_Item_Content_Get_Cb.
8106 * - @c func.state_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 state parts in the Edje group implementing the item's
8112 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
8113 * true/on. Gengrids will emit a signal to its theming Edje object
8114 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
8115 * "source" arguments, respectively, when the state is true (the
8116 * default is false), where @c XXX is the name of the (state) part.
8117 * See #Elm_Gengrid_Item_State_Get_Cb.
8118 * - @c func.del - This is called when elm_gengrid_item_del() is
8119 * called on an item or elm_gengrid_clear() is called on the
8120 * gengrid. This is intended for use when gengrid items are
8121 * deleted, so any data attached to the item (e.g. its data
8122 * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
8124 * @section Gengrid_Usage_Hints Usage hints
8126 * If the user wants to have multiple items selected at the same
8127 * time, elm_gengrid_multi_select_set() will permit it. If the
8128 * gengrid is single-selection only (the default), then
8129 * elm_gengrid_select_item_get() will return the selected item or
8130 * @c NULL, if none is selected. If the gengrid is under
8131 * multi-selection, then elm_gengrid_selected_items_get() will
8132 * return a list (that is only valid as long as no items are
8133 * modified (added, deleted, selected or unselected) of child items
8136 * If an item changes (internal (boolean) state, label or content
8137 * changes), then use elm_gengrid_item_update() to have gengrid
8138 * update the item with the new state. A gengrid will re-"realize"
8139 * the item, thus calling the functions in the
8140 * #Elm_Gengrid_Item_Class set for that item.
8142 * To programmatically (un)select an item, use
8143 * elm_gengrid_item_selected_set(). To get its selected state use
8144 * elm_gengrid_item_selected_get(). To make an item disabled
8145 * (unable to be selected and appear differently) use
8146 * elm_gengrid_item_disabled_set() to set this and
8147 * elm_gengrid_item_disabled_get() to get the disabled state.
8149 * Grid cells will only have their selection smart callbacks called
8150 * when firstly getting selected. Any further clicks will do
8151 * nothing, unless you enable the "always select mode", with
8152 * elm_gengrid_always_select_mode_set(), thus making every click to
8153 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
8154 * turn off the ability to select items entirely in the widget and
8155 * they will neither appear selected nor call the selection smart
8158 * Remember that you can create new styles and add your own theme
8159 * augmentation per application with elm_theme_extension_add(). If
8160 * you absolutely must have a specific style that overrides any
8161 * theme the user or system sets up you can use
8162 * elm_theme_overlay_add() to add such a file.
8164 * @section Gengrid_Smart_Events Gengrid smart events
8166 * Smart events that you can add callbacks for are:
8167 * - @c "activated" - The user has double-clicked or pressed
8168 * (enter|return|spacebar) on an item. The @c event_info parameter
8169 * is the gengrid item that was activated.
8170 * - @c "clicked,double" - The user has double-clicked an item.
8171 * The @c event_info parameter is the gengrid item that was double-clicked.
8172 * - @c "longpressed" - This is called when the item is pressed for a certain
8173 * amount of time. By default it's 1 second.
8174 * - @c "selected" - The user has made an item selected. The
8175 * @c event_info parameter is the gengrid item that was selected.
8176 * - @c "unselected" - The user has made an item unselected. The
8177 * @c event_info parameter is the gengrid item that was unselected.
8178 * - @c "realized" - This is called when the item in the gengrid
8179 * has its implementing Evas object instantiated, de facto. @c
8180 * event_info is the gengrid item that was created. The object
8181 * may be deleted at any time, so it is highly advised to the
8182 * caller @b not to use the object pointer returned from
8183 * elm_gengrid_item_object_get(), because it may point to freed
8185 * - @c "unrealized" - This is called when the implementing Evas
8186 * object for this item is deleted. @c event_info is the gengrid
8187 * item that was deleted.
8188 * - @c "changed" - Called when an item is added, removed, resized
8189 * or moved and when the gengrid is resized or gets "horizontal"
8191 * - @c "scroll,anim,start" - This is called when scrolling animation has
8193 * - @c "scroll,anim,stop" - This is called when scrolling animation has
8195 * - @c "drag,start,up" - Called when the item in the gengrid has
8196 * been dragged (not scrolled) up.
8197 * - @c "drag,start,down" - Called when the item in the gengrid has
8198 * been dragged (not scrolled) down.
8199 * - @c "drag,start,left" - Called when the item in the gengrid has
8200 * been dragged (not scrolled) left.
8201 * - @c "drag,start,right" - Called when the item in the gengrid has
8202 * been dragged (not scrolled) right.
8203 * - @c "drag,stop" - Called when the item in the gengrid has
8204 * stopped being dragged.
8205 * - @c "drag" - Called when the item in the gengrid is being
8207 * - @c "scroll" - called when the content has been scrolled
8209 * - @c "scroll,drag,start" - called when dragging the content has
8211 * - @c "scroll,drag,stop" - called when dragging the content has
8213 * - @c "edge,top" - This is called when the gengrid is scrolled until
8215 * - @c "edge,bottom" - This is called when the gengrid is scrolled
8216 * until the bottom edge.
8217 * - @c "edge,left" - This is called when the gengrid is scrolled
8218 * until the left edge.
8219 * - @c "edge,right" - This is called when the gengrid is scrolled
8220 * until the right edge.
8222 * List of gengrid examples:
8223 * @li @ref gengrid_example
8227 * @addtogroup Gengrid
8231 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
8232 #define Elm_Gengrid_Item_Class Elm_Gen_Item_Class
8233 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
8234 #define Elm_Gengrid_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
8235 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
8237 * Label fetching class function for Elm_Gen_Item_Class.
8238 * @param data The data passed in the item creation function
8239 * @param obj The base widget object
8240 * @param part The part name of the swallow
8241 * @return The allocated (NOT stringshared) string to set as the label
8243 typedef char *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8245 * Content (swallowed object) fetching class function for Elm_Gen_Item_Class.
8246 * @param data The data passed in the item creation function
8247 * @param obj The base widget object
8248 * @param part The part name of the swallow
8249 * @return The content object to swallow
8251 typedef Evas_Object *(*Elm_Gengrid_Item_Content_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8253 * State fetching class function for Elm_Gen_Item_Class.
8254 * @param data The data passed in the item creation function
8255 * @param obj The base widget object
8256 * @param part The part name of the swallow
8257 * @return The hell if I know
8259 typedef Eina_Bool (*Elm_Gengrid_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8261 * Deletion class function for Elm_Gen_Item_Class.
8262 * @param data The data passed in the item creation function
8263 * @param obj The base widget object
8265 typedef void (*Elm_Gengrid_Item_Del_Cb) (void *data, Evas_Object *obj);
8268 * @struct _Elm_Gengrid_Item_Class
8270 * Gengrid item class definition. See @ref Gengrid_Item_Class for
8273 struct _Elm_Gengrid_Item_Class
8275 const char *item_style;
8276 struct _Elm_Gengrid_Item_Class_Func
8278 Elm_Gengrid_Item_Label_Get_Cb label_get;
8279 Elm_Gengrid_Item_Content_Get_Cb content_get;
8280 Elm_Gengrid_Item_State_Get_Cb state_get;
8281 Elm_Gengrid_Item_Del_Cb del;
8283 }; /**< #Elm_Gengrid_Item_Class member definitions */
8284 #define Elm_Gengrid_Item_Class_Func Elm_Gen_Item_Class_Func
8286 * Add a new gengrid widget to the given parent Elementary
8287 * (container) object
8289 * @param parent The parent object
8290 * @return a new gengrid widget handle or @c NULL, on errors
8292 * This function inserts a new gengrid widget on the canvas.
8294 * @see elm_gengrid_item_size_set()
8295 * @see elm_gengrid_group_item_size_set()
8296 * @see elm_gengrid_horizontal_set()
8297 * @see elm_gengrid_item_append()
8298 * @see elm_gengrid_item_del()
8299 * @see elm_gengrid_clear()
8303 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8306 * Set the size for the items of a given gengrid widget
8308 * @param obj The gengrid object.
8309 * @param w The items' width.
8310 * @param h The items' height;
8312 * A gengrid, after creation, has still no information on the size
8313 * to give to each of its cells. So, you most probably will end up
8314 * with squares one @ref Fingers "finger" wide, the default
8315 * size. Use this function to force a custom size for you items,
8316 * making them as big as you wish.
8318 * @see elm_gengrid_item_size_get()
8322 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8325 * Get the size set for the items of a given gengrid widget
8327 * @param obj The gengrid object.
8328 * @param w Pointer to a variable where to store the items' width.
8329 * @param h Pointer to a variable where to store the items' height.
8331 * @note Use @c NULL pointers on the size values you're not
8332 * interested in: they'll be ignored by the function.
8334 * @see elm_gengrid_item_size_get() for more details
8338 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8341 * Set the size for the group items of a given gengrid widget
8343 * @param obj The gengrid object.
8344 * @param w The group items' width.
8345 * @param h The group items' height;
8347 * A gengrid, after creation, has still no information on the size
8348 * to give to each of its cells. So, you most probably will end up
8349 * with squares one @ref Fingers "finger" wide, the default
8350 * size. Use this function to force a custom size for you group items,
8351 * making them as big as you wish.
8353 * @see elm_gengrid_group_item_size_get()
8357 EAPI void elm_gengrid_group_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8360 * Get the size set for the group items of a given gengrid widget
8362 * @param obj The gengrid object.
8363 * @param w Pointer to a variable where to store the group items' width.
8364 * @param h Pointer to a variable where to store the group items' height.
8366 * @note Use @c NULL pointers on the size values you're not
8367 * interested in: they'll be ignored by the function.
8369 * @see elm_gengrid_group_item_size_get() for more details
8373 EAPI void elm_gengrid_group_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8376 * Set the items grid's alignment within a given gengrid widget
8378 * @param obj The gengrid object.
8379 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8380 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8382 * This sets the alignment of the whole grid of items of a gengrid
8383 * within its given viewport. By default, those values are both
8384 * 0.5, meaning that the gengrid will have its items grid placed
8385 * exactly in the middle of its viewport.
8387 * @note If given alignment values are out of the cited ranges,
8388 * they'll be changed to the nearest boundary values on the valid
8391 * @see elm_gengrid_align_get()
8395 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8398 * Get the items grid's alignment values within a given gengrid
8401 * @param obj The gengrid object.
8402 * @param align_x Pointer to a variable where to store the
8403 * horizontal alignment.
8404 * @param align_y Pointer to a variable where to store the vertical
8407 * @note Use @c NULL pointers on the alignment values you're not
8408 * interested in: they'll be ignored by the function.
8410 * @see elm_gengrid_align_set() for more details
8414 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8417 * Set whether a given gengrid widget is or not able have items
8420 * @param obj The gengrid object
8421 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8422 * @c EINA_FALSE to turn it off
8424 * If a gengrid is set to allow reordering, a click held for more
8425 * than 0.5 over a given item will highlight it specially,
8426 * signalling the gengrid has entered the reordering state. From
8427 * that time on, the user will be able to, while still holding the
8428 * mouse button down, move the item freely in the gengrid's
8429 * viewport, replacing to said item to the locations it goes to.
8430 * The replacements will be animated and, whenever the user
8431 * releases the mouse button, the item being replaced gets a new
8432 * definitive place in the grid.
8434 * @see elm_gengrid_reorder_mode_get()
8438 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8441 * Get whether a given gengrid widget is or not able have items
8444 * @param obj The gengrid object
8445 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8448 * @see elm_gengrid_reorder_mode_set() for more details
8452 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8455 * Append a new item in a given gengrid widget.
8457 * @param obj The gengrid object.
8458 * @param gic The item class for the item.
8459 * @param data The item data.
8460 * @param func Convenience function called when the item is
8462 * @param func_data Data to be passed to @p func.
8463 * @return A handle to the item added or @c NULL, on errors.
8465 * This adds an item to the beginning of the gengrid.
8467 * @see elm_gengrid_item_prepend()
8468 * @see elm_gengrid_item_insert_before()
8469 * @see elm_gengrid_item_insert_after()
8470 * @see elm_gengrid_item_del()
8474 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);
8477 * Prepend a new item in a given gengrid widget.
8479 * @param obj The gengrid object.
8480 * @param gic The item class for the item.
8481 * @param data The item data.
8482 * @param func Convenience function called when the item is
8484 * @param func_data Data to be passed to @p func.
8485 * @return A handle to the item added or @c NULL, on errors.
8487 * This adds an item to the end of the gengrid.
8489 * @see elm_gengrid_item_append()
8490 * @see elm_gengrid_item_insert_before()
8491 * @see elm_gengrid_item_insert_after()
8492 * @see elm_gengrid_item_del()
8496 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);
8499 * Insert an item before another in a gengrid widget
8501 * @param obj The gengrid object.
8502 * @param gic The item class for the item.
8503 * @param data The item data.
8504 * @param relative The item to place this new one before.
8505 * @param func Convenience function called when the item is
8507 * @param func_data Data to be passed to @p func.
8508 * @return A handle to the item added or @c NULL, on errors.
8510 * This inserts an item before another in the gengrid.
8512 * @see elm_gengrid_item_append()
8513 * @see elm_gengrid_item_prepend()
8514 * @see elm_gengrid_item_insert_after()
8515 * @see elm_gengrid_item_del()
8519 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);
8522 * Insert an item after another in a gengrid widget
8524 * @param obj The gengrid object.
8525 * @param gic The item class for the item.
8526 * @param data The item data.
8527 * @param relative The item to place this new one after.
8528 * @param func Convenience function called when the item is
8530 * @param func_data Data to be passed to @p func.
8531 * @return A handle to the item added or @c NULL, on errors.
8533 * This inserts an item after another in the gengrid.
8535 * @see elm_gengrid_item_append()
8536 * @see elm_gengrid_item_prepend()
8537 * @see elm_gengrid_item_insert_after()
8538 * @see elm_gengrid_item_del()
8542 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);
8545 * Insert an item in a gengrid widget using a user-defined sort function.
8547 * @param obj The gengrid object.
8548 * @param gic The item class for the item.
8549 * @param data The item data.
8550 * @param comp User defined comparison function that defines the sort order based on
8551 * Elm_Gen_Item and its data param.
8552 * @param func Convenience function called when the item is selected.
8553 * @param func_data Data to be passed to @p func.
8554 * @return A handle to the item added or @c NULL, on errors.
8556 * This inserts an item in the gengrid based on user defined comparison function.
8558 * @see elm_gengrid_item_append()
8559 * @see elm_gengrid_item_prepend()
8560 * @see elm_gengrid_item_insert_after()
8561 * @see elm_gengrid_item_del()
8562 * @see elm_gengrid_item_direct_sorted_insert()
8566 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);
8569 * Insert an item in a gengrid widget using a user-defined sort function.
8571 * @param obj The gengrid object.
8572 * @param gic The item class for the item.
8573 * @param data The item data.
8574 * @param comp User defined comparison function that defines the sort order based on
8576 * @param func Convenience function called when the item is selected.
8577 * @param func_data Data to be passed to @p func.
8578 * @return A handle to the item added or @c NULL, on errors.
8580 * This inserts an item in the gengrid based on user defined comparison function.
8582 * @see elm_gengrid_item_append()
8583 * @see elm_gengrid_item_prepend()
8584 * @see elm_gengrid_item_insert_after()
8585 * @see elm_gengrid_item_del()
8586 * @see elm_gengrid_item_sorted_insert()
8590 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);
8593 * Set whether items on a given gengrid widget are to get their
8594 * selection callbacks issued for @b every subsequent selection
8595 * click on them or just for the first click.
8597 * @param obj The gengrid object
8598 * @param always_select @c EINA_TRUE to make items "always
8599 * selected", @c EINA_FALSE, otherwise
8601 * By default, grid items will only call their selection callback
8602 * function when firstly getting selected, any subsequent further
8603 * clicks will do nothing. With this call, you make those
8604 * subsequent clicks also to issue the selection callbacks.
8606 * @note <b>Double clicks</b> will @b always be reported on items.
8608 * @see elm_gengrid_always_select_mode_get()
8612 EINA_DEPRECATED EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8615 * Get whether items on a given gengrid widget have their selection
8616 * callbacks issued for @b every subsequent selection click on them
8617 * or just for the first click.
8619 * @param obj The gengrid object.
8620 * @return @c EINA_TRUE if the gengrid items are "always selected",
8621 * @c EINA_FALSE, otherwise
8623 * @see elm_gengrid_always_select_mode_set() for more details
8627 EINA_DEPRECATED EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8630 * Set whether items on a given gengrid widget can be selected or not.
8632 * @param obj The gengrid object
8633 * @param no_select @c EINA_TRUE to make items selectable,
8634 * @c EINA_FALSE otherwise
8636 * This will make items in @p obj selectable or not. In the latter
8637 * case, any user interaction on the gengrid items will neither make
8638 * them appear selected nor them call their selection callback
8641 * @see elm_gengrid_no_select_mode_get()
8645 EINA_DEPRECATED EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8648 * Get whether items on a given gengrid widget can be selected or
8651 * @param obj The gengrid object
8652 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8655 * @see elm_gengrid_no_select_mode_set() for more details
8659 EINA_DEPRECATED EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8662 * Enable or disable multi-selection in a given gengrid widget
8664 * @param obj The gengrid object.
8665 * @param multi @c EINA_TRUE, to enable multi-selection,
8666 * @c EINA_FALSE to disable it.
8668 * Multi-selection is the ability to have @b more than one
8669 * item selected, on a given gengrid, simultaneously. When it is
8670 * enabled, a sequence of clicks on different items will make them
8671 * all selected, progressively. A click on an already selected item
8672 * will unselect it. If interacting via the keyboard,
8673 * multi-selection is enabled while holding the "Shift" key.
8675 * @note By default, multi-selection is @b disabled on gengrids
8677 * @see elm_gengrid_multi_select_get()
8681 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8684 * Get whether multi-selection is enabled or disabled for a given
8687 * @param obj The gengrid object.
8688 * @return @c EINA_TRUE, if multi-selection is enabled, @c
8689 * EINA_FALSE otherwise
8691 * @see elm_gengrid_multi_select_set() for more details
8695 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8698 * Enable or disable bouncing effect for a given gengrid widget
8700 * @param obj The gengrid object
8701 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8702 * @c EINA_FALSE to disable it
8703 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8704 * @c EINA_FALSE to disable it
8706 * The bouncing effect occurs whenever one reaches the gengrid's
8707 * edge's while panning it -- it will scroll past its limits a
8708 * little bit and return to the edge again, in a animated for,
8711 * @note By default, gengrids have bouncing enabled on both axis
8713 * @see elm_gengrid_bounce_get()
8717 EINA_DEPRECATED EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8720 * Get whether bouncing effects are enabled or disabled, for a
8721 * given gengrid widget, on each axis
8723 * @param obj The gengrid object
8724 * @param h_bounce Pointer to a variable where to store the
8725 * horizontal bouncing flag.
8726 * @param v_bounce Pointer to a variable where to store the
8727 * vertical bouncing flag.
8729 * @see elm_gengrid_bounce_set() for more details
8733 EINA_DEPRECATED EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8736 * Set a given gengrid widget's scrolling page size, relative to
8737 * its viewport size.
8739 * @param obj The gengrid object
8740 * @param h_pagerel The horizontal page (relative) size
8741 * @param v_pagerel The vertical page (relative) size
8743 * The gengrid's scroller is capable of binding scrolling by the
8744 * user to "pages". It means that, while scrolling and, specially
8745 * after releasing the mouse button, the grid will @b snap to the
8746 * nearest displaying page's area. When page sizes are set, the
8747 * grid's continuous content area is split into (equal) page sized
8750 * This function sets the size of a page <b>relatively to the
8751 * viewport dimensions</b> of the gengrid, for each axis. A value
8752 * @c 1.0 means "the exact viewport's size", in that axis, while @c
8753 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8754 * a viewport". Sane usable values are, than, between @c 0.0 and @c
8755 * 1.0. Values beyond those will make it behave behave
8756 * inconsistently. If you only want one axis to snap to pages, use
8757 * the value @c 0.0 for the other one.
8759 * There is a function setting page size values in @b absolute
8760 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8761 * is mutually exclusive to this one.
8763 * @see elm_gengrid_page_relative_get()
8767 EINA_DEPRECATED EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8770 * Get a given gengrid widget's scrolling page size, relative to
8771 * its viewport size.
8773 * @param obj The gengrid object
8774 * @param h_pagerel Pointer to a variable where to store the
8775 * horizontal page (relative) size
8776 * @param v_pagerel Pointer to a variable where to store the
8777 * vertical page (relative) size
8779 * @see elm_gengrid_page_relative_set() for more details
8783 EINA_DEPRECATED EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8786 * Set a given gengrid widget's scrolling page size
8788 * @param obj The gengrid object
8789 * @param h_pagerel The horizontal page size, in pixels
8790 * @param v_pagerel The vertical page size, in pixels
8792 * The gengrid's scroller is capable of binding scrolling by the
8793 * user to "pages". It means that, while scrolling and, specially
8794 * after releasing the mouse button, the grid will @b snap to the
8795 * nearest displaying page's area. When page sizes are set, the
8796 * grid's continuous content area is split into (equal) page sized
8799 * This function sets the size of a page of the gengrid, in pixels,
8800 * for each axis. Sane usable values are, between @c 0 and the
8801 * dimensions of @p obj, for each axis. Values beyond those will
8802 * make it behave behave inconsistently. If you only want one axis
8803 * to snap to pages, use the value @c 0 for the other one.
8805 * There is a function setting page size values in @b relative
8806 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8807 * use is mutually exclusive to this one.
8811 EINA_DEPRECATED EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8814 * @brief Get gengrid current page number.
8816 * @param obj The gengrid object
8817 * @param h_pagenumber The horizontal page number
8818 * @param v_pagenumber The vertical page number
8820 * The page number starts from 0. 0 is the first page.
8821 * Current page means the page which meet the top-left of the viewport.
8822 * If there are two or more pages in the viewport, it returns the number of page
8823 * which meet the top-left of the viewport.
8825 * @see elm_gengrid_last_page_get()
8826 * @see elm_gengrid_page_show()
8827 * @see elm_gengrid_page_brint_in()
8829 EINA_DEPRECATED EAPI void elm_gengrid_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8832 * @brief Get scroll last page number.
8834 * @param obj The gengrid object
8835 * @param h_pagenumber The horizontal page number
8836 * @param v_pagenumber The vertical page number
8838 * The page number starts from 0. 0 is the first page.
8839 * This returns the last page number among the pages.
8841 * @see elm_gengrid_current_page_get()
8842 * @see elm_gengrid_page_show()
8843 * @see elm_gengrid_page_brint_in()
8845 EINA_DEPRECATED EAPI void elm_gengrid_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8848 * Show a specific virtual region within the gengrid content object by page number.
8850 * @param obj The gengrid object
8851 * @param h_pagenumber The horizontal page number
8852 * @param v_pagenumber The vertical page number
8854 * 0, 0 of the indicated page is located at the top-left of the viewport.
8855 * This will jump to the page directly without animation.
8860 * sc = elm_gengrid_add(win);
8861 * elm_gengrid_content_set(sc, content);
8862 * elm_gengrid_page_relative_set(sc, 1, 0);
8863 * elm_gengrid_current_page_get(sc, &h_page, &v_page);
8864 * elm_gengrid_page_show(sc, h_page + 1, v_page);
8867 * @see elm_gengrid_page_bring_in()
8869 EINA_DEPRECATED EAPI void elm_gengrid_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8872 * Show a specific virtual region within the gengrid content object by page number.
8874 * @param obj The gengrid object
8875 * @param h_pagenumber The horizontal page number
8876 * @param v_pagenumber The vertical page number
8878 * 0, 0 of the indicated page is located at the top-left of the viewport.
8879 * This will slide to the page with animation.
8884 * sc = elm_gengrid_add(win);
8885 * elm_gengrid_content_set(sc, content);
8886 * elm_gengrid_page_relative_set(sc, 1, 0);
8887 * elm_gengrid_last_page_get(sc, &h_page, &v_page);
8888 * elm_gengrid_page_bring_in(sc, h_page, v_page);
8891 * @see elm_gengrid_page_show()
8893 EINA_DEPRECATED EAPI void elm_gengrid_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8896 * Set the direction in which a given gengrid widget will expand while
8897 * placing its items.
8899 * @param obj The gengrid object.
8900 * @param setting @c EINA_TRUE to make the gengrid expand
8901 * horizontally, @c EINA_FALSE to expand vertically.
8903 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8904 * in @b columns, from top to bottom and, when the space for a
8905 * column is filled, another one is started on the right, thus
8906 * expanding the grid horizontally. When in "vertical mode"
8907 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8908 * to right and, when the space for a row is filled, another one is
8909 * started below, thus expanding the grid vertically.
8911 * @see elm_gengrid_horizontal_get()
8915 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8918 * Get for what direction a given gengrid widget will expand while
8919 * placing its items.
8921 * @param obj The gengrid object.
8922 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8923 * @c EINA_FALSE if it's set to expand vertically.
8925 * @see elm_gengrid_horizontal_set() for more detais
8929 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8932 * Get the first item in a given gengrid widget
8934 * @param obj The gengrid object
8935 * @return The first item's handle or @c NULL, if there are no
8936 * items in @p obj (and on errors)
8938 * This returns the first item in the @p obj's internal list of
8941 * @see elm_gengrid_last_item_get()
8945 EINA_DEPRECATED EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8948 * Get the last item in a given gengrid widget
8950 * @param obj The gengrid object
8951 * @return The last item's handle or @c NULL, if there are no
8952 * items in @p obj (and on errors)
8954 * This returns the last item in the @p obj's internal list of
8957 * @see elm_gengrid_first_item_get()
8961 EINA_DEPRECATED EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8964 * Get the @b next item in a gengrid widget's internal list of items,
8965 * given a handle to one of those items.
8967 * @param item The gengrid item to fetch next from
8968 * @return The item after @p item, or @c NULL if there's none (and
8971 * This returns the item placed after the @p item, on the container
8974 * @see elm_gengrid_item_prev_get()
8978 EINA_DEPRECATED EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8981 * Get the @b previous item in a gengrid widget's internal list of items,
8982 * given a handle to one of those items.
8984 * @param item The gengrid item to fetch previous from
8985 * @return The item before @p item, or @c NULL if there's none (and
8988 * This returns the item placed before the @p item, on the container
8991 * @see elm_gengrid_item_next_get()
8995 EINA_DEPRECATED EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8998 * Get the gengrid object's handle which contains a given gengrid
9001 * @param item The item to fetch the container from
9002 * @return The gengrid (parent) object
9004 * This returns the gengrid object itself that an item belongs to.
9008 EINA_DEPRECATED EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9011 * Remove a gengrid item from its parent, deleting it.
9013 * @param item The item to be removed.
9014 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
9016 * @see elm_gengrid_clear(), to remove all items in a gengrid at
9021 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9024 * Update the contents of a given gengrid item
9026 * @param item The gengrid item
9028 * This updates an item by calling all the item class functions
9029 * again to get the contents, labels and states. Use this when the
9030 * original item data has changed and you want the changes to be
9035 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9038 * Get the Gengrid Item class for the given Gengrid Item.
9040 * @param item The gengrid item
9042 * This returns the Gengrid_Item_Class for the given item. It can be used to examine
9043 * the function pointers and item_style.
9047 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9050 * Get the Gengrid Item class for the given Gengrid Item.
9052 * This sets the Gengrid_Item_Class for the given item. It can be used to examine
9053 * the function pointers and item_style.
9055 * @param item The gengrid item
9056 * @param gic The gengrid item class describing the function pointers and the item style.
9060 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
9063 * Return the data associated to a given gengrid item
9065 * @param item The gengrid item.
9066 * @return the data associated with this item.
9068 * This returns the @c data value passed on the
9069 * elm_gengrid_item_append() and related item addition calls.
9071 * @see elm_gengrid_item_append()
9072 * @see elm_gengrid_item_data_set()
9076 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9079 * Set the data associated with a given gengrid item
9081 * @param item The gengrid item
9082 * @param data The data pointer to set on it
9084 * This @b overrides the @c data value passed on the
9085 * elm_gengrid_item_append() and related item addition calls. This
9086 * function @b won't call elm_gengrid_item_update() automatically,
9087 * so you'd issue it afterwards if you want to have the item
9088 * updated to reflect the new data.
9090 * @see elm_gengrid_item_data_get()
9091 * @see elm_gengrid_item_update()
9095 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
9098 * Get a given gengrid item's position, relative to the whole
9099 * gengrid's grid area.
9101 * @param item The Gengrid item.
9102 * @param x Pointer to variable to store the item's <b>row number</b>.
9103 * @param y Pointer to variable to store the item's <b>column number</b>.
9105 * This returns the "logical" position of the item within the
9106 * gengrid. For example, @c (0, 1) would stand for first row,
9111 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
9114 * Set whether a given gengrid item is selected or not
9116 * @param item The gengrid item
9117 * @param selected Use @c EINA_TRUE, to make it selected, @c
9118 * EINA_FALSE to make it unselected
9120 * This sets the selected state of an item. If multi-selection is
9121 * not enabled on the containing gengrid and @p selected is @c
9122 * EINA_TRUE, any other previously selected items will get
9123 * unselected in favor of this new one.
9125 * @see elm_gengrid_item_selected_get()
9129 EINA_DEPRECATED EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
9132 * Get whether a given gengrid item is selected or not
9134 * @param item The gengrid item
9135 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
9137 * This API returns EINA_TRUE for all the items selected in multi-select mode as well.
9139 * @see elm_gengrid_item_selected_set() for more details
9143 EINA_DEPRECATED EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9146 * Get the real Evas object created to implement the view of a
9147 * given gengrid item
9149 * @param item The gengrid item.
9150 * @return the Evas object implementing this item's view.
9152 * This returns the actual Evas object used to implement the
9153 * specified gengrid item's view. This may be @c NULL, as it may
9154 * not have been created or may have been deleted, at any time, by
9155 * the gengrid. <b>Do not modify this object</b> (move, resize,
9156 * show, hide, etc.), as the gengrid is controlling it. This
9157 * function is for querying, emitting custom signals or hooking
9158 * lower level callbacks for events on that object. Do not delete
9159 * this object under any circumstances.
9161 * @see elm_gengrid_item_data_get()
9165 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9168 * Show the portion of a gengrid's internal grid containing a given
9169 * item, @b immediately.
9171 * @param item The item to display
9173 * This causes gengrid to @b redraw its viewport's contents to the
9174 * region contining the given @p item item, if it is not fully
9177 * @see elm_gengrid_item_bring_in()
9181 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9184 * Animatedly bring in, to the visible area of a gengrid, a given
9187 * @param item The gengrid item to display
9189 * This causes gengrid to jump to the given @p item and show
9190 * it (by scrolling), if it is not fully visible. This will use
9191 * animation to do so and take a period of time to complete.
9193 * @see elm_gengrid_item_show()
9197 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9200 * Set whether a given gengrid item is disabled or not.
9202 * @param item The gengrid item
9203 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
9204 * to enable it back.
9206 * A disabled item cannot be selected or unselected. It will also
9207 * change its appearance, to signal the user it's disabled.
9209 * @see elm_gengrid_item_disabled_get()
9213 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
9216 * Get whether a given gengrid item is disabled or not.
9218 * @param item The gengrid item
9219 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
9222 * @see elm_gengrid_item_disabled_set() for more details
9226 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9229 * Set the text to be shown in a given gengrid item's tooltips.
9231 * @param item The gengrid item
9232 * @param text The text to set in the content
9234 * This call will setup the text to be used as tooltip to that item
9235 * (analogous to elm_object_tooltip_text_set(), but being item
9236 * tooltips with higher precedence than object tooltips). It can
9237 * have only one tooltip at a time, so any previous tooltip data
9242 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
9245 * Set the content to be shown in a given gengrid item's tooltip
9247 * @param item The gengrid item.
9248 * @param func The function returning the tooltip contents.
9249 * @param data What to provide to @a func as callback data/context.
9250 * @param del_cb Called when data is not needed anymore, either when
9251 * another callback replaces @p func, the tooltip is unset with
9252 * elm_gengrid_item_tooltip_unset() or the owner @p item
9253 * dies. This callback receives as its first parameter the
9254 * given @p data, being @c event_info the item handle.
9256 * This call will setup the tooltip's contents to @p item
9257 * (analogous to elm_object_tooltip_content_cb_set(), but being
9258 * item tooltips with higher precedence than object tooltips). It
9259 * can have only one tooltip at a time, so any previous tooltip
9260 * content will get removed. @p func (with @p data) will be called
9261 * every time Elementary needs to show the tooltip and it should
9262 * return a valid Evas object, which will be fully managed by the
9263 * tooltip system, getting deleted when the tooltip is gone.
9267 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);
9270 * Unset a tooltip from a given gengrid item
9272 * @param item gengrid item to remove a previously set tooltip from.
9274 * This call removes any tooltip set on @p item. The callback
9275 * provided as @c del_cb to
9276 * elm_gengrid_item_tooltip_content_cb_set() will be called to
9277 * notify it is not used anymore (and have resources cleaned, if
9280 * @see elm_gengrid_item_tooltip_content_cb_set()
9284 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9287 * Set a different @b style for a given gengrid item's tooltip.
9289 * @param item gengrid item with tooltip set
9290 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
9291 * "default", @c "transparent", etc)
9293 * Tooltips can have <b>alternate styles</b> to be displayed on,
9294 * which are defined by the theme set on Elementary. This function
9295 * works analogously as elm_object_tooltip_style_set(), but here
9296 * applied only to gengrid item objects. The default style for
9297 * tooltips is @c "default".
9299 * @note before you set a style you should define a tooltip with
9300 * elm_gengrid_item_tooltip_content_cb_set() or
9301 * elm_gengrid_item_tooltip_text_set()
9303 * @see elm_gengrid_item_tooltip_style_get()
9307 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9310 * Get the style set a given gengrid item's tooltip.
9312 * @param item gengrid item with tooltip already set on.
9313 * @return style the theme style in use, which defaults to
9314 * "default". If the object does not have a tooltip set,
9315 * then @c NULL is returned.
9317 * @see elm_gengrid_item_tooltip_style_set() for more details
9321 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9323 * @brief Disable size restrictions on an object's tooltip
9324 * @param item The tooltip's anchor object
9325 * @param disable If EINA_TRUE, size restrictions are disabled
9326 * @return EINA_FALSE on failure, EINA_TRUE on success
9328 * This function allows a tooltip to expand beyond its parant window's canvas.
9329 * It will instead be limited only by the size of the display.
9331 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
9333 * @brief Retrieve size restriction state of an object's tooltip
9334 * @param item The tooltip's anchor object
9335 * @return If EINA_TRUE, size restrictions are disabled
9337 * This function returns whether a tooltip is allowed to expand beyond
9338 * its parant window's canvas.
9339 * It will instead be limited only by the size of the display.
9341 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
9343 * Set the type of mouse pointer/cursor decoration to be shown,
9344 * when the mouse pointer is over the given gengrid widget item
9346 * @param item gengrid item to customize cursor on
9347 * @param cursor the cursor type's name
9349 * This function works analogously as elm_object_cursor_set(), but
9350 * here the cursor's changing area is restricted to the item's
9351 * area, and not the whole widget's. Note that that item cursors
9352 * have precedence over widget cursors, so that a mouse over @p
9353 * item will always show cursor @p type.
9355 * If this function is called twice for an object, a previously set
9356 * cursor will be unset on the second call.
9358 * @see elm_object_cursor_set()
9359 * @see elm_gengrid_item_cursor_get()
9360 * @see elm_gengrid_item_cursor_unset()
9364 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
9367 * Get the type of mouse pointer/cursor decoration set to be shown,
9368 * when the mouse pointer is over the given gengrid widget item
9370 * @param item gengrid item with custom cursor set
9371 * @return the cursor type's name or @c NULL, if no custom cursors
9372 * were set to @p item (and on errors)
9374 * @see elm_object_cursor_get()
9375 * @see elm_gengrid_item_cursor_set() for more details
9376 * @see elm_gengrid_item_cursor_unset()
9380 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9383 * Unset any custom mouse pointer/cursor decoration set to be
9384 * shown, when the mouse pointer is over the given gengrid widget
9385 * item, thus making it show the @b default cursor again.
9387 * @param item a gengrid item
9389 * Use this call to undo any custom settings on this item's cursor
9390 * decoration, bringing it back to defaults (no custom style set).
9392 * @see elm_object_cursor_unset()
9393 * @see elm_gengrid_item_cursor_set() for more details
9397 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9400 * Set a different @b style for a given custom cursor set for a
9403 * @param item gengrid item with custom cursor set
9404 * @param style the <b>theme style</b> to use (e.g. @c "default",
9405 * @c "transparent", etc)
9407 * This function only makes sense when one is using custom mouse
9408 * cursor decorations <b>defined in a theme file</b> , which can
9409 * have, given a cursor name/type, <b>alternate styles</b> on
9410 * it. It works analogously as elm_object_cursor_style_set(), but
9411 * here applied only to gengrid item objects.
9413 * @warning Before you set a cursor style you should have defined a
9414 * custom cursor previously on the item, with
9415 * elm_gengrid_item_cursor_set()
9417 * @see elm_gengrid_item_cursor_engine_only_set()
9418 * @see elm_gengrid_item_cursor_style_get()
9422 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9425 * Get the current @b style set for a given gengrid item's custom
9428 * @param item gengrid item with custom cursor set.
9429 * @return style the cursor style in use. If the object does not
9430 * have a cursor set, then @c NULL is returned.
9432 * @see elm_gengrid_item_cursor_style_set() for more details
9436 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9439 * Set if the (custom) cursor for a given gengrid item should be
9440 * searched in its theme, also, or should only rely on the
9443 * @param item item with custom (custom) cursor already set on
9444 * @param engine_only Use @c EINA_TRUE to have cursors looked for
9445 * only on those provided by the rendering engine, @c EINA_FALSE to
9446 * have them searched on the widget's theme, as well.
9448 * @note This call is of use only if you've set a custom cursor
9449 * for gengrid items, with elm_gengrid_item_cursor_set().
9451 * @note By default, cursors will only be looked for between those
9452 * provided by the rendering engine.
9456 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9459 * Get if the (custom) cursor for a given gengrid item is being
9460 * searched in its theme, also, or is only relying on the rendering
9463 * @param item a gengrid item
9464 * @return @c EINA_TRUE, if cursors are being looked for only on
9465 * those provided by the rendering engine, @c EINA_FALSE if they
9466 * are being searched on the widget's theme, as well.
9468 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
9472 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9475 * Remove all items from a given gengrid widget
9477 * @param obj The gengrid object.
9479 * This removes (and deletes) all items in @p obj, leaving it
9482 * @see elm_gengrid_item_del(), to remove just one item.
9486 EINA_DEPRECATED EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9489 * Get the selected item in a given gengrid widget
9491 * @param obj The gengrid object.
9492 * @return The selected item's handleor @c NULL, if none is
9493 * selected at the moment (and on errors)
9495 * This returns the selected item in @p obj. If multi selection is
9496 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
9497 * the first item in the list is selected, which might not be very
9498 * useful. For that case, see elm_gengrid_selected_items_get().
9502 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9505 * Get <b>a list</b> of selected items in a given gengrid
9507 * @param obj The gengrid object.
9508 * @return The list of selected items or @c NULL, if none is
9509 * selected at the moment (and on errors)
9511 * This returns a list of the selected items, in the order that
9512 * they appear in the grid. This list is only valid as long as no
9513 * more items are selected or unselected (or unselected implictly
9514 * by deletion). The list contains #Elm_Gengrid_Item pointers as
9517 * @see elm_gengrid_selected_item_get()
9521 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9528 * @defgroup Clock Clock
9530 * @image html img/widget/clock/preview-00.png
9531 * @image latex img/widget/clock/preview-00.eps
9533 * This is a @b digital clock widget. In its default theme, it has a
9534 * vintage "flipping numbers clock" appearance, which will animate
9535 * sheets of individual algarisms individually as time goes by.
9537 * A newly created clock will fetch system's time (already
9538 * considering local time adjustments) to start with, and will tick
9539 * accondingly. It may or may not show seconds.
9541 * Clocks have an @b edition mode. When in it, the sheets will
9542 * display extra arrow indications on the top and bottom and the
9543 * user may click on them to raise or lower the time values. After
9544 * it's told to exit edition mode, it will keep ticking with that
9545 * new time set (it keeps the difference from local time).
9547 * Also, when under edition mode, user clicks on the cited arrows
9548 * which are @b held for some time will make the clock to flip the
9549 * sheet, thus editing the time, continuosly and automatically for
9550 * the user. The interval between sheet flips will keep growing in
9551 * time, so that it helps the user to reach a time which is distant
9554 * The time display is, by default, in military mode (24h), but an
9555 * am/pm indicator may be optionally shown, too, when it will
9558 * Smart callbacks one can register to:
9559 * - "changed" - the clock's user changed the time
9561 * Here is an example on its usage:
9562 * @li @ref clock_example
9571 * Identifiers for which clock digits should be editable, when a
9572 * clock widget is in edition mode. Values may be ORed together to
9573 * make a mask, naturally.
9575 * @see elm_clock_edit_set()
9576 * @see elm_clock_digit_edit_set()
9578 typedef enum _Elm_Clock_Digedit
9580 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9581 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9582 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
9583 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9584 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
9585 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9586 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
9587 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
9588 } Elm_Clock_Digedit;
9591 * Add a new clock widget to the given parent Elementary
9592 * (container) object
9594 * @param parent The parent object
9595 * @return a new clock widget handle or @c NULL, on errors
9597 * This function inserts a new clock widget on the canvas.
9601 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9604 * Set a clock widget's time, programmatically
9606 * @param obj The clock widget object
9607 * @param hrs The hours to set
9608 * @param min The minutes to set
9609 * @param sec The secondes to set
9611 * This function updates the time that is showed by the clock
9614 * Values @b must be set within the following ranges:
9615 * - 0 - 23, for hours
9616 * - 0 - 59, for minutes
9617 * - 0 - 59, for seconds,
9619 * even if the clock is not in "military" mode.
9621 * @warning The behavior for values set out of those ranges is @b
9626 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9629 * Get a clock widget's time values
9631 * @param obj The clock object
9632 * @param[out] hrs Pointer to the variable to get the hours value
9633 * @param[out] min Pointer to the variable to get the minutes value
9634 * @param[out] sec Pointer to the variable to get the seconds value
9636 * This function gets the time set for @p obj, returning
9637 * it on the variables passed as the arguments to function
9639 * @note Use @c NULL pointers on the time values you're not
9640 * interested in: they'll be ignored by the function.
9644 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9647 * Set whether a given clock widget is under <b>edition mode</b> or
9648 * under (default) displaying-only mode.
9650 * @param obj The clock object
9651 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9652 * put it back to "displaying only" mode
9654 * This function makes a clock's time to be editable or not <b>by
9655 * user interaction</b>. When in edition mode, clocks @b stop
9656 * ticking, until one brings them back to canonical mode. The
9657 * elm_clock_digit_edit_set() function will influence which digits
9658 * of the clock will be editable. By default, all of them will be
9659 * (#ELM_CLOCK_NONE).
9661 * @note am/pm sheets, if being shown, will @b always be editable
9662 * under edition mode.
9664 * @see elm_clock_edit_get()
9668 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9671 * Retrieve whether a given clock widget is under <b>edition
9672 * mode</b> or under (default) displaying-only mode.
9674 * @param obj The clock object
9675 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9678 * This function retrieves whether the clock's time can be edited
9679 * or not by user interaction.
9681 * @see elm_clock_edit_set() for more details
9685 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9688 * Set what digits of the given clock widget should be editable
9689 * when in edition mode.
9691 * @param obj The clock object
9692 * @param digedit Bit mask indicating the digits to be editable
9693 * (values in #Elm_Clock_Digedit).
9695 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9696 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9699 * @see elm_clock_digit_edit_get()
9703 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9706 * Retrieve what digits of the given clock widget should be
9707 * editable when in edition mode.
9709 * @param obj The clock object
9710 * @return Bit mask indicating the digits to be editable
9711 * (values in #Elm_Clock_Digedit).
9713 * @see elm_clock_digit_edit_set() for more details
9717 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9720 * Set if the given clock widget must show hours in military or
9723 * @param obj The clock object
9724 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9727 * This function sets if the clock must show hours in military or
9728 * am/pm mode. In some countries like Brazil the military mode
9729 * (00-24h-format) is used, in opposition to the USA, where the
9730 * am/pm mode is more commonly used.
9732 * @see elm_clock_show_am_pm_get()
9736 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9739 * Get if the given clock widget shows hours in military or am/pm
9742 * @param obj The clock object
9743 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9746 * This function gets if the clock shows hours in military or am/pm
9749 * @see elm_clock_show_am_pm_set() for more details
9753 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9756 * Set if the given clock widget must show time with seconds or not
9758 * @param obj The clock object
9759 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9761 * This function sets if the given clock must show or not elapsed
9762 * seconds. By default, they are @b not shown.
9764 * @see elm_clock_show_seconds_get()
9768 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9771 * Get whether the given clock widget is showing time with seconds
9774 * @param obj The clock object
9775 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9777 * This function gets whether @p obj is showing or not the elapsed
9780 * @see elm_clock_show_seconds_set()
9784 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9787 * Set the interval on time updates for an user mouse button hold
9788 * on clock widgets' time edition.
9790 * @param obj The clock object
9791 * @param interval The (first) interval value in seconds
9793 * This interval value is @b decreased while the user holds the
9794 * mouse pointer either incrementing or decrementing a given the
9795 * clock digit's value.
9797 * This helps the user to get to a given time distant from the
9798 * current one easier/faster, as it will start to flip quicker and
9799 * quicker on mouse button holds.
9801 * The calculation for the next flip interval value, starting from
9802 * the one set with this call, is the previous interval divided by
9803 * 1.05, so it decreases a little bit.
9805 * The default starting interval value for automatic flips is
9808 * @see elm_clock_interval_get()
9812 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9815 * Get the interval on time updates for an user mouse button hold
9816 * on clock widgets' time edition.
9818 * @param obj The clock object
9819 * @return The (first) interval value, in seconds, set on it
9821 * @see elm_clock_interval_set() for more details
9825 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9832 * @defgroup Layout Layout
9834 * @image html img/widget/layout/preview-00.png
9835 * @image latex img/widget/layout/preview-00.eps width=\textwidth
9837 * @image html img/layout-predefined.png
9838 * @image latex img/layout-predefined.eps width=\textwidth
9840 * This is a container widget that takes a standard Edje design file and
9841 * wraps it very thinly in a widget.
9843 * An Edje design (theme) file has a very wide range of possibilities to
9844 * describe the behavior of elements added to the Layout. Check out the Edje
9845 * documentation and the EDC reference to get more information about what can
9846 * be done with Edje.
9848 * Just like @ref List, @ref Box, and other container widgets, any
9849 * object added to the Layout will become its child, meaning that it will be
9850 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9852 * The Layout widget can contain as many Contents, Boxes or Tables as
9853 * described in its theme file. For instance, objects can be added to
9854 * different Tables by specifying the respective Table part names. The same
9855 * is valid for Content and Box.
9857 * The objects added as child of the Layout will behave as described in the
9858 * part description where they were added. There are 3 possible types of
9859 * parts where a child can be added:
9861 * @section secContent Content (SWALLOW part)
9863 * Only one object can be added to the @c SWALLOW part (but you still can
9864 * have many @c SWALLOW parts and one object on each of them). Use the @c
9865 * elm_object_content_set/get/unset functions to set, retrieve and unset
9866 * objects as content of the @c SWALLOW. After being set to this part, the
9867 * object size, position, visibility, clipping and other description
9868 * properties will be totally controled by the description of the given part
9869 * (inside the Edje theme file).
9871 * One can use @c evas_object_size_hint_* functions on the child to have some
9872 * kind of control over its behavior, but the resulting behavior will still
9873 * depend heavily on the @c SWALLOW part description.
9875 * The Edje theme also can change the part description, based on signals or
9876 * scripts running inside the theme. This change can also be animated. All of
9877 * this will affect the child object set as content accordingly. The object
9878 * size will be changed if the part size is changed, it will animate move if
9879 * the part is moving, and so on.
9881 * The following picture demonstrates a Layout widget with a child object
9882 * added to its @c SWALLOW:
9884 * @image html layout_swallow.png
9885 * @image latex layout_swallow.eps width=\textwidth
9887 * @section secBox Box (BOX part)
9889 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9890 * allows one to add objects to the box and have them distributed along its
9891 * area, accordingly to the specified @a layout property (now by @a layout we
9892 * mean the chosen layouting design of the Box, not the Layout widget
9895 * A similar effect for having a box with its position, size and other things
9896 * controled by the Layout theme would be to create an Elementary @ref Box
9897 * widget and add it as a Content in the @c SWALLOW part.
9899 * The main difference of using the Layout Box is that its behavior, the box
9900 * properties like layouting format, padding, align, etc. will be all
9901 * controled by the theme. This means, for example, that a signal could be
9902 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9903 * handled the signal by changing the box padding, or align, or both. Using
9904 * the Elementary @ref Box widget is not necessarily harder or easier, it
9905 * just depends on the circunstances and requirements.
9907 * The Layout Box can be used through the @c elm_layout_box_* set of
9910 * The following picture demonstrates a Layout widget with many child objects
9911 * added to its @c BOX part:
9913 * @image html layout_box.png
9914 * @image latex layout_box.eps width=\textwidth
9916 * @section secTable Table (TABLE part)
9918 * Just like the @ref secBox, the Layout Table is very similar to the
9919 * Elementary @ref Table widget. It allows one to add objects to the Table
9920 * specifying the row and column where the object should be added, and any
9921 * column or row span if necessary.
9923 * Again, we could have this design by adding a @ref Table widget to the @c
9924 * SWALLOW part using elm_object_part_content_set(). The same difference happens
9925 * here when choosing to use the Layout Table (a @c TABLE part) instead of
9926 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9928 * The Layout Table can be used through the @c elm_layout_table_* set of
9931 * The following picture demonstrates a Layout widget with many child objects
9932 * added to its @c TABLE part:
9934 * @image html layout_table.png
9935 * @image latex layout_table.eps width=\textwidth
9937 * @section secPredef Predefined Layouts
9939 * Another interesting thing about the Layout widget is that it offers some
9940 * predefined themes that come with the default Elementary theme. These
9941 * themes can be set by the call elm_layout_theme_set(), and provide some
9942 * basic functionality depending on the theme used.
9944 * Most of them already send some signals, some already provide a toolbar or
9945 * back and next buttons.
9947 * These are available predefined theme layouts. All of them have class = @c
9948 * layout, group = @c application, and style = one of the following options:
9950 * @li @c toolbar-content - application with toolbar and main content area
9951 * @li @c toolbar-content-back - application with toolbar and main content
9952 * area with a back button and title area
9953 * @li @c toolbar-content-back-next - application with toolbar and main
9954 * content area with a back and next buttons and title area
9955 * @li @c content-back - application with a main content area with a back
9956 * button and title area
9957 * @li @c content-back-next - application with a main content area with a
9958 * back and next buttons and title area
9959 * @li @c toolbar-vbox - application with toolbar and main content area as a
9961 * @li @c toolbar-table - application with toolbar and main content area as a
9964 * @section secExamples Examples
9966 * Some examples of the Layout widget can be found here:
9967 * @li @ref layout_example_01
9968 * @li @ref layout_example_02
9969 * @li @ref layout_example_03
9970 * @li @ref layout_example_edc
9975 * Add a new layout to the parent
9977 * @param parent The parent object
9978 * @return The new object or NULL if it cannot be created
9980 * @see elm_layout_file_set()
9981 * @see elm_layout_theme_set()
9985 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9987 * Set the file that will be used as layout
9989 * @param obj The layout object
9990 * @param file The path to file (edj) that will be used as layout
9991 * @param group The group that the layout belongs in edje file
9993 * @return (1 = success, 0 = error)
9997 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9999 * Set the edje group from the elementary theme that will be used as layout
10001 * @param obj The layout object
10002 * @param clas the clas of the group
10003 * @param group the group
10004 * @param style the style to used
10006 * @return (1 = success, 0 = error)
10010 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
10012 * Set the layout content.
10014 * @param obj The layout object
10015 * @param swallow The swallow part name in the edje file
10016 * @param content The child that will be added in this layout object
10018 * Once the content object is set, a previously set one will be deleted.
10019 * If you want to keep that old content object, use the
10020 * elm_object_part_content_unset() function.
10022 * @note In an Edje theme, the part used as a content container is called @c
10023 * SWALLOW. This is why the parameter name is called @p swallow, but it is
10024 * expected to be a part name just like the second parameter of
10025 * elm_layout_box_append().
10027 * @see elm_layout_box_append()
10028 * @see elm_object_part_content_get()
10029 * @see elm_object_part_content_unset()
10031 * @deprecated use elm_object_part_content_set() instead
10035 EINA_DEPRECATED EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10037 * Get the child object in the given content part.
10039 * @param obj The layout object
10040 * @param swallow The SWALLOW part to get its content
10042 * @return The swallowed object or NULL if none or an error occurred
10044 * @deprecated use elm_object_part_content_get() instead
10048 EINA_DEPRECATED EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10050 * Unset the layout content.
10052 * @param obj The layout object
10053 * @param swallow The swallow part name in the edje file
10054 * @return The content that was being used
10056 * Unparent and return the content object which was set for this part.
10058 * @deprecated use elm_object_part_content_unset() instead
10062 EINA_DEPRECATED EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10064 * Set the text of the given part
10066 * @param obj The layout object
10067 * @param part The TEXT part where to set the text
10068 * @param text The text to set
10071 * @deprecated use elm_object_part_text_set() instead.
10073 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
10075 * Get the text set in the given part
10077 * @param obj The layout object
10078 * @param part The TEXT part to retrieve the text off
10080 * @return The text set in @p part
10083 * @deprecated use elm_object_part_text_get() instead.
10085 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
10087 * Append child to layout box part.
10089 * @param obj the layout object
10090 * @param part the box part to which the object will be appended.
10091 * @param child the child object to append to box.
10093 * Once the object is appended, it will become child of the layout. Its
10094 * lifetime will be bound to the layout, whenever the layout dies the child
10095 * will be deleted automatically. One should use elm_layout_box_remove() to
10096 * make this layout forget about the object.
10098 * @see elm_layout_box_prepend()
10099 * @see elm_layout_box_insert_before()
10100 * @see elm_layout_box_insert_at()
10101 * @see elm_layout_box_remove()
10105 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10107 * Prepend child to layout box part.
10109 * @param obj the layout object
10110 * @param part the box part to prepend.
10111 * @param child the child object to prepend to box.
10113 * Once the object is prepended, it will become child of the layout. Its
10114 * lifetime will be bound to the layout, whenever the layout dies the child
10115 * will be deleted automatically. One should use elm_layout_box_remove() to
10116 * make this layout forget about the object.
10118 * @see elm_layout_box_append()
10119 * @see elm_layout_box_insert_before()
10120 * @see elm_layout_box_insert_at()
10121 * @see elm_layout_box_remove()
10125 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10127 * Insert child to layout box part before a reference object.
10129 * @param obj the layout object
10130 * @param part the box part to insert.
10131 * @param child the child object to insert into box.
10132 * @param reference another reference object to insert before in box.
10134 * Once the object is inserted, it will become child of the layout. Its
10135 * lifetime will be bound to the layout, whenever the layout dies the child
10136 * will be deleted automatically. One should use elm_layout_box_remove() to
10137 * make this layout forget about the object.
10139 * @see elm_layout_box_append()
10140 * @see elm_layout_box_prepend()
10141 * @see elm_layout_box_insert_before()
10142 * @see elm_layout_box_remove()
10146 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
10148 * Insert child to layout box part at a given position.
10150 * @param obj the layout object
10151 * @param part the box part to insert.
10152 * @param child the child object to insert into box.
10153 * @param pos the numeric position >=0 to insert the child.
10155 * Once the object is inserted, it will become child of the layout. Its
10156 * lifetime will be bound to the layout, whenever the layout dies the child
10157 * will be deleted automatically. One should use elm_layout_box_remove() to
10158 * make this layout forget about the object.
10160 * @see elm_layout_box_append()
10161 * @see elm_layout_box_prepend()
10162 * @see elm_layout_box_insert_before()
10163 * @see elm_layout_box_remove()
10167 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
10169 * Remove a child of the given part box.
10171 * @param obj The layout object
10172 * @param part The box part name to remove child.
10173 * @param child The object to remove from box.
10174 * @return The object that was being used, or NULL if not found.
10176 * The object will be removed from the box part and its lifetime will
10177 * not be handled by the layout anymore. This is equivalent to
10178 * elm_object_part_content_unset() for box.
10180 * @see elm_layout_box_append()
10181 * @see elm_layout_box_remove_all()
10185 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
10187 * Remove all child of the given part box.
10189 * @param obj The layout object
10190 * @param part The box part name to remove child.
10191 * @param clear If EINA_TRUE, then all objects will be deleted as
10192 * well, otherwise they will just be removed and will be
10193 * dangling on the canvas.
10195 * The objects will be removed from the box part and their lifetime will
10196 * not be handled by the layout anymore. This is equivalent to
10197 * elm_layout_box_remove() for all box children.
10199 * @see elm_layout_box_append()
10200 * @see elm_layout_box_remove()
10204 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10206 * Insert child to layout table part.
10208 * @param obj the layout object
10209 * @param part the box part to pack child.
10210 * @param child_obj the child object to pack into table.
10211 * @param col the column to which the child should be added. (>= 0)
10212 * @param row the row to which the child should be added. (>= 0)
10213 * @param colspan how many columns should be used to store this object. (>=
10215 * @param rowspan how many rows should be used to store this object. (>= 1)
10217 * Once the object is inserted, it will become child of the table. Its
10218 * lifetime will be bound to the layout, and whenever the layout dies the
10219 * child will be deleted automatically. One should use
10220 * elm_layout_table_remove() to make this layout forget about the object.
10222 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
10223 * more space than a single cell. For instance, the following code:
10225 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
10228 * Would result in an object being added like the following picture:
10230 * @image html layout_colspan.png
10231 * @image latex layout_colspan.eps width=\textwidth
10233 * @see elm_layout_table_unpack()
10234 * @see elm_layout_table_clear()
10238 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);
10240 * Unpack (remove) a child of the given part table.
10242 * @param obj The layout object
10243 * @param part The table part name to remove child.
10244 * @param child_obj The object to remove from table.
10245 * @return The object that was being used, or NULL if not found.
10247 * The object will be unpacked from the table part and its lifetime
10248 * will not be handled by the layout anymore. This is equivalent to
10249 * elm_object_part_content_unset() for table.
10251 * @see elm_layout_table_pack()
10252 * @see elm_layout_table_clear()
10256 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
10258 * Remove all child of the given part table.
10260 * @param obj The layout object
10261 * @param part The table part name to remove child.
10262 * @param clear If EINA_TRUE, then all objects will be deleted as
10263 * well, otherwise they will just be removed and will be
10264 * dangling on the canvas.
10266 * The objects will be removed from the table part and their lifetime will
10267 * not be handled by the layout anymore. This is equivalent to
10268 * elm_layout_table_unpack() for all table children.
10270 * @see elm_layout_table_pack()
10271 * @see elm_layout_table_unpack()
10275 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10277 * Get the edje layout
10279 * @param obj The layout object
10281 * @return A Evas_Object with the edje layout settings loaded
10282 * with function elm_layout_file_set
10284 * This returns the edje object. It is not expected to be used to then
10285 * swallow objects via edje_object_part_swallow() for example. Use
10286 * elm_object_part_content_set() instead so child object handling and sizing is
10289 * @note This function should only be used if you really need to call some
10290 * low level Edje function on this edje object. All the common stuff (setting
10291 * text, emitting signals, hooking callbacks to signals, etc.) can be done
10292 * with proper elementary functions.
10294 * @see elm_object_signal_callback_add()
10295 * @see elm_object_signal_emit()
10296 * @see elm_object_part_text_set()
10297 * @see elm_object_part_content_set()
10298 * @see elm_layout_box_append()
10299 * @see elm_layout_table_pack()
10300 * @see elm_layout_data_get()
10304 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10306 * Get the edje data from the given layout
10308 * @param obj The layout object
10309 * @param key The data key
10311 * @return The edje data string
10313 * This function fetches data specified inside the edje theme of this layout.
10314 * This function return NULL if data is not found.
10316 * In EDC this comes from a data block within the group block that @p
10317 * obj was loaded from. E.g.
10324 * item: "key1" "value1";
10325 * item: "key2" "value2";
10333 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
10337 * @param obj The layout object
10339 * Manually forces a sizing re-evaluation. This is useful when the minimum
10340 * size required by the edje theme of this layout has changed. The change on
10341 * the minimum size required by the edje theme is not immediately reported to
10342 * the elementary layout, so one needs to call this function in order to tell
10343 * the widget (layout) that it needs to reevaluate its own size.
10345 * The minimum size of the theme is calculated based on minimum size of
10346 * parts, the size of elements inside containers like box and table, etc. All
10347 * of this can change due to state changes, and that's when this function
10348 * should be called.
10350 * Also note that a standard signal of "size,eval" "elm" emitted from the
10351 * edje object will cause this to happen too.
10355 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
10358 * Sets a specific cursor for an edje part.
10360 * @param obj The layout object.
10361 * @param part_name a part from loaded edje group.
10362 * @param cursor cursor name to use, see Elementary_Cursor.h
10364 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10365 * part not exists or it has "mouse_events: 0".
10369 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
10372 * Get the cursor to be shown when mouse is over an edje part
10374 * @param obj The layout object.
10375 * @param part_name a part from loaded edje group.
10376 * @return the cursor name.
10380 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10383 * Unsets a cursor previously set with elm_layout_part_cursor_set().
10385 * @param obj The layout object.
10386 * @param part_name a part from loaded edje group, that had a cursor set
10387 * with elm_layout_part_cursor_set().
10391 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10394 * Sets a specific cursor style for an edje part.
10396 * @param obj The layout object.
10397 * @param part_name a part from loaded edje group.
10398 * @param style the theme style to use (default, transparent, ...)
10400 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10401 * part not exists or it did not had a cursor set.
10405 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
10408 * Gets a specific cursor style for an edje part.
10410 * @param obj The layout object.
10411 * @param part_name a part from loaded edje group.
10413 * @return the theme style in use, defaults to "default". If the
10414 * object does not have a cursor set, then NULL is returned.
10418 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10421 * Sets if the cursor set should be searched on the theme or should use
10422 * the provided by the engine, only.
10424 * @note before you set if should look on theme you should define a
10425 * cursor with elm_layout_part_cursor_set(). By default it will only
10426 * look for cursors provided by the engine.
10428 * @param obj The layout object.
10429 * @param part_name a part from loaded edje group.
10430 * @param engine_only if cursors should be just provided by the engine
10431 * or should also search on widget's theme as well
10433 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10434 * part not exists or it did not had a cursor set.
10438 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);
10441 * Gets a specific cursor engine_only for an edje part.
10443 * @param obj The layout object.
10444 * @param part_name a part from loaded edje group.
10446 * @return whenever the cursor is just provided by engine or also from theme.
10450 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10453 * @def elm_layout_icon_set
10454 * Convienience macro to set the icon object in a layout that follows the
10455 * Elementary naming convention for its parts.
10459 #define elm_layout_icon_set(_ly, _obj) \
10462 elm_object_part_content_set((_ly), "elm.swallow.icon", (_obj)); \
10463 if ((_obj)) sig = "elm,state,icon,visible"; \
10464 else sig = "elm,state,icon,hidden"; \
10465 elm_object_signal_emit((_ly), sig, "elm"); \
10469 * @def elm_layout_icon_get
10470 * Convienience macro to get the icon object from a layout that follows the
10471 * Elementary naming convention for its parts.
10475 #define elm_layout_icon_get(_ly) \
10476 elm_object_part_content_get((_ly), "elm.swallow.icon")
10479 * @def elm_layout_end_set
10480 * Convienience macro to set the end object in a layout that follows the
10481 * Elementary naming convention for its parts.
10485 #define elm_layout_end_set(_ly, _obj) \
10488 elm_object_part_content_set((_ly), "elm.swallow.end", (_obj)); \
10489 if ((_obj)) sig = "elm,state,end,visible"; \
10490 else sig = "elm,state,end,hidden"; \
10491 elm_object_signal_emit((_ly), sig, "elm"); \
10495 * @def elm_layout_end_get
10496 * Convienience macro to get the end object in a layout that follows the
10497 * Elementary naming convention for its parts.
10501 #define elm_layout_end_get(_ly) \
10502 elm_object_part_content_get((_ly), "elm.swallow.end")
10505 * @def elm_layout_label_set
10506 * Convienience macro to set the label in a layout that follows the
10507 * Elementary naming convention for its parts.
10510 * @deprecated use elm_object_text_set() instead.
10512 #define elm_layout_label_set(_ly, _txt) \
10513 elm_layout_text_set((_ly), "elm.text", (_txt))
10516 * @def elm_layout_label_get
10517 * Convenience macro to get the label in a layout that follows the
10518 * Elementary naming convention for its parts.
10521 * @deprecated use elm_object_text_set() instead.
10523 #define elm_layout_label_get(_ly) \
10524 elm_layout_text_get((_ly), "elm.text")
10526 /* smart callbacks called:
10527 * "theme,changed" - when elm theme is changed.
10531 * @defgroup Notify Notify
10533 * @image html img/widget/notify/preview-00.png
10534 * @image latex img/widget/notify/preview-00.eps
10536 * Display a container in a particular region of the parent(top, bottom,
10537 * etc). A timeout can be set to automatically hide the notify. This is so
10538 * that, after an evas_object_show() on a notify object, if a timeout was set
10539 * on it, it will @b automatically get hidden after that time.
10541 * Signals that you can add callbacks for are:
10542 * @li "timeout" - when timeout happens on notify and it's hidden
10543 * @li "block,clicked" - when a click outside of the notify happens
10545 * Default contents parts of the notify widget that you can use for are:
10546 * @li "default" - A content of the notify
10548 * @ref tutorial_notify show usage of the API.
10553 * @brief Possible orient values for notify.
10555 * This values should be used in conjunction to elm_notify_orient_set() to
10556 * set the position in which the notify should appear(relative to its parent)
10557 * and in conjunction with elm_notify_orient_get() to know where the notify
10560 typedef enum _Elm_Notify_Orient
10562 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
10563 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
10564 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
10565 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
10566 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
10567 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
10568 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
10569 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
10570 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10571 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10572 } Elm_Notify_Orient;
10574 * @brief Add a new notify to the parent
10576 * @param parent The parent object
10577 * @return The new object or NULL if it cannot be created
10579 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10581 * @brief Set the content of the notify widget
10583 * @param obj The notify object
10584 * @param content The content will be filled in this notify object
10586 * Once the content object is set, a previously set one will be deleted. If
10587 * you want to keep that old content object, use the
10588 * elm_notify_content_unset() function.
10590 * @deprecated use elm_object_content_set() instead
10593 EINA_DEPRECATED EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10595 * @brief Unset the content of the notify widget
10597 * @param obj The notify object
10598 * @return The content that was being used
10600 * Unparent and return the content object which was set for this widget
10602 * @see elm_notify_content_set()
10603 * @deprecated use elm_object_content_unset() instead
10606 EINA_DEPRECATED EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10608 * @brief Return the content of the notify widget
10610 * @param obj The notify object
10611 * @return The content that is being used
10613 * @see elm_notify_content_set()
10614 * @deprecated use elm_object_content_get() instead
10617 EINA_DEPRECATED EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10619 * @brief Set the notify parent
10621 * @param obj The notify object
10622 * @param content The new parent
10624 * Once the parent object is set, a previously set one will be disconnected
10627 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10629 * @brief Get the notify parent
10631 * @param obj The notify object
10632 * @return The parent
10634 * @see elm_notify_parent_set()
10636 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10638 * @brief Set the orientation
10640 * @param obj The notify object
10641 * @param orient The new orientation
10643 * Sets the position in which the notify will appear in its parent.
10645 * @see @ref Elm_Notify_Orient for possible values.
10647 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10649 * @brief Return the orientation
10650 * @param obj The notify object
10651 * @return The orientation of the notification
10653 * @see elm_notify_orient_set()
10654 * @see Elm_Notify_Orient
10656 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10658 * @brief Set the time interval after which the notify window is going to be
10661 * @param obj The notify object
10662 * @param time The timeout in seconds
10664 * This function sets a timeout and starts the timer controlling when the
10665 * notify is hidden. Since calling evas_object_show() on a notify restarts
10666 * the timer controlling when the notify is hidden, setting this before the
10667 * notify is shown will in effect mean starting the timer when the notify is
10670 * @note Set a value <= 0.0 to disable a running timer.
10672 * @note If the value > 0.0 and the notify is previously visible, the
10673 * timer will be started with this value, canceling any running timer.
10675 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10677 * @brief Return the timeout value (in seconds)
10678 * @param obj the notify object
10680 * @see elm_notify_timeout_set()
10682 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10684 * @brief Sets whether events should be passed to by a click outside
10687 * @param obj The notify object
10688 * @param repeats EINA_TRUE Events are repeats, else no
10690 * When true if the user clicks outside the window the events will be caught
10691 * by the others widgets, else the events are blocked.
10693 * @note The default value is EINA_TRUE.
10695 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10697 * @brief Return true if events are repeat below the notify object
10698 * @param obj the notify object
10700 * @see elm_notify_repeat_events_set()
10702 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10708 * @defgroup Hover Hover
10710 * @image html img/widget/hover/preview-00.png
10711 * @image latex img/widget/hover/preview-00.eps
10713 * A Hover object will hover over its @p parent object at the @p target
10714 * location. Anything in the background will be given a darker coloring to
10715 * indicate that the hover object is on top (at the default theme). When the
10716 * hover is clicked it is dismissed(hidden), if the contents of the hover are
10717 * clicked that @b doesn't cause the hover to be dismissed.
10719 * A Hover object has two parents. One parent that owns it during creation
10720 * and the other parent being the one over which the hover object spans.
10723 * @note The hover object will take up the entire space of @p target
10726 * Elementary has the following styles for the hover widget:
10730 * @li hoversel_vertical
10732 * The following are the available position for content:
10744 * Signals that you can add callbacks for are:
10745 * @li "clicked" - the user clicked the empty space in the hover to dismiss
10746 * @li "smart,changed" - a content object placed under the "smart"
10747 * policy was replaced to a new slot direction.
10749 * See @ref tutorial_hover for more information.
10753 typedef enum _Elm_Hover_Axis
10755 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10756 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10757 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10758 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10761 * @brief Adds a hover object to @p parent
10763 * @param parent The parent object
10764 * @return The hover object or NULL if one could not be created
10766 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10768 * @brief Sets the target object for the hover.
10770 * @param obj The hover object
10771 * @param target The object to center the hover onto. The hover
10773 * This function will cause the hover to be centered on the target object.
10775 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10777 * @brief Gets the target object for the hover.
10779 * @param obj The hover object
10780 * @param parent The object to locate the hover over.
10782 * @see elm_hover_target_set()
10784 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10786 * @brief Sets the parent object for the hover.
10788 * @param obj The hover object
10789 * @param parent The object to locate the hover over.
10791 * This function will cause the hover to take up the entire space that the
10792 * parent object fills.
10794 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10796 * @brief Gets the parent object for the hover.
10798 * @param obj The hover object
10799 * @return The parent object to locate the hover over.
10801 * @see elm_hover_parent_set()
10803 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10805 * @brief Sets the content of the hover object and the direction in which it
10808 * @param obj The hover object
10809 * @param swallow The direction that the object will be displayed
10810 * at. Accepted values are "left", "top-left", "top", "top-right",
10811 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10813 * @param content The content to place at @p swallow
10815 * Once the content object is set for a given direction, a previously
10816 * set one (on the same direction) will be deleted. If you want to
10817 * keep that old content object, use the elm_hover_content_unset()
10820 * All directions may have contents at the same time, except for
10821 * "smart". This is a special placement hint and its use case
10822 * independs of the calculations coming from
10823 * elm_hover_best_content_location_get(). Its use is for cases when
10824 * one desires only one hover content, but with a dinamic special
10825 * placement within the hover area. The content's geometry, whenever
10826 * it changes, will be used to decide on a best location not
10827 * extrapolating the hover's parent object view to show it in (still
10828 * being the hover's target determinant of its medium part -- move and
10829 * resize it to simulate finger sizes, for example). If one of the
10830 * directions other than "smart" are used, a previously content set
10831 * using it will be deleted, and vice-versa.
10833 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10835 * @brief Get the content of the hover object, in a given direction.
10837 * Return the content object which was set for this widget in the
10838 * @p swallow direction.
10840 * @param obj The hover object
10841 * @param swallow The direction that the object was display at.
10842 * @return The content that was being used
10844 * @see elm_hover_content_set()
10846 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10848 * @brief Unset the content of the hover object, in a given direction.
10850 * Unparent and return the content object set at @p swallow direction.
10852 * @param obj The hover object
10853 * @param swallow The direction that the object was display at.
10854 * @return The content that was being used.
10856 * @see elm_hover_content_set()
10858 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10860 * @brief Returns the best swallow location for content in the hover.
10862 * @param obj The hover object
10863 * @param pref_axis The preferred orientation axis for the hover object to use
10864 * @return The edje location to place content into the hover or @c
10867 * Best is defined here as the location at which there is the most available
10870 * @p pref_axis may be one of
10871 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10872 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10873 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10874 * - @c ELM_HOVER_AXIS_BOTH -- both
10876 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10877 * nescessarily be along the horizontal axis("left" or "right"). If
10878 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10879 * be along the vertical axis("top" or "bottom"). Chossing
10880 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10881 * returned position may be in either axis.
10883 * @see elm_hover_content_set()
10885 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10892 * @defgroup Entry Entry
10894 * @image html img/widget/entry/preview-00.png
10895 * @image latex img/widget/entry/preview-00.eps width=\textwidth
10896 * @image html img/widget/entry/preview-01.png
10897 * @image latex img/widget/entry/preview-01.eps width=\textwidth
10898 * @image html img/widget/entry/preview-02.png
10899 * @image latex img/widget/entry/preview-02.eps width=\textwidth
10900 * @image html img/widget/entry/preview-03.png
10901 * @image latex img/widget/entry/preview-03.eps width=\textwidth
10903 * An entry is a convenience widget which shows a box that the user can
10904 * enter text into. Entries by default don't scroll, so they grow to
10905 * accomodate the entire text, resizing the parent window as needed. This
10906 * can be changed with the elm_entry_scrollable_set() function.
10908 * They can also be single line or multi line (the default) and when set
10909 * to multi line mode they support text wrapping in any of the modes
10910 * indicated by #Elm_Wrap_Type.
10912 * Other features include password mode, filtering of inserted text with
10913 * elm_entry_text_filter_append() and related functions, inline "items" and
10914 * formatted markup text.
10916 * @section entry-markup Formatted text
10918 * The markup tags supported by the Entry are defined by the theme, but
10919 * even when writing new themes or extensions it's a good idea to stick to
10920 * a sane default, to maintain coherency and avoid application breakages.
10921 * Currently defined by the default theme are the following tags:
10922 * @li \<br\>: Inserts a line break.
10923 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10925 * @li \<tab\>: Inserts a tab.
10926 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10928 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10929 * @li \<link\>...\</link\>: Underlines the enclosed text.
10930 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10932 * @section entry-special Special markups
10934 * Besides those used to format text, entries support two special markup
10935 * tags used to insert clickable portions of text or items inlined within
10938 * @subsection entry-anchors Anchors
10940 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10941 * \</a\> tags and an event will be generated when this text is clicked,
10945 * This text is outside <a href=anc-01>but this one is an anchor</a>
10948 * The @c href attribute in the opening tag gives the name that will be
10949 * used to identify the anchor and it can be any valid utf8 string.
10951 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10952 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10953 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10954 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10957 * @subsection entry-items Items
10959 * Inlined in the text, any other @c Evas_Object can be inserted by using
10960 * \<item\> tags this way:
10963 * <item size=16x16 vsize=full href=emoticon/haha></item>
10966 * Just like with anchors, the @c href identifies each item, but these need,
10967 * in addition, to indicate their size, which is done using any one of
10968 * @c size, @c absize or @c relsize attributes. These attributes take their
10969 * value in the WxH format, where W is the width and H the height of the
10972 * @li absize: Absolute pixel size for the item. Whatever value is set will
10973 * be the item's size regardless of any scale value the object may have
10974 * been set to. The final line height will be adjusted to fit larger items.
10975 * @li size: Similar to @c absize, but it's adjusted to the scale value set
10977 * @li relsize: Size is adjusted for the item to fit within the current
10980 * Besides their size, items are specificed a @c vsize value that affects
10981 * how their final size and position are calculated. The possible values
10983 * @li ascent: Item will be placed within the line's baseline and its
10984 * ascent. That is, the height between the line where all characters are
10985 * positioned and the highest point in the line. For @c size and @c absize
10986 * items, the descent value will be added to the total line height to make
10987 * them fit. @c relsize items will be adjusted to fit within this space.
10988 * @li full: Items will be placed between the descent and ascent, or the
10989 * lowest point in the line and its highest.
10991 * The next image shows different configurations of items and how they
10992 * are the previously mentioned options affect their sizes. In all cases,
10993 * the green line indicates the ascent, blue for the baseline and red for
10996 * @image html entry_item.png
10997 * @image latex entry_item.eps width=\textwidth
10999 * And another one to show how size differs from absize. In the first one,
11000 * the scale value is set to 1.0, while the second one is using one of 2.0.
11002 * @image html entry_item_scale.png
11003 * @image latex entry_item_scale.eps width=\textwidth
11005 * After the size for an item is calculated, the entry will request an
11006 * object to place in its space. For this, the functions set with
11007 * elm_entry_item_provider_append() and related functions will be called
11008 * in order until one of them returns a @c non-NULL value. If no providers
11009 * are available, or all of them return @c NULL, then the entry falls back
11010 * to one of the internal defaults, provided the name matches with one of
11013 * All of the following are currently supported:
11016 * - emoticon/angry-shout
11017 * - emoticon/crazy-laugh
11018 * - emoticon/evil-laugh
11020 * - emoticon/goggle-smile
11021 * - emoticon/grumpy
11022 * - emoticon/grumpy-smile
11023 * - emoticon/guilty
11024 * - emoticon/guilty-smile
11026 * - emoticon/half-smile
11027 * - emoticon/happy-panting
11029 * - emoticon/indifferent
11031 * - emoticon/knowing-grin
11033 * - emoticon/little-bit-sorry
11034 * - emoticon/love-lots
11036 * - emoticon/minimal-smile
11037 * - emoticon/not-happy
11038 * - emoticon/not-impressed
11040 * - emoticon/opensmile
11043 * - emoticon/squint-laugh
11044 * - emoticon/surprised
11045 * - emoticon/suspicious
11046 * - emoticon/tongue-dangling
11047 * - emoticon/tongue-poke
11049 * - emoticon/unhappy
11050 * - emoticon/very-sorry
11053 * - emoticon/worried
11056 * Alternatively, an item may reference an image by its path, using
11057 * the URI form @c file:///path/to/an/image.png and the entry will then
11058 * use that image for the item.
11060 * @section entry-files Loading and saving files
11062 * Entries have convinience functions to load text from a file and save
11063 * changes back to it after a short delay. The automatic saving is enabled
11064 * by default, but can be disabled with elm_entry_autosave_set() and files
11065 * can be loaded directly as plain text or have any markup in them
11066 * recognized. See elm_entry_file_set() for more details.
11068 * @section entry-signals Emitted signals
11070 * This widget emits the following signals:
11072 * @li "changed": The text within the entry was changed.
11073 * @li "changed,user": The text within the entry was changed because of user interaction.
11074 * @li "activated": The enter key was pressed on a single line entry.
11075 * @li "press": A mouse button has been pressed on the entry.
11076 * @li "longpressed": A mouse button has been pressed and held for a couple
11078 * @li "clicked": The entry has been clicked (mouse press and release).
11079 * @li "clicked,double": The entry has been double clicked.
11080 * @li "clicked,triple": The entry has been triple clicked.
11081 * @li "focused": The entry has received focus.
11082 * @li "unfocused": The entry has lost focus.
11083 * @li "selection,paste": A paste of the clipboard contents was requested.
11084 * @li "selection,copy": A copy of the selected text into the clipboard was
11086 * @li "selection,cut": A cut of the selected text into the clipboard was
11088 * @li "selection,start": A selection has begun and no previous selection
11090 * @li "selection,changed": The current selection has changed.
11091 * @li "selection,cleared": The current selection has been cleared.
11092 * @li "cursor,changed": The cursor has changed position.
11093 * @li "anchor,clicked": An anchor has been clicked. The event_info
11094 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11095 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
11096 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11097 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
11098 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11099 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
11100 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11101 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
11102 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11103 * @li "preedit,changed": The preedit string has changed.
11104 * @li "language,changed": Program language changed.
11106 * @section entry-examples
11108 * An overview of the Entry API can be seen in @ref entry_example_01
11113 * @typedef Elm_Entry_Anchor_Info
11115 * The info sent in the callback for the "anchor,clicked" signals emitted
11118 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
11120 * @struct _Elm_Entry_Anchor_Info
11122 * The info sent in the callback for the "anchor,clicked" signals emitted
11125 struct _Elm_Entry_Anchor_Info
11127 const char *name; /**< The name of the anchor, as stated in its href */
11128 int button; /**< The mouse button used to click on it */
11129 Evas_Coord x, /**< Anchor geometry, relative to canvas */
11130 y, /**< Anchor geometry, relative to canvas */
11131 w, /**< Anchor geometry, relative to canvas */
11132 h; /**< Anchor geometry, relative to canvas */
11135 * @typedef Elm_Entry_Filter_Cb
11136 * This callback type is used by entry filters to modify text.
11137 * @param data The data specified as the last param when adding the filter
11138 * @param entry The entry object
11139 * @param text A pointer to the location of the text being filtered. This data can be modified,
11140 * but any additional allocations must be managed by the user.
11141 * @see elm_entry_text_filter_append
11142 * @see elm_entry_text_filter_prepend
11144 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
11147 * @typedef Elm_Entry_Change_Info
11148 * This corresponds to Edje_Entry_Change_Info. Includes information about
11149 * a change in the entry.
11151 typedef Edje_Entry_Change_Info Elm_Entry_Change_Info;
11155 * This adds an entry to @p parent object.
11157 * By default, entries are:
11161 * @li autosave is enabled
11163 * @param parent The parent object
11164 * @return The new object or NULL if it cannot be created
11166 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11168 * Sets the entry to single line mode.
11170 * In single line mode, entries don't ever wrap when the text reaches the
11171 * edge, and instead they keep growing horizontally. Pressing the @c Enter
11172 * key will generate an @c "activate" event instead of adding a new line.
11174 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
11175 * and pressing enter will break the text into a different line
11176 * without generating any events.
11178 * @param obj The entry object
11179 * @param single_line If true, the text in the entry
11180 * will be on a single line.
11182 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
11184 * Gets whether the entry is set to be single line.
11186 * @param obj The entry object
11187 * @return single_line If true, the text in the entry is set to display
11188 * on a single line.
11190 * @see elm_entry_single_line_set()
11192 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11194 * Sets the entry to password mode.
11196 * In password mode, entries are implicitly single line and the display of
11197 * any text in them is replaced with asterisks (*).
11199 * @param obj The entry object
11200 * @param password If true, password mode is enabled.
11202 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
11204 * Gets whether the entry is set to password mode.
11206 * @param obj The entry object
11207 * @return If true, the entry is set to display all characters
11208 * as asterisks (*).
11210 * @see elm_entry_password_set()
11212 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11214 * This sets the text displayed within the entry to @p entry.
11216 * @param obj The entry object
11217 * @param entry The text to be displayed
11219 * @deprecated Use elm_object_text_set() instead.
11220 * @note Using this function bypasses text filters
11222 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11224 * This returns the text currently shown in object @p entry.
11225 * See also elm_entry_entry_set().
11227 * @param obj The entry object
11228 * @return The currently displayed text or NULL on failure
11230 * @deprecated Use elm_object_text_get() instead.
11232 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11234 * Appends @p entry to the text of the entry.
11236 * Adds the text in @p entry to the end of any text already present in the
11239 * The appended text is subject to any filters set for the widget.
11241 * @param obj The entry object
11242 * @param entry The text to be displayed
11244 * @see elm_entry_text_filter_append()
11246 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11248 * Gets whether the entry is empty.
11250 * Empty means no text at all. If there are any markup tags, like an item
11251 * tag for which no provider finds anything, and no text is displayed, this
11252 * function still returns EINA_FALSE.
11254 * @param obj The entry object
11255 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
11257 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11259 * Gets any selected text within the entry.
11261 * If there's any selected text in the entry, this function returns it as
11262 * a string in markup format. NULL is returned if no selection exists or
11263 * if an error occurred.
11265 * The returned value points to an internal string and should not be freed
11266 * or modified in any way. If the @p entry object is deleted or its
11267 * contents are changed, the returned pointer should be considered invalid.
11269 * @param obj The entry object
11270 * @return The selected text within the entry or NULL on failure
11272 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11274 * Returns the actual textblock object of the entry.
11276 * This function exposes the internal textblock object that actually
11277 * contains and draws the text. This should be used for low-level
11278 * manipulations that are otherwise not possible.
11280 * Changing the textblock directly from here will not notify edje/elm to
11281 * recalculate the textblock size automatically, so any modifications
11282 * done to the textblock returned by this function should be followed by
11283 * a call to elm_entry_calc_force().
11285 * The return value is marked as const as an additional warning.
11286 * One should not use the returned object with any of the generic evas
11287 * functions (geometry_get/resize/move and etc), but only with the textblock
11288 * functions; The former will either not work at all, or break the correct
11291 * IMPORTANT: Many functions may change (i.e delete and create a new one)
11292 * the internal textblock object. Do NOT cache the returned object, and try
11293 * not to mix calls on this object with regular elm_entry calls (which may
11294 * change the internal textblock object). This applies to all cursors
11295 * returned from textblock calls, and all the other derivative values.
11297 * @param obj The entry object
11298 * @return The textblock object.
11300 EAPI const Evas_Object *elm_entry_textblock_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11302 * Forces calculation of the entry size and text layouting.
11304 * This should be used after modifying the textblock object directly. See
11305 * elm_entry_textblock_get() for more information.
11307 * @param obj The entry object
11309 * @see elm_entry_textblock_get()
11311 EAPI void elm_entry_calc_force(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11313 * Inserts the given text into the entry at the current cursor position.
11315 * This inserts text at the cursor position as if it was typed
11316 * by the user (note that this also allows markup which a user
11317 * can't just "type" as it would be converted to escaped text, so this
11318 * call can be used to insert things like emoticon items or bold push/pop
11319 * tags, other font and color change tags etc.)
11321 * If any selection exists, it will be replaced by the inserted text.
11323 * The inserted text is subject to any filters set for the widget.
11325 * @param obj The entry object
11326 * @param entry The text to insert
11328 * @see elm_entry_text_filter_append()
11330 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11332 * Set the line wrap type to use on multi-line entries.
11334 * Sets the wrap type used by the entry to any of the specified in
11335 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
11336 * line (without inserting a line break or paragraph separator) when it
11337 * reaches the far edge of the widget.
11339 * Note that this only makes sense for multi-line entries. A widget set
11340 * to be single line will never wrap.
11342 * @param obj The entry object
11343 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
11345 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
11347 * Gets the wrap mode the entry was set to use.
11349 * @param obj The entry object
11350 * @return Wrap type
11352 * @see also elm_entry_line_wrap_set()
11354 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11356 * Sets if the entry is to be editable or not.
11358 * By default, entries are editable and when focused, any text input by the
11359 * user will be inserted at the current cursor position. But calling this
11360 * function with @p editable as EINA_FALSE will prevent the user from
11361 * inputting text into the entry.
11363 * The only way to change the text of a non-editable entry is to use
11364 * elm_object_text_set(), elm_entry_entry_insert() and other related
11367 * @param obj The entry object
11368 * @param editable If EINA_TRUE, user input will be inserted in the entry,
11369 * if not, the entry is read-only and no user input is allowed.
11371 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
11373 * Gets whether the entry is editable or not.
11375 * @param obj The entry object
11376 * @return If true, the entry is editable by the user.
11377 * If false, it is not editable by the user
11379 * @see elm_entry_editable_set()
11381 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11383 * This drops any existing text selection within the entry.
11385 * @param obj The entry object
11387 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
11389 * This selects all text within the entry.
11391 * @param obj The entry object
11393 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
11395 * This moves the cursor one place to the right within the entry.
11397 * @param obj The entry object
11398 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11400 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
11402 * This moves the cursor one place to the left within the entry.
11404 * @param obj The entry object
11405 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11407 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
11409 * This moves the cursor one line up within the entry.
11411 * @param obj The entry object
11412 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11414 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
11416 * This moves the cursor one line down within the entry.
11418 * @param obj The entry object
11419 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11421 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
11423 * This moves the cursor to the beginning of the entry.
11425 * @param obj The entry object
11427 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11429 * This moves the cursor to the end of the entry.
11431 * @param obj The entry object
11433 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11435 * This moves the cursor to the beginning of the current line.
11437 * @param obj The entry object
11439 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11441 * This moves the cursor to the end of the current line.
11443 * @param obj The entry object
11445 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11447 * This begins a selection within the entry as though
11448 * the user were holding down the mouse button to make a selection.
11450 * @param obj The entry object
11452 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
11454 * This ends a selection within the entry as though
11455 * the user had just released the mouse button while making a selection.
11457 * @param obj The entry object
11459 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11461 * Gets whether a format node exists at the current cursor position.
11463 * A format node is anything that defines how the text is rendered. It can
11464 * be a visible format node, such as a line break or a paragraph separator,
11465 * or an invisible one, such as bold begin or end tag.
11466 * This function returns whether any format node exists at the current
11469 * @param obj The entry object
11470 * @return EINA_TRUE if the current cursor position contains a format node,
11471 * EINA_FALSE otherwise.
11473 * @see elm_entry_cursor_is_visible_format_get()
11475 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11477 * Gets if the current cursor position holds a visible format node.
11479 * @param obj The entry object
11480 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
11481 * if it's an invisible one or no format exists.
11483 * @see elm_entry_cursor_is_format_get()
11485 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11487 * Gets the character pointed by the cursor at its current position.
11489 * This function returns a string with the utf8 character stored at the
11490 * current cursor position.
11491 * Only the text is returned, any format that may exist will not be part
11492 * of the return value.
11494 * @param obj The entry object
11495 * @return The text pointed by the cursors.
11497 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11499 * This function returns the geometry of the cursor.
11501 * It's useful if you want to draw something on the cursor (or where it is),
11502 * or for example in the case of scrolled entry where you want to show the
11505 * @param obj The entry object
11506 * @param x returned geometry
11507 * @param y returned geometry
11508 * @param w returned geometry
11509 * @param h returned geometry
11510 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11512 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);
11514 * Sets the cursor position in the entry to the given value
11516 * The value in @p pos is the index of the character position within the
11517 * contents of the string as returned by elm_entry_cursor_pos_get().
11519 * @param obj The entry object
11520 * @param pos The position of the cursor
11522 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
11524 * Retrieves the current position of the cursor in the entry
11526 * @param obj The entry object
11527 * @return The cursor position
11529 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11531 * This executes a "cut" action on the selected text in the entry.
11533 * @param obj The entry object
11535 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
11537 * This executes a "copy" action on the selected text in the entry.
11539 * @param obj The entry object
11541 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
11543 * This executes a "paste" action in the entry.
11545 * @param obj The entry object
11547 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
11549 * This clears and frees the items in a entry's contextual (longpress)
11552 * @param obj The entry object
11554 * @see elm_entry_context_menu_item_add()
11556 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11558 * This adds an item to the entry's contextual menu.
11560 * A longpress on an entry will make the contextual menu show up, if this
11561 * hasn't been disabled with elm_entry_context_menu_disabled_set().
11562 * By default, this menu provides a few options like enabling selection mode,
11563 * which is useful on embedded devices that need to be explicit about it,
11564 * and when a selection exists it also shows the copy and cut actions.
11566 * With this function, developers can add other options to this menu to
11567 * perform any action they deem necessary.
11569 * @param obj The entry object
11570 * @param label The item's text label
11571 * @param icon_file The item's icon file
11572 * @param icon_type The item's icon type
11573 * @param func The callback to execute when the item is clicked
11574 * @param data The data to associate with the item for related functions
11576 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);
11578 * This disables the entry's contextual (longpress) menu.
11580 * @param obj The entry object
11581 * @param disabled If true, the menu is disabled
11583 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11585 * This returns whether the entry's contextual (longpress) menu is
11588 * @param obj The entry object
11589 * @return If true, the menu is disabled
11591 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11593 * This appends a custom item provider to the list for that entry
11595 * This appends the given callback. The list is walked from beginning to end
11596 * with each function called given the item href string in the text. If the
11597 * function returns an object handle other than NULL (it should create an
11598 * object to do this), then this object is used to replace that item. If
11599 * not the next provider is called until one provides an item object, or the
11600 * default provider in entry does.
11602 * @param obj The entry object
11603 * @param func The function called to provide the item object
11604 * @param data The data passed to @p func
11606 * @see @ref entry-items
11608 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);
11610 * This prepends a custom item provider to the list for that entry
11612 * This prepends the given callback. See elm_entry_item_provider_append() for
11615 * @param obj The entry object
11616 * @param func The function called to provide the item object
11617 * @param data The data passed to @p func
11619 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);
11621 * This removes a custom item provider to the list for that entry
11623 * This removes the given callback. See elm_entry_item_provider_append() for
11626 * @param obj The entry object
11627 * @param func The function called to provide the item object
11628 * @param data The data passed to @p func
11630 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);
11632 * Append a filter function for text inserted in the entry
11634 * Append the given callback to the list. This functions will be called
11635 * whenever any text is inserted into the entry, with the text to be inserted
11636 * as a parameter. The callback function is free to alter the text in any way
11637 * it wants, but it must remember to free the given pointer and update it.
11638 * If the new text is to be discarded, the function can free it and set its
11639 * text parameter to NULL. This will also prevent any following filters from
11642 * @param obj The entry object
11643 * @param func The function to use as text filter
11644 * @param data User data to pass to @p func
11646 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11648 * Prepend a filter function for text insdrted in the entry
11650 * Prepend the given callback to the list. See elm_entry_text_filter_append()
11651 * for more information
11653 * @param obj The entry object
11654 * @param func The function to use as text filter
11655 * @param data User data to pass to @p func
11657 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11659 * Remove a filter from the list
11661 * Removes the given callback from the filter list. See
11662 * elm_entry_text_filter_append() for more information.
11664 * @param obj The entry object
11665 * @param func The filter function to remove
11666 * @param data The user data passed when adding the function
11668 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11670 * This converts a markup (HTML-like) string into UTF-8.
11672 * The returned string is a malloc'ed buffer and it should be freed when
11673 * not needed anymore.
11675 * @param s The string (in markup) to be converted
11676 * @return The converted string (in UTF-8). It should be freed.
11678 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11680 * This converts a UTF-8 string into markup (HTML-like).
11682 * The returned string is a malloc'ed buffer and it should be freed when
11683 * not needed anymore.
11685 * @param s The string (in UTF-8) to be converted
11686 * @return The converted string (in markup). It should be freed.
11688 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11690 * This sets the file (and implicitly loads it) for the text to display and
11691 * then edit. All changes are written back to the file after a short delay if
11692 * the entry object is set to autosave (which is the default).
11694 * If the entry had any other file set previously, any changes made to it
11695 * will be saved if the autosave feature is enabled, otherwise, the file
11696 * will be silently discarded and any non-saved changes will be lost.
11698 * @param obj The entry object
11699 * @param file The path to the file to load and save
11700 * @param format The file format
11702 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11704 * Gets the file being edited by the entry.
11706 * This function can be used to retrieve any file set on the entry for
11707 * edition, along with the format used to load and save it.
11709 * @param obj The entry object
11710 * @param file The path to the file to load and save
11711 * @param format The file format
11713 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11715 * This function writes any changes made to the file set with
11716 * elm_entry_file_set()
11718 * @param obj The entry object
11720 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11722 * This sets the entry object to 'autosave' the loaded text file or not.
11724 * @param obj The entry object
11725 * @param autosave Autosave the loaded file or not
11727 * @see elm_entry_file_set()
11729 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11731 * This gets the entry object's 'autosave' status.
11733 * @param obj The entry object
11734 * @return Autosave the loaded file or not
11736 * @see elm_entry_file_set()
11738 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11740 * Control pasting of text and images for the widget.
11742 * Normally the entry allows both text and images to be pasted. By setting
11743 * textonly to be true, this prevents images from being pasted.
11745 * Note this only changes the behaviour of text.
11747 * @param obj The entry object
11748 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11749 * text+image+other.
11751 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11753 * Getting elm_entry text paste/drop mode.
11755 * In textonly mode, only text may be pasted or dropped into the widget.
11757 * @param obj The entry object
11758 * @return If the widget only accepts text from pastes.
11760 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11762 * Enable or disable scrolling in entry
11764 * Normally the entry is not scrollable unless you enable it with this call.
11766 * @param obj The entry object
11767 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11769 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11771 * Get the scrollable state of the entry
11773 * Normally the entry is not scrollable. This gets the scrollable state
11774 * of the entry. See elm_entry_scrollable_set() for more information.
11776 * @param obj The entry object
11777 * @return The scrollable state
11779 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
11781 * This sets a widget to be displayed to the left of a scrolled entry.
11783 * @param obj The scrolled entry object
11784 * @param icon The widget to display on the left side of the scrolled
11787 * @note A previously set widget will be destroyed.
11788 * @note If the object being set does not have minimum size hints set,
11789 * it won't get properly displayed.
11791 * @see elm_entry_end_set()
11793 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11795 * Gets the leftmost widget of the scrolled entry. This object is
11796 * owned by the scrolled entry and should not be modified.
11798 * @param obj The scrolled entry object
11799 * @return the left widget inside the scroller
11801 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11803 * Unset the leftmost widget of the scrolled entry, unparenting and
11806 * @param obj The scrolled entry object
11807 * @return the previously set icon sub-object of this entry, on
11810 * @see elm_entry_icon_set()
11812 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11814 * Sets the visibility of the left-side widget of the scrolled entry,
11815 * set by elm_entry_icon_set().
11817 * @param obj The scrolled entry object
11818 * @param setting EINA_TRUE if the object should be displayed,
11819 * EINA_FALSE if not.
11821 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11823 * This sets a widget to be displayed to the end of a scrolled entry.
11825 * @param obj The scrolled entry object
11826 * @param end The widget to display on the right side of the scrolled
11829 * @note A previously set widget will be destroyed.
11830 * @note If the object being set does not have minimum size hints set,
11831 * it won't get properly displayed.
11833 * @see elm_entry_icon_set
11835 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11837 * Gets the endmost widget of the scrolled entry. This object is owned
11838 * by the scrolled entry and should not be modified.
11840 * @param obj The scrolled entry object
11841 * @return the right widget inside the scroller
11843 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11845 * Unset the endmost widget of the scrolled entry, unparenting and
11848 * @param obj The scrolled entry object
11849 * @return the previously set icon sub-object of this entry, on
11852 * @see elm_entry_icon_set()
11854 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11856 * Sets the visibility of the end widget of the scrolled entry, set by
11857 * elm_entry_end_set().
11859 * @param obj The scrolled entry object
11860 * @param setting EINA_TRUE if the object should be displayed,
11861 * EINA_FALSE if not.
11863 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11865 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11868 * Setting an entry to single-line mode with elm_entry_single_line_set()
11869 * will automatically disable the display of scrollbars when the entry
11870 * moves inside its scroller.
11872 * @param obj The scrolled entry object
11873 * @param h The horizontal scrollbar policy to apply
11874 * @param v The vertical scrollbar policy to apply
11876 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11878 * This enables/disables bouncing within the entry.
11880 * This function sets whether the entry will bounce when scrolling reaches
11881 * the end of the contained entry.
11883 * @param obj The scrolled entry object
11884 * @param h The horizontal bounce state
11885 * @param v The vertical bounce state
11887 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11889 * Get the bounce mode
11891 * @param obj The Entry object
11892 * @param h_bounce Allow bounce horizontally
11893 * @param v_bounce Allow bounce vertically
11895 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11897 /* pre-made filters for entries */
11899 * @typedef Elm_Entry_Filter_Limit_Size
11901 * Data for the elm_entry_filter_limit_size() entry filter.
11903 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11905 * @struct _Elm_Entry_Filter_Limit_Size
11907 * Data for the elm_entry_filter_limit_size() entry filter.
11909 struct _Elm_Entry_Filter_Limit_Size
11911 int max_char_count; /**< The maximum number of characters allowed. */
11912 int max_byte_count; /**< The maximum number of bytes allowed*/
11915 * Filter inserted text based on user defined character and byte limits
11917 * Add this filter to an entry to limit the characters that it will accept
11918 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11919 * The funtion works on the UTF-8 representation of the string, converting
11920 * it from the set markup, thus not accounting for any format in it.
11922 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11923 * it as data when setting the filter. In it, it's possible to set limits
11924 * by character count or bytes (any of them is disabled if 0), and both can
11925 * be set at the same time. In that case, it first checks for characters,
11928 * The function will cut the inserted text in order to allow only the first
11929 * number of characters that are still allowed. The cut is made in
11930 * characters, even when limiting by bytes, in order to always contain
11931 * valid ones and avoid half unicode characters making it in.
11933 * This filter, like any others, does not apply when setting the entry text
11934 * directly with elm_object_text_set() (or the deprecated
11935 * elm_entry_entry_set()).
11937 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11939 * @typedef Elm_Entry_Filter_Accept_Set
11941 * Data for the elm_entry_filter_accept_set() entry filter.
11943 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11945 * @struct _Elm_Entry_Filter_Accept_Set
11947 * Data for the elm_entry_filter_accept_set() entry filter.
11949 struct _Elm_Entry_Filter_Accept_Set
11951 const char *accepted; /**< Set of characters accepted in the entry. */
11952 const char *rejected; /**< Set of characters rejected from the entry. */
11955 * Filter inserted text based on accepted or rejected sets of characters
11957 * Add this filter to an entry to restrict the set of accepted characters
11958 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11959 * This structure contains both accepted and rejected sets, but they are
11960 * mutually exclusive.
11962 * The @c accepted set takes preference, so if it is set, the filter will
11963 * only work based on the accepted characters, ignoring anything in the
11964 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11966 * In both cases, the function filters by matching utf8 characters to the
11967 * raw markup text, so it can be used to remove formatting tags.
11969 * This filter, like any others, does not apply when setting the entry text
11970 * directly with elm_object_text_set() (or the deprecated
11971 * elm_entry_entry_set()).
11973 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11975 * Set the input panel layout of the entry
11977 * @param obj The entry object
11978 * @param layout layout type
11980 EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
11982 * Get the input panel layout of the entry
11984 * @param obj The entry object
11985 * @return layout type
11987 * @see elm_entry_input_panel_layout_set
11989 EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11991 * Set the autocapitalization type on the immodule.
11993 * @param obj The entry object
11994 * @param autocapital_type The type of autocapitalization
11996 EAPI void elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type) EINA_ARG_NONNULL(1);
11998 * Retrieve the autocapitalization type on the immodule.
12000 * @param obj The entry object
12001 * @return autocapitalization type
12003 EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12005 * Sets the attribute to show the input panel automatically.
12007 * @param obj The entry object
12008 * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
12010 EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
12012 * Retrieve the attribute to show the input panel automatically.
12014 * @param obj The entry object
12015 * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
12017 EAPI Eina_Bool elm_entry_input_panel_enabled_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12023 /* composite widgets - these basically put together basic widgets above
12024 * in convenient packages that do more than basic stuff */
12028 * @defgroup Anchorview Anchorview
12030 * @image html img/widget/anchorview/preview-00.png
12031 * @image latex img/widget/anchorview/preview-00.eps
12033 * Anchorview is for displaying text that contains markup with anchors
12034 * like <c>\<a href=1234\>something\</\></c> in it.
12036 * Besides being styled differently, the anchorview widget provides the
12037 * necessary functionality so that clicking on these anchors brings up a
12038 * popup with user defined content such as "call", "add to contacts" or
12039 * "open web page". This popup is provided using the @ref Hover widget.
12041 * This widget is very similar to @ref Anchorblock, so refer to that
12042 * widget for an example. The only difference Anchorview has is that the
12043 * widget is already provided with scrolling functionality, so if the
12044 * text set to it is too large to fit in the given space, it will scroll,
12045 * whereas the @ref Anchorblock widget will keep growing to ensure all the
12046 * text can be displayed.
12048 * This widget emits the following signals:
12049 * @li "anchor,clicked": will be called when an anchor is clicked. The
12050 * @p event_info parameter on the callback will be a pointer of type
12051 * ::Elm_Entry_Anchorview_Info.
12053 * See @ref Anchorblock for an example on how to use both of them.
12062 * @typedef Elm_Entry_Anchorview_Info
12064 * The info sent in the callback for "anchor,clicked" signals emitted by
12065 * the Anchorview widget.
12067 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
12069 * @struct _Elm_Entry_Anchorview_Info
12071 * The info sent in the callback for "anchor,clicked" signals emitted by
12072 * the Anchorview widget.
12074 struct _Elm_Entry_Anchorview_Info
12076 const char *name; /**< Name of the anchor, as indicated in its href
12078 int button; /**< The mouse button used to click on it */
12079 Evas_Object *hover; /**< The hover object to use for the popup */
12081 Evas_Coord x, y, w, h;
12082 } anchor, /**< Geometry selection of text used as anchor */
12083 hover_parent; /**< Geometry of the object used as parent by the
12085 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
12086 for content on the left side of
12087 the hover. Before calling the
12088 callback, the widget will make the
12089 necessary calculations to check
12090 which sides are fit to be set with
12091 content, based on the position the
12092 hover is activated and its distance
12093 to the edges of its parent object
12095 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
12096 the right side of the hover.
12097 See @ref hover_left */
12098 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
12099 of the hover. See @ref hover_left */
12100 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
12101 below the hover. See @ref
12105 * Add a new Anchorview object
12107 * @param parent The parent object
12108 * @return The new object or NULL if it cannot be created
12110 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12112 * Set the text to show in the anchorview
12114 * Sets the text of the anchorview to @p text. This text can include markup
12115 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
12116 * text that will be specially styled and react to click events, ended with
12117 * either of \</a\> or \</\>. When clicked, the anchor will emit an
12118 * "anchor,clicked" signal that you can attach a callback to with
12119 * evas_object_smart_callback_add(). The name of the anchor given in the
12120 * event info struct will be the one set in the href attribute, in this
12121 * case, anchorname.
12123 * Other markup can be used to style the text in different ways, but it's
12124 * up to the style defined in the theme which tags do what.
12125 * @deprecated use elm_object_text_set() instead.
12127 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12129 * Get the markup text set for the anchorview
12131 * Retrieves the text set on the anchorview, with markup tags included.
12133 * @param obj The anchorview object
12134 * @return The markup text set or @c NULL if nothing was set or an error
12136 * @deprecated use elm_object_text_set() instead.
12138 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12140 * Set the parent of the hover popup
12142 * Sets the parent object to use by the hover created by the anchorview
12143 * when an anchor is clicked. See @ref Hover for more details on this.
12144 * If no parent is set, the same anchorview object will be used.
12146 * @param obj The anchorview object
12147 * @param parent The object to use as parent for the hover
12149 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12151 * Get the parent of the hover popup
12153 * Get the object used as parent for the hover created by the anchorview
12154 * widget. See @ref Hover for more details on this.
12156 * @param obj The anchorview object
12157 * @return The object used as parent for the hover, NULL if none is set.
12159 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12161 * Set the style that the hover should use
12163 * When creating the popup hover, anchorview will request that it's
12164 * themed according to @p style.
12166 * @param obj The anchorview object
12167 * @param style The style to use for the underlying hover
12169 * @see elm_object_style_set()
12171 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12173 * Get the style that the hover should use
12175 * Get the style the hover created by anchorview will use.
12177 * @param obj The anchorview object
12178 * @return The style to use by the hover. NULL means the default is used.
12180 * @see elm_object_style_set()
12182 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12184 * Ends the hover popup in the anchorview
12186 * When an anchor is clicked, the anchorview widget will create a hover
12187 * object to use as a popup with user provided content. This function
12188 * terminates this popup, returning the anchorview to its normal state.
12190 * @param obj The anchorview object
12192 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12194 * Set bouncing behaviour when the scrolled content reaches an edge
12196 * Tell the internal scroller object whether it should bounce or not
12197 * when it reaches the respective edges for each axis.
12199 * @param obj The anchorview object
12200 * @param h_bounce Whether to bounce or not in the horizontal axis
12201 * @param v_bounce Whether to bounce or not in the vertical axis
12203 * @see elm_scroller_bounce_set()
12205 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
12207 * Get the set bouncing behaviour of the internal scroller
12209 * Get whether the internal scroller should bounce when the edge of each
12210 * axis is reached scrolling.
12212 * @param obj The anchorview object
12213 * @param h_bounce Pointer where to store the bounce state of the horizontal
12215 * @param v_bounce Pointer where to store the bounce state of the vertical
12218 * @see elm_scroller_bounce_get()
12220 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
12222 * Appends a custom item provider to the given anchorview
12224 * Appends the given function to the list of items providers. This list is
12225 * called, one function at a time, with the given @p data pointer, the
12226 * anchorview object and, in the @p item parameter, the item name as
12227 * referenced in its href string. Following functions in the list will be
12228 * called in order until one of them returns something different to NULL,
12229 * which should be an Evas_Object which will be used in place of the item
12232 * Items in the markup text take the form \<item relsize=16x16 vsize=full
12233 * href=item/name\>\</item\>
12235 * @param obj The anchorview object
12236 * @param func The function to add to the list of providers
12237 * @param data User data that will be passed to the callback function
12239 * @see elm_entry_item_provider_append()
12241 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);
12243 * Prepend a custom item provider to the given anchorview
12245 * Like elm_anchorview_item_provider_append(), but it adds the function
12246 * @p func to the beginning of the list, instead of the end.
12248 * @param obj The anchorview object
12249 * @param func The function to add to the list of providers
12250 * @param data User data that will be passed to the callback function
12252 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);
12254 * Remove a custom item provider from the list of the given anchorview
12256 * Removes the function and data pairing that matches @p func and @p data.
12257 * That is, unless the same function and same user data are given, the
12258 * function will not be removed from the list. This allows us to add the
12259 * same callback several times, with different @p data pointers and be
12260 * able to remove them later without conflicts.
12262 * @param obj The anchorview object
12263 * @param func The function to remove from the list
12264 * @param data The data matching the function to remove from the list
12266 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);
12273 * @defgroup Anchorblock Anchorblock
12275 * @image html img/widget/anchorblock/preview-00.png
12276 * @image latex img/widget/anchorblock/preview-00.eps
12278 * Anchorblock is for displaying text that contains markup with anchors
12279 * like <c>\<a href=1234\>something\</\></c> in it.
12281 * Besides being styled differently, the anchorblock widget provides the
12282 * necessary functionality so that clicking on these anchors brings up a
12283 * popup with user defined content such as "call", "add to contacts" or
12284 * "open web page". This popup is provided using the @ref Hover widget.
12286 * This widget emits the following signals:
12287 * @li "anchor,clicked": will be called when an anchor is clicked. The
12288 * @p event_info parameter on the callback will be a pointer of type
12289 * ::Elm_Entry_Anchorblock_Info.
12295 * Since examples are usually better than plain words, we might as well
12296 * try @ref tutorial_anchorblock_example "one".
12299 * @addtogroup Anchorblock
12303 * @typedef Elm_Entry_Anchorblock_Info
12305 * The info sent in the callback for "anchor,clicked" signals emitted by
12306 * the Anchorblock widget.
12308 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
12310 * @struct _Elm_Entry_Anchorblock_Info
12312 * The info sent in the callback for "anchor,clicked" signals emitted by
12313 * the Anchorblock widget.
12315 struct _Elm_Entry_Anchorblock_Info
12317 const char *name; /**< Name of the anchor, as indicated in its href
12319 int button; /**< The mouse button used to click on it */
12320 Evas_Object *hover; /**< The hover object to use for the popup */
12322 Evas_Coord x, y, w, h;
12323 } anchor, /**< Geometry selection of text used as anchor */
12324 hover_parent; /**< Geometry of the object used as parent by the
12326 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
12327 for content on the left side of
12328 the hover. Before calling the
12329 callback, the widget will make the
12330 necessary calculations to check
12331 which sides are fit to be set with
12332 content, based on the position the
12333 hover is activated and its distance
12334 to the edges of its parent object
12336 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
12337 the right side of the hover.
12338 See @ref hover_left */
12339 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
12340 of the hover. See @ref hover_left */
12341 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
12342 below the hover. See @ref
12346 * Add a new Anchorblock object
12348 * @param parent The parent object
12349 * @return The new object or NULL if it cannot be created
12351 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12353 * Set the text to show in the anchorblock
12355 * Sets the text of the anchorblock to @p text. This text can include markup
12356 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
12357 * of text that will be specially styled and react to click events, ended
12358 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
12359 * "anchor,clicked" signal that you can attach a callback to with
12360 * evas_object_smart_callback_add(). The name of the anchor given in the
12361 * event info struct will be the one set in the href attribute, in this
12362 * case, anchorname.
12364 * Other markup can be used to style the text in different ways, but it's
12365 * up to the style defined in the theme which tags do what.
12366 * @deprecated use elm_object_text_set() instead.
12368 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12370 * Get the markup text set for the anchorblock
12372 * Retrieves the text set on the anchorblock, with markup tags included.
12374 * @param obj The anchorblock object
12375 * @return The markup text set or @c NULL if nothing was set or an error
12377 * @deprecated use elm_object_text_set() instead.
12379 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12381 * Set the parent of the hover popup
12383 * Sets the parent object to use by the hover created by the anchorblock
12384 * when an anchor is clicked. See @ref Hover for more details on this.
12386 * @param obj The anchorblock object
12387 * @param parent The object to use as parent for the hover
12389 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12391 * Get the parent of the hover popup
12393 * Get the object used as parent for the hover created by the anchorblock
12394 * widget. See @ref Hover for more details on this.
12395 * If no parent is set, the same anchorblock object will be used.
12397 * @param obj The anchorblock object
12398 * @return The object used as parent for the hover, NULL if none is set.
12400 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12402 * Set the style that the hover should use
12404 * When creating the popup hover, anchorblock will request that it's
12405 * themed according to @p style.
12407 * @param obj The anchorblock object
12408 * @param style The style to use for the underlying hover
12410 * @see elm_object_style_set()
12412 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12414 * Get the style that the hover should use
12416 * Get the style, the hover created by anchorblock will use.
12418 * @param obj The anchorblock object
12419 * @return The style to use by the hover. NULL means the default is used.
12421 * @see elm_object_style_set()
12423 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12425 * Ends the hover popup in the anchorblock
12427 * When an anchor is clicked, the anchorblock widget will create a hover
12428 * object to use as a popup with user provided content. This function
12429 * terminates this popup, returning the anchorblock to its normal state.
12431 * @param obj The anchorblock object
12433 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12435 * Appends a custom item provider to the given anchorblock
12437 * Appends the given function to the list of items providers. This list is
12438 * called, one function at a time, with the given @p data pointer, the
12439 * anchorblock object and, in the @p item parameter, the item name as
12440 * referenced in its href string. Following functions in the list will be
12441 * called in order until one of them returns something different to NULL,
12442 * which should be an Evas_Object which will be used in place of the item
12445 * Items in the markup text take the form \<item relsize=16x16 vsize=full
12446 * href=item/name\>\</item\>
12448 * @param obj The anchorblock object
12449 * @param func The function to add to the list of providers
12450 * @param data User data that will be passed to the callback function
12452 * @see elm_entry_item_provider_append()
12454 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);
12456 * Prepend a custom item provider to the given anchorblock
12458 * Like elm_anchorblock_item_provider_append(), but it adds the function
12459 * @p func to the beginning of the list, instead of the end.
12461 * @param obj The anchorblock object
12462 * @param func The function to add to the list of providers
12463 * @param data User data that will be passed to the callback function
12465 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);
12467 * Remove a custom item provider from the list of the given anchorblock
12469 * Removes the function and data pairing that matches @p func and @p data.
12470 * That is, unless the same function and same user data are given, the
12471 * function will not be removed from the list. This allows us to add the
12472 * same callback several times, with different @p data pointers and be
12473 * able to remove them later without conflicts.
12475 * @param obj The anchorblock object
12476 * @param func The function to remove from the list
12477 * @param data The data matching the function to remove from the list
12479 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);
12485 * @defgroup Bubble Bubble
12487 * @image html img/widget/bubble/preview-00.png
12488 * @image latex img/widget/bubble/preview-00.eps
12489 * @image html img/widget/bubble/preview-01.png
12490 * @image latex img/widget/bubble/preview-01.eps
12491 * @image html img/widget/bubble/preview-02.png
12492 * @image latex img/widget/bubble/preview-02.eps
12494 * @brief The Bubble is a widget to show text similar to how speech is
12495 * represented in comics.
12497 * The bubble widget contains 5 important visual elements:
12498 * @li The frame is a rectangle with rounded edjes and an "arrow".
12499 * @li The @p icon is an image to which the frame's arrow points to.
12500 * @li The @p label is a text which appears to the right of the icon if the
12501 * corner is "top_left" or "bottom_left" and is right aligned to the frame
12503 * @li The @p info is a text which appears to the right of the label. Info's
12504 * font is of a ligther color than label.
12505 * @li The @p content is an evas object that is shown inside the frame.
12507 * The position of the arrow, icon, label and info depends on which corner is
12508 * selected. The four available corners are:
12509 * @li "top_left" - Default
12511 * @li "bottom_left"
12512 * @li "bottom_right"
12514 * Signals that you can add callbacks for are:
12515 * @li "clicked" - This is called when a user has clicked the bubble.
12517 * Default contents parts of the bubble that you can use for are:
12518 * @li "default" - A content of the bubble
12519 * @li "icon" - An icon of the bubble
12521 * Default text parts of the button widget that you can use for are:
12522 * @li NULL - Label of the bubble
12524 * For an example of using a buble see @ref bubble_01_example_page "this".
12530 * Add a new bubble to the parent
12532 * @param parent The parent object
12533 * @return The new object or NULL if it cannot be created
12535 * This function adds a text bubble to the given parent evas object.
12537 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12539 * Set the label of the bubble
12541 * @param obj The bubble object
12542 * @param label The string to set in the label
12544 * This function sets the title of the bubble. Where this appears depends on
12545 * the selected corner.
12546 * @deprecated use elm_object_text_set() instead.
12548 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12550 * Get the label of the bubble
12552 * @param obj The bubble object
12553 * @return The string of set in the label
12555 * This function gets the title of the bubble.
12556 * @deprecated use elm_object_text_get() instead.
12558 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12560 * Set the info of the bubble
12562 * @param obj The bubble object
12563 * @param info The given info about the bubble
12565 * This function sets the info of the bubble. Where this appears depends on
12566 * the selected corner.
12567 * @deprecated use elm_object_part_text_set() instead. (with "info" as the parameter).
12569 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
12571 * Get the info of the bubble
12573 * @param obj The bubble object
12575 * @return The "info" string of the bubble
12577 * This function gets the info text.
12578 * @deprecated use elm_object_part_text_get() instead. (with "info" as the parameter).
12580 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12582 * Set the content to be shown in the bubble
12584 * Once the content object is set, a previously set one will be deleted.
12585 * If you want to keep the old content object, use the
12586 * elm_bubble_content_unset() function.
12588 * @param obj The bubble object
12589 * @param content The given content of the bubble
12591 * This function sets the content shown on the middle of the bubble.
12593 * @deprecated use elm_object_content_set() instead
12596 EINA_DEPRECATED EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12598 * Get the content shown in the bubble
12600 * Return the content object which is set for this widget.
12602 * @param obj The bubble object
12603 * @return The content that is being used
12605 * @deprecated use elm_object_content_get() instead
12608 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12610 * Unset the content shown in the bubble
12612 * Unparent and return the content object which was set for this widget.
12614 * @param obj The bubble object
12615 * @return The content that was being used
12617 * @deprecated use elm_object_content_unset() instead
12620 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12622 * Set the icon of the bubble
12624 * Once the icon object is set, a previously set one will be deleted.
12625 * If you want to keep the old content object, use the
12626 * elm_icon_content_unset() function.
12628 * @param obj The bubble object
12629 * @param icon The given icon for the bubble
12631 * @deprecated use elm_object_part_content_set() instead
12634 EINA_DEPRECATED EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12636 * Get the icon of the bubble
12638 * @param obj The bubble object
12639 * @return The icon for the bubble
12641 * This function gets the icon shown on the top left of bubble.
12643 * @deprecated use elm_object_part_content_get() instead
12646 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12648 * Unset the icon of the bubble
12650 * Unparent and return the icon object which was set for this widget.
12652 * @param obj The bubble object
12653 * @return The icon that was being used
12655 * @deprecated use elm_object_part_content_unset() instead
12658 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12660 * Set the corner of the bubble
12662 * @param obj The bubble object.
12663 * @param corner The given corner for the bubble.
12665 * This function sets the corner of the bubble. The corner will be used to
12666 * determine where the arrow in the frame points to and where label, icon and
12669 * Possible values for corner are:
12670 * @li "top_left" - Default
12672 * @li "bottom_left"
12673 * @li "bottom_right"
12675 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
12677 * Get the corner of the bubble
12679 * @param obj The bubble object.
12680 * @return The given corner for the bubble.
12682 * This function gets the selected corner of the bubble.
12684 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12690 * @defgroup Photo Photo
12692 * For displaying the photo of a person (contact). Simple, yet
12693 * with a very specific purpose.
12695 * Signals that you can add callbacks for are:
12697 * "clicked" - This is called when a user has clicked the photo
12698 * "drag,start" - Someone started dragging the image out of the object
12699 * "drag,end" - Dragged item was dropped (somewhere)
12705 * Add a new photo to the parent
12707 * @param parent The parent object
12708 * @return The new object or NULL if it cannot be created
12712 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12715 * Set the file that will be used as photo
12717 * @param obj The photo object
12718 * @param file The path to file that will be used as photo
12720 * @return (1 = success, 0 = error)
12724 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12727 * Set the file that will be used as thumbnail in the photo.
12729 * @param obj The photo object.
12730 * @param file The path to file that will be used as thumb.
12731 * @param group The key used in case of an EET file.
12735 EAPI void elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
12738 * Set the size that will be used on the photo
12740 * @param obj The photo object
12741 * @param size The size that the photo will be
12745 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12748 * Set if the photo should be completely visible or not.
12750 * @param obj The photo object
12751 * @param fill if true the photo will be completely visible
12755 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12758 * Set editability of the photo.
12760 * An editable photo can be dragged to or from, and can be cut or
12761 * pasted too. Note that pasting an image or dropping an item on
12762 * the image will delete the existing content.
12764 * @param obj The photo object.
12765 * @param set To set of clear editablity.
12767 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12773 /* gesture layer */
12775 * @defgroup Elm_Gesture_Layer Gesture Layer
12776 * Gesture Layer Usage:
12778 * Use Gesture Layer to detect gestures.
12779 * The advantage is that you don't have to implement
12780 * gesture detection, just set callbacks of gesture state.
12781 * By using gesture layer we make standard interface.
12783 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12784 * with a parent object parameter.
12785 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12786 * call. Usually with same object as target (2nd parameter).
12788 * Now you need to tell gesture layer what gestures you follow.
12789 * This is done with @ref elm_gesture_layer_cb_set call.
12790 * By setting the callback you actually saying to gesture layer:
12791 * I would like to know when the gesture @ref Elm_Gesture_Types
12792 * switches to state @ref Elm_Gesture_State.
12794 * Next, you need to implement the actual action that follows the input
12795 * in your callback.
12797 * Note that if you like to stop being reported about a gesture, just set
12798 * all callbacks referring this gesture to NULL.
12799 * (again with @ref elm_gesture_layer_cb_set)
12801 * The information reported by gesture layer to your callback is depending
12802 * on @ref Elm_Gesture_Types:
12803 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12804 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12805 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12807 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12808 * @ref ELM_GESTURE_MOMENTUM.
12810 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12811 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12812 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12813 * Note that we consider a flick as a line-gesture that should be completed
12814 * in flick-time-limit as defined in @ref Config.
12816 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12818 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12821 * Gesture Layer Tweaks:
12823 * Note that line, flick, gestures can start without the need to remove fingers from surface.
12824 * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
12826 * Setting glayer_continues_enable to false in @ref Config will change this behavior
12827 * so gesture starts when user touches (a *DOWN event) touch-surface
12828 * and ends when no fingers touches surface (a *UP event).
12832 * @enum _Elm_Gesture_Types
12833 * Enum of supported gesture types.
12834 * @ingroup Elm_Gesture_Layer
12836 enum _Elm_Gesture_Types
12838 ELM_GESTURE_FIRST = 0,
12840 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12841 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12842 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12843 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12845 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12847 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12848 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12850 ELM_GESTURE_ZOOM, /**< Zoom */
12851 ELM_GESTURE_ROTATE, /**< Rotate */
12857 * @typedef Elm_Gesture_Types
12858 * gesture types enum
12859 * @ingroup Elm_Gesture_Layer
12861 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12864 * @enum _Elm_Gesture_State
12865 * Enum of gesture states.
12866 * @ingroup Elm_Gesture_Layer
12868 enum _Elm_Gesture_State
12870 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12871 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
12872 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
12873 ELM_GESTURE_STATE_END, /**< Gesture completed */
12874 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
12878 * @typedef Elm_Gesture_State
12879 * gesture states enum
12880 * @ingroup Elm_Gesture_Layer
12882 typedef enum _Elm_Gesture_State Elm_Gesture_State;
12885 * @struct _Elm_Gesture_Taps_Info
12886 * Struct holds taps info for user
12887 * @ingroup Elm_Gesture_Layer
12889 struct _Elm_Gesture_Taps_Info
12891 Evas_Coord x, y; /**< Holds center point between fingers */
12892 unsigned int n; /**< Number of fingers tapped */
12893 unsigned int timestamp; /**< event timestamp */
12897 * @typedef Elm_Gesture_Taps_Info
12898 * holds taps info for user
12899 * @ingroup Elm_Gesture_Layer
12901 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12904 * @struct _Elm_Gesture_Momentum_Info
12905 * Struct holds momentum info for user
12906 * x1 and y1 are not necessarily in sync
12907 * x1 holds x value of x direction starting point
12908 * and same holds for y1.
12909 * This is noticeable when doing V-shape movement
12910 * @ingroup Elm_Gesture_Layer
12912 struct _Elm_Gesture_Momentum_Info
12913 { /* Report line ends, timestamps, and momentum computed */
12914 Evas_Coord x1; /**< Final-swipe direction starting point on X */
12915 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12916 Evas_Coord x2; /**< Final-swipe direction ending point on X */
12917 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
12919 unsigned int tx; /**< Timestamp of start of final x-swipe */
12920 unsigned int ty; /**< Timestamp of start of final y-swipe */
12922 Evas_Coord mx; /**< Momentum on X */
12923 Evas_Coord my; /**< Momentum on Y */
12925 unsigned int n; /**< Number of fingers */
12929 * @typedef Elm_Gesture_Momentum_Info
12930 * holds momentum info for user
12931 * @ingroup Elm_Gesture_Layer
12933 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12936 * @struct _Elm_Gesture_Line_Info
12937 * Struct holds line info for user
12938 * @ingroup Elm_Gesture_Layer
12940 struct _Elm_Gesture_Line_Info
12941 { /* Report line ends, timestamps, and momentum computed */
12942 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12943 double angle; /**< Angle (direction) of lines */
12947 * @typedef Elm_Gesture_Line_Info
12948 * Holds line info for user
12949 * @ingroup Elm_Gesture_Layer
12951 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12954 * @struct _Elm_Gesture_Zoom_Info
12955 * Struct holds zoom info for user
12956 * @ingroup Elm_Gesture_Layer
12958 struct _Elm_Gesture_Zoom_Info
12960 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12961 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12962 double zoom; /**< Zoom value: 1.0 means no zoom */
12963 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12967 * @typedef Elm_Gesture_Zoom_Info
12968 * Holds zoom info for user
12969 * @ingroup Elm_Gesture_Layer
12971 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12974 * @struct _Elm_Gesture_Rotate_Info
12975 * Struct holds rotation info for user
12976 * @ingroup Elm_Gesture_Layer
12978 struct _Elm_Gesture_Rotate_Info
12980 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12981 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12982 double base_angle; /**< Holds start-angle */
12983 double angle; /**< Rotation value: 0.0 means no rotation */
12984 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12988 * @typedef Elm_Gesture_Rotate_Info
12989 * Holds rotation info for user
12990 * @ingroup Elm_Gesture_Layer
12992 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12995 * @typedef Elm_Gesture_Event_Cb
12996 * User callback used to stream gesture info from gesture layer
12997 * @param data user data
12998 * @param event_info gesture report info
12999 * Returns a flag field to be applied on the causing event.
13000 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
13001 * upon the event, in an irreversible way.
13003 * @ingroup Elm_Gesture_Layer
13005 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
13008 * Use function to set callbacks to be notified about
13009 * change of state of gesture.
13010 * When a user registers a callback with this function
13011 * this means this gesture has to be tested.
13013 * When ALL callbacks for a gesture are set to NULL
13014 * it means user isn't interested in gesture-state
13015 * and it will not be tested.
13017 * @param obj Pointer to gesture-layer.
13018 * @param idx The gesture you would like to track its state.
13019 * @param cb callback function pointer.
13020 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
13021 * @param data user info to be sent to callback (usually, Smart Data)
13023 * @ingroup Elm_Gesture_Layer
13025 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);
13028 * Call this function to get repeat-events settings.
13030 * @param obj Pointer to gesture-layer.
13032 * @return repeat events settings.
13033 * @see elm_gesture_layer_hold_events_set()
13034 * @ingroup Elm_Gesture_Layer
13036 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
13039 * This function called in order to make gesture-layer repeat events.
13040 * Set this of you like to get the raw events only if gestures were not detected.
13041 * Clear this if you like gesture layer to fwd events as testing gestures.
13043 * @param obj Pointer to gesture-layer.
13044 * @param r Repeat: TRUE/FALSE
13046 * @ingroup Elm_Gesture_Layer
13048 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
13051 * This function sets step-value for zoom action.
13052 * Set step to any positive value.
13053 * Cancel step setting by setting to 0.0
13055 * @param obj Pointer to gesture-layer.
13056 * @param s new zoom step value.
13058 * @ingroup Elm_Gesture_Layer
13060 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
13063 * This function sets step-value for rotate action.
13064 * Set step to any positive value.
13065 * Cancel step setting by setting to 0.0
13067 * @param obj Pointer to gesture-layer.
13068 * @param s new roatate step value.
13070 * @ingroup Elm_Gesture_Layer
13072 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
13075 * This function called to attach gesture-layer to an Evas_Object.
13076 * @param obj Pointer to gesture-layer.
13077 * @param t Pointer to underlying object (AKA Target)
13079 * @return TRUE, FALSE on success, failure.
13081 * @ingroup Elm_Gesture_Layer
13083 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
13086 * Call this function to construct a new gesture-layer object.
13087 * This does not activate the gesture layer. You have to
13088 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
13090 * @param parent the parent object.
13092 * @return Pointer to new gesture-layer object.
13094 * @ingroup Elm_Gesture_Layer
13096 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13099 * @defgroup Thumb Thumb
13101 * @image html img/widget/thumb/preview-00.png
13102 * @image latex img/widget/thumb/preview-00.eps
13104 * A thumb object is used for displaying the thumbnail of an image or video.
13105 * You must have compiled Elementary with Ethumb_Client support and the DBus
13106 * service must be present and auto-activated in order to have thumbnails to
13109 * Once the thumbnail object becomes visible, it will check if there is a
13110 * previously generated thumbnail image for the file set on it. If not, it
13111 * will start generating this thumbnail.
13113 * Different config settings will cause different thumbnails to be generated
13114 * even on the same file.
13116 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
13117 * Ethumb documentation to change this path, and to see other configuration
13120 * Signals that you can add callbacks for are:
13122 * - "clicked" - This is called when a user has clicked the thumb without dragging
13124 * - "clicked,double" - This is called when a user has double-clicked the thumb.
13125 * - "press" - This is called when a user has pressed down the thumb.
13126 * - "generate,start" - The thumbnail generation started.
13127 * - "generate,stop" - The generation process stopped.
13128 * - "generate,error" - The generation failed.
13129 * - "load,error" - The thumbnail image loading failed.
13131 * available styles:
13135 * An example of use of thumbnail:
13137 * - @ref thumb_example_01
13141 * @addtogroup Thumb
13146 * @enum _Elm_Thumb_Animation_Setting
13147 * @typedef Elm_Thumb_Animation_Setting
13149 * Used to set if a video thumbnail is animating or not.
13153 typedef enum _Elm_Thumb_Animation_Setting
13155 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
13156 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
13157 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
13158 ELM_THUMB_ANIMATION_LAST
13159 } Elm_Thumb_Animation_Setting;
13162 * Add a new thumb object to the parent.
13164 * @param parent The parent object.
13165 * @return The new object or NULL if it cannot be created.
13167 * @see elm_thumb_file_set()
13168 * @see elm_thumb_ethumb_client_get()
13172 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13174 * Reload thumbnail if it was generated before.
13176 * @param obj The thumb object to reload
13178 * This is useful if the ethumb client configuration changed, like its
13179 * size, aspect or any other property one set in the handle returned
13180 * by elm_thumb_ethumb_client_get().
13182 * If the options didn't change, the thumbnail won't be generated again, but
13183 * the old one will still be used.
13185 * @see elm_thumb_file_set()
13189 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
13191 * Set the file that will be used as thumbnail.
13193 * @param obj The thumb object.
13194 * @param file The path to file that will be used as thumb.
13195 * @param key The key used in case of an EET file.
13197 * The file can be an image or a video (in that case, acceptable extensions are:
13198 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
13199 * function elm_thumb_animate().
13201 * @see elm_thumb_file_get()
13202 * @see elm_thumb_reload()
13203 * @see elm_thumb_animate()
13207 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
13209 * Get the image or video path and key used to generate the thumbnail.
13211 * @param obj The thumb object.
13212 * @param file Pointer to filename.
13213 * @param key Pointer to key.
13215 * @see elm_thumb_file_set()
13216 * @see elm_thumb_path_get()
13220 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13222 * Get the path and key to the image or video generated by ethumb.
13224 * One just need to make sure that the thumbnail was generated before getting
13225 * its path; otherwise, the path will be NULL. One way to do that is by asking
13226 * for the path when/after the "generate,stop" smart callback is called.
13228 * @param obj The thumb object.
13229 * @param file Pointer to thumb path.
13230 * @param key Pointer to thumb key.
13232 * @see elm_thumb_file_get()
13236 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13238 * Set the animation state for the thumb object. If its content is an animated
13239 * video, you may start/stop the animation or tell it to play continuously and
13242 * @param obj The thumb object.
13243 * @param setting The animation setting.
13245 * @see elm_thumb_file_set()
13249 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
13251 * Get the animation state for the thumb object.
13253 * @param obj The thumb object.
13254 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
13257 * @see elm_thumb_animate_set()
13261 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13263 * Get the ethumb_client handle so custom configuration can be made.
13265 * @return Ethumb_Client instance or NULL.
13267 * This must be called before the objects are created to be sure no object is
13268 * visible and no generation started.
13270 * Example of usage:
13273 * #include <Elementary.h>
13274 * #ifndef ELM_LIB_QUICKLAUNCH
13276 * elm_main(int argc, char **argv)
13278 * Ethumb_Client *client;
13280 * elm_need_ethumb();
13284 * client = elm_thumb_ethumb_client_get();
13287 * ERR("could not get ethumb_client");
13290 * ethumb_client_size_set(client, 100, 100);
13291 * ethumb_client_crop_align_set(client, 0.5, 0.5);
13294 * // Create elm_thumb objects here
13304 * @note There's only one client handle for Ethumb, so once a configuration
13305 * change is done to it, any other request for thumbnails (for any thumbnail
13306 * object) will use that configuration. Thus, this configuration is global.
13310 EAPI void *elm_thumb_ethumb_client_get(void);
13312 * Get the ethumb_client connection state.
13314 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
13317 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
13319 * Make the thumbnail 'editable'.
13321 * @param obj Thumb object.
13322 * @param set Turn on or off editability. Default is @c EINA_FALSE.
13324 * This means the thumbnail is a valid drag target for drag and drop, and can be
13325 * cut or pasted too.
13327 * @see elm_thumb_editable_get()
13331 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
13333 * Make the thumbnail 'editable'.
13335 * @param obj Thumb object.
13336 * @return Editability.
13338 * This means the thumbnail is a valid drag target for drag and drop, and can be
13339 * cut or pasted too.
13341 * @see elm_thumb_editable_set()
13345 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13352 * @defgroup Web Web
13354 * @image html img/widget/web/preview-00.png
13355 * @image latex img/widget/web/preview-00.eps
13357 * A web object is used for displaying web pages (HTML/CSS/JS)
13358 * using WebKit-EFL. You must have compiled Elementary with
13361 * Signals that you can add callbacks for are:
13362 * @li "download,request": A file download has been requested. Event info is
13363 * a pointer to a Elm_Web_Download
13364 * @li "editorclient,contents,changed": Editor client's contents changed
13365 * @li "editorclient,selection,changed": Editor client's selection changed
13366 * @li "frame,created": A new frame was created. Event info is an
13367 * Evas_Object which can be handled with WebKit's ewk_frame API
13368 * @li "icon,received": An icon was received by the main frame
13369 * @li "inputmethod,changed": Input method changed. Event info is an
13370 * Eina_Bool indicating whether it's enabled or not
13371 * @li "js,windowobject,clear": JS window object has been cleared
13372 * @li "link,hover,in": Mouse cursor is hovering over a link. Event info
13373 * is a char *link[2], where the first string contains the URL the link
13374 * points to, and the second one the title of the link
13375 * @li "link,hover,out": Mouse cursor left the link
13376 * @li "load,document,finished": Loading of a document finished. Event info
13377 * is the frame that finished loading
13378 * @li "load,error": Load failed. Event info is a pointer to
13379 * Elm_Web_Frame_Load_Error
13380 * @li "load,finished": Load finished. Event info is NULL on success, on
13381 * error it's a pointer to Elm_Web_Frame_Load_Error
13382 * @li "load,newwindow,show": A new window was created and is ready to be
13384 * @li "load,progress": Overall load progress. Event info is a pointer to
13385 * a double containing a value between 0.0 and 1.0
13386 * @li "load,provisional": Started provisional load
13387 * @li "load,started": Loading of a document started
13388 * @li "menubar,visible,get": Queries if the menubar is visible. Event info
13389 * is a pointer to Eina_Bool where the callback should set EINA_TRUE if
13390 * the menubar is visible, or EINA_FALSE in case it's not
13391 * @li "menubar,visible,set": Informs menubar visibility. Event info is
13392 * an Eina_Bool indicating the visibility
13393 * @li "popup,created": A dropdown widget was activated, requesting its
13394 * popup menu to be created. Event info is a pointer to Elm_Web_Menu
13395 * @li "popup,willdelete": The web object is ready to destroy the popup
13396 * object created. Event info is a pointer to Elm_Web_Menu
13397 * @li "ready": Page is fully loaded
13398 * @li "scrollbars,visible,get": Queries visibility of scrollbars. Event
13399 * info is a pointer to Eina_Bool where the visibility state should be set
13400 * @li "scrollbars,visible,set": Informs scrollbars visibility. Event info
13401 * is an Eina_Bool with the visibility state set
13402 * @li "statusbar,text,set": Text of the statusbar changed. Even info is
13403 * a string with the new text
13404 * @li "statusbar,visible,get": Queries visibility of the status bar.
13405 * Event info is a pointer to Eina_Bool where the visibility state should be
13407 * @li "statusbar,visible,set": Informs statusbar visibility. Event info is
13408 * an Eina_Bool with the visibility value
13409 * @li "title,changed": Title of the main frame changed. Event info is a
13410 * string with the new title
13411 * @li "toolbars,visible,get": Queries visibility of toolbars. Event info
13412 * is a pointer to Eina_Bool where the visibility state should be set
13413 * @li "toolbars,visible,set": Informs the visibility of toolbars. Event
13414 * info is an Eina_Bool with the visibility state
13415 * @li "tooltip,text,set": Show and set text of a tooltip. Event info is
13416 * a string with the text to show
13417 * @li "uri,changed": URI of the main frame changed. Event info is a string
13419 * @li "view,resized": The web object internal's view changed sized
13420 * @li "windows,close,request": A JavaScript request to close the current
13421 * window was requested
13422 * @li "zoom,animated,end": Animated zoom finished
13424 * available styles:
13427 * An example of use of web:
13429 * - @ref web_example_01 TBD
13438 * Structure used to report load errors.
13440 * Load errors are reported as signal by elm_web. All the strings are
13441 * temporary references and should @b not be used after the signal
13442 * callback returns. If it's required, make copies with strdup() or
13443 * eina_stringshare_add() (they are not even guaranteed to be
13444 * stringshared, so must use eina_stringshare_add() and not
13445 * eina_stringshare_ref()).
13447 typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
13449 * Structure used to report load errors.
13451 * Load errors are reported as signal by elm_web. All the strings are
13452 * temporary references and should @b not be used after the signal
13453 * callback returns. If it's required, make copies with strdup() or
13454 * eina_stringshare_add() (they are not even guaranteed to be
13455 * stringshared, so must use eina_stringshare_add() and not
13456 * eina_stringshare_ref()).
13458 struct _Elm_Web_Frame_Load_Error
13460 int code; /**< Numeric error code */
13461 Eina_Bool is_cancellation; /**< Error produced by cancelling a request */
13462 const char *domain; /**< Error domain name */
13463 const char *description; /**< Error description (already localized) */
13464 const char *failing_url; /**< The URL that failed to load */
13465 Evas_Object *frame; /**< Frame object that produced the error */
13469 * The possibles types that the items in a menu can be
13471 typedef enum _Elm_Web_Menu_Item_Type
13473 ELM_WEB_MENU_SEPARATOR,
13474 ELM_WEB_MENU_GROUP,
13475 ELM_WEB_MENU_OPTION
13476 } Elm_Web_Menu_Item_Type;
13479 * Structure describing the items in a menu
13481 typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item;
13483 * Structure describing the items in a menu
13485 struct _Elm_Web_Menu_Item
13487 const char *text; /**< The text for the item */
13488 Elm_Web_Menu_Item_Type type; /**< The type of the item */
13492 * Structure describing the menu of a popup
13494 * This structure will be passed as the @c event_info for the "popup,create"
13495 * signal, which is emitted when a dropdown menu is opened. Users wanting
13496 * to handle these popups by themselves should listen to this signal and
13497 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13498 * property as @c EINA_FALSE means that the user will not handle the popup
13499 * and the default implementation will be used.
13501 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13502 * will be emitted to notify the user that it can destroy any objects and
13503 * free all data related to it.
13505 * @see elm_web_popup_selected_set()
13506 * @see elm_web_popup_destroy()
13508 typedef struct _Elm_Web_Menu Elm_Web_Menu;
13510 * Structure describing the menu of a popup
13512 * This structure will be passed as the @c event_info for the "popup,create"
13513 * signal, which is emitted when a dropdown menu is opened. Users wanting
13514 * to handle these popups by themselves should listen to this signal and
13515 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13516 * property as @c EINA_FALSE means that the user will not handle the popup
13517 * and the default implementation will be used.
13519 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13520 * will be emitted to notify the user that it can destroy any objects and
13521 * free all data related to it.
13523 * @see elm_web_popup_selected_set()
13524 * @see elm_web_popup_destroy()
13526 struct _Elm_Web_Menu
13528 Eina_List *items; /**< List of #Elm_Web_Menu_Item */
13529 int x; /**< The X position of the popup, relative to the elm_web object */
13530 int y; /**< The Y position of the popup, relative to the elm_web object */
13531 int width; /**< Width of the popup menu */
13532 int height; /**< Height of the popup menu */
13534 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. */
13537 typedef struct _Elm_Web_Download Elm_Web_Download;
13538 struct _Elm_Web_Download
13544 * Types of zoom available.
13546 typedef enum _Elm_Web_Zoom_Mode
13548 ELM_WEB_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_web_zoom_set */
13549 ELM_WEB_ZOOM_MODE_AUTO_FIT, /**< Zoom until content fits in web object */
13550 ELM_WEB_ZOOM_MODE_AUTO_FILL, /**< Zoom until content fills web object */
13551 ELM_WEB_ZOOM_MODE_LAST
13552 } Elm_Web_Zoom_Mode;
13554 * Opaque handler containing the features (such as statusbar, menubar, etc)
13555 * that are to be set on a newly requested window.
13557 typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
13559 * Callback type for the create_window hook.
13561 * The function parameters are:
13562 * @li @p data User data pointer set when setting the hook function
13563 * @li @p obj The elm_web object requesting the new window
13564 * @li @p js Set to @c EINA_TRUE if the request was originated from
13565 * JavaScript. @c EINA_FALSE otherwise.
13566 * @li @p window_features A pointer of #Elm_Web_Window_Features indicating
13567 * the features requested for the new window.
13569 * The returned value of the function should be the @c elm_web widget where
13570 * the request will be loaded. That is, if a new window or tab is created,
13571 * the elm_web widget in it should be returned, and @b NOT the window
13573 * Returning @c NULL should cancel the request.
13575 * @see elm_web_window_create_hook_set()
13577 typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
13579 * Callback type for the JS alert hook.
13581 * The function parameters are:
13582 * @li @p data User data pointer set when setting the hook function
13583 * @li @p obj The elm_web object requesting the new window
13584 * @li @p message The message to show in the alert dialog
13586 * The function should return the object representing the alert dialog.
13587 * Elm_Web will run a second main loop to handle the dialog and normal
13588 * flow of the application will be restored when the object is deleted, so
13589 * the user should handle the popup properly in order to delete the object
13590 * when the action is finished.
13591 * If the function returns @c NULL the popup will be ignored.
13593 * @see elm_web_dialog_alert_hook_set()
13595 typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
13597 * Callback type for the JS confirm hook.
13599 * The function parameters are:
13600 * @li @p data User data pointer set when setting the hook function
13601 * @li @p obj The elm_web object requesting the new window
13602 * @li @p message The message to show in the confirm dialog
13603 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13604 * the user selected @c Ok, @c EINA_FALSE otherwise.
13606 * The function should return the object representing the confirm dialog.
13607 * Elm_Web will run a second main loop to handle the dialog and normal
13608 * flow of the application will be restored when the object is deleted, so
13609 * the user should handle the popup properly in order to delete the object
13610 * when the action is finished.
13611 * If the function returns @c NULL the popup will be ignored.
13613 * @see elm_web_dialog_confirm_hook_set()
13615 typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
13617 * Callback type for the JS prompt hook.
13619 * The function parameters are:
13620 * @li @p data User data pointer set when setting the hook function
13621 * @li @p obj The elm_web object requesting the new window
13622 * @li @p message The message to show in the prompt dialog
13623 * @li @p def_value The default value to present the user in the entry
13624 * @li @p value Pointer where to store the value given by the user. Must
13625 * be a malloc'ed string or @c NULL if the user cancelled the popup.
13626 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13627 * the user selected @c Ok, @c EINA_FALSE otherwise.
13629 * The function should return the object representing the prompt dialog.
13630 * Elm_Web will run a second main loop to handle the dialog and normal
13631 * flow of the application will be restored when the object is deleted, so
13632 * the user should handle the popup properly in order to delete the object
13633 * when the action is finished.
13634 * If the function returns @c NULL the popup will be ignored.
13636 * @see elm_web_dialog_prompt_hook_set()
13638 typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret);
13640 * Callback type for the JS file selector hook.
13642 * The function parameters are:
13643 * @li @p data User data pointer set when setting the hook function
13644 * @li @p obj The elm_web object requesting the new window
13645 * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
13646 * @li @p accept_types Mime types accepted
13647 * @li @p selected Pointer where to store the list of malloc'ed strings
13648 * containing the path to each file selected. Must be @c NULL if the file
13649 * dialog is cancelled
13650 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13651 * the user selected @c Ok, @c EINA_FALSE otherwise.
13653 * The function should return the object representing the file selector
13655 * Elm_Web will run a second main loop to handle the dialog and normal
13656 * flow of the application will be restored when the object is deleted, so
13657 * the user should handle the popup properly in order to delete the object
13658 * when the action is finished.
13659 * If the function returns @c NULL the popup will be ignored.
13661 * @see elm_web_dialog_file selector_hook_set()
13663 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);
13665 * Callback type for the JS console message hook.
13667 * When a console message is added from JavaScript, any set function to the
13668 * console message hook will be called for the user to handle. There is no
13669 * default implementation of this hook.
13671 * The function parameters are:
13672 * @li @p data User data pointer set when setting the hook function
13673 * @li @p obj The elm_web object that originated the message
13674 * @li @p message The message sent
13675 * @li @p line_number The line number
13676 * @li @p source_id Source id
13678 * @see elm_web_console_message_hook_set()
13680 typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
13682 * Add a new web object to the parent.
13684 * @param parent The parent object.
13685 * @return The new object or NULL if it cannot be created.
13687 * @see elm_web_uri_set()
13688 * @see elm_web_webkit_view_get()
13690 EAPI Evas_Object *elm_web_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13693 * Get internal ewk_view object from web object.
13695 * Elementary may not provide some low level features of EWebKit,
13696 * instead of cluttering the API with proxy methods we opted to
13697 * return the internal reference. Be careful using it as it may
13698 * interfere with elm_web behavior.
13700 * @param obj The web object.
13701 * @return The internal ewk_view object or NULL if it does not
13702 * exist. (Failure to create or Elementary compiled without
13705 * @see elm_web_add()
13707 EAPI Evas_Object *elm_web_webkit_view_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13710 * Sets the function to call when a new window is requested
13712 * This hook will be called when a request to create a new window is
13713 * issued from the web page loaded.
13714 * There is no default implementation for this feature, so leaving this
13715 * unset or passing @c NULL in @p func will prevent new windows from
13718 * @param obj The web object where to set the hook function
13719 * @param func The hook function to be called when a window is requested
13720 * @param data User data
13722 EAPI void elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data);
13724 * Sets the function to call when an alert dialog
13726 * This hook will be called when a JavaScript alert dialog is requested.
13727 * If no function is set or @c NULL is passed in @p func, the default
13728 * implementation will take place.
13730 * @param obj The web object where to set the hook function
13731 * @param func The callback function to be used
13732 * @param data User data
13734 * @see elm_web_inwin_mode_set()
13736 EAPI void elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data);
13738 * Sets the function to call when an confirm dialog
13740 * This hook will be called when a JavaScript confirm dialog is requested.
13741 * If no function is set or @c NULL is passed in @p func, the default
13742 * implementation will take place.
13744 * @param obj The web object where to set the hook function
13745 * @param func The callback function to be used
13746 * @param data User data
13748 * @see elm_web_inwin_mode_set()
13750 EAPI void elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data);
13752 * Sets the function to call when an prompt dialog
13754 * This hook will be called when a JavaScript prompt dialog is requested.
13755 * If no function is set or @c NULL is passed in @p func, the default
13756 * implementation will take place.
13758 * @param obj The web object where to set the hook function
13759 * @param func The callback function to be used
13760 * @param data User data
13762 * @see elm_web_inwin_mode_set()
13764 EAPI void elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data);
13766 * Sets the function to call when an file selector dialog
13768 * This hook will be called when a JavaScript file selector dialog is
13770 * If no function is set or @c NULL is passed in @p func, the default
13771 * implementation will take place.
13773 * @param obj The web object where to set the hook function
13774 * @param func The callback function to be used
13775 * @param data User data
13777 * @see elm_web_inwin_mode_set()
13779 EAPI void elm_web_dialog_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data);
13781 * Sets the function to call when a console message is emitted from JS
13783 * This hook will be called when a console message is emitted from
13784 * JavaScript. There is no default implementation for this feature.
13786 * @param obj The web object where to set the hook function
13787 * @param func The callback function to be used
13788 * @param data User data
13790 EAPI void elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data);
13792 * Gets the status of the tab propagation
13794 * @param obj The web object to query
13795 * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
13797 * @see elm_web_tab_propagate_set()
13799 EAPI Eina_Bool elm_web_tab_propagate_get(const Evas_Object *obj);
13801 * Sets whether to use tab propagation
13803 * If tab propagation is enabled, whenever the user presses the Tab key,
13804 * Elementary will handle it and switch focus to the next widget.
13805 * The default value is disabled, where WebKit will handle the Tab key to
13806 * cycle focus though its internal objects, jumping to the next widget
13807 * only when that cycle ends.
13809 * @param obj The web object
13810 * @param propagate Whether to propagate Tab keys to Elementary or not
13812 EAPI void elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate);
13814 * Sets the URI for the web object
13816 * It must be a full URI, with resource included, in the form
13817 * http://www.enlightenment.org or file:///tmp/something.html
13819 * @param obj The web object
13820 * @param uri The URI to set
13821 * @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
13823 EAPI Eina_Bool elm_web_uri_set(Evas_Object *obj, const char *uri);
13825 * Gets the current URI for the object
13827 * The returned string must not be freed and is guaranteed to be
13830 * @param obj The web object
13831 * @return A stringshared internal string with the current URI, or NULL on
13834 EAPI const char *elm_web_uri_get(const Evas_Object *obj);
13836 * Gets the current title
13838 * The returned string must not be freed and is guaranteed to be
13841 * @param obj The web object
13842 * @return A stringshared internal string with the current title, or NULL on
13845 EAPI const char *elm_web_title_get(const Evas_Object *obj);
13847 * Sets the background color to be used by the web object
13849 * This is the color that will be used by default when the loaded page
13850 * does not set it's own. Color values are pre-multiplied.
13852 * @param obj The web object
13853 * @param r Red component
13854 * @param g Green component
13855 * @param b Blue component
13856 * @param a Alpha component
13858 EAPI void elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a);
13860 * Gets the background color to be used by the web object
13862 * This is the color that will be used by default when the loaded page
13863 * does not set it's own. Color values are pre-multiplied.
13865 * @param obj The web object
13866 * @param r Red component
13867 * @param g Green component
13868 * @param b Blue component
13869 * @param a Alpha component
13871 EAPI void elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
13873 * Gets a copy of the currently selected text
13875 * The string returned must be freed by the user when it's done with it.
13877 * @param obj The web object
13878 * @return A newly allocated string, or NULL if nothing is selected or an
13881 EAPI char *elm_view_selection_get(const Evas_Object *obj);
13883 * Tells the web object which index in the currently open popup was selected
13885 * When the user handles the popup creation from the "popup,created" signal,
13886 * it needs to tell the web object which item was selected by calling this
13887 * function with the index corresponding to the item.
13889 * @param obj The web object
13890 * @param index The index selected
13892 * @see elm_web_popup_destroy()
13894 EAPI void elm_web_popup_selected_set(Evas_Object *obj, int index);
13896 * Dismisses an open dropdown popup
13898 * When the popup from a dropdown widget is to be dismissed, either after
13899 * selecting an option or to cancel it, this function must be called, which
13900 * will later emit an "popup,willdelete" signal to notify the user that
13901 * any memory and objects related to this popup can be freed.
13903 * @param obj The web object
13904 * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE
13905 * if there was no menu to destroy
13907 EAPI Eina_Bool elm_web_popup_destroy(Evas_Object *obj);
13909 * Searches the given string in a document.
13911 * @param obj The web object where to search the text
13912 * @param string String to search
13913 * @param case_sensitive If search should be case sensitive or not
13914 * @param forward If search is from cursor and on or backwards
13915 * @param wrap If search should wrap at the end
13917 * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not
13920 EAPI Eina_Bool elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
13922 * Marks matches of the given string in a document.
13924 * @param obj The web object where to search text
13925 * @param string String to match
13926 * @param case_sensitive If match should be case sensitive or not
13927 * @param highlight If matches should be highlighted
13928 * @param limit Maximum amount of matches, or zero to unlimited
13930 * @return number of matched @a string
13932 EAPI unsigned int elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
13934 * Clears all marked matches in the document
13936 * @param obj The web object
13938 * @return EINA_TRUE on success, EINA_FALSE otherwise
13940 EAPI Eina_Bool elm_web_text_matches_unmark_all(Evas_Object *obj);
13942 * Sets whether to highlight the matched marks
13944 * If enabled, marks set with elm_web_text_matches_mark() will be
13947 * @param obj The web object
13948 * @param highlight Whether to highlight the marks or not
13950 * @return EINA_TRUE on success, EINA_FALSE otherwise
13952 EAPI Eina_Bool elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight);
13954 * Gets whether highlighting marks is enabled
13956 * @param The web object
13958 * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
13961 EAPI Eina_Bool elm_web_text_matches_highlight_get(const Evas_Object *obj);
13963 * Gets the overall loading progress of the page
13965 * Returns the estimated loading progress of the page, with a value between
13966 * 0.0 and 1.0. This is an estimated progress accounting for all the frames
13967 * included in the page.
13969 * @param The web object
13971 * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
13974 EAPI double elm_web_load_progress_get(const Evas_Object *obj);
13976 * Stops loading the current page
13978 * Cancels the loading of the current page in the web object. This will
13979 * cause a "load,error" signal to be emitted, with the is_cancellation
13980 * flag set to EINA_TRUE.
13982 * @param obj The web object
13984 * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
13986 EAPI Eina_Bool elm_web_stop(Evas_Object *obj);
13988 * Requests a reload of the current document in the object
13990 * @param obj The web object
13992 * @return EINA_TRUE on success, EINA_FALSE otherwise
13994 EAPI Eina_Bool elm_web_reload(Evas_Object *obj);
13996 * Requests a reload of the current document, avoiding any existing caches
13998 * @param obj The web object
14000 * @return EINA_TRUE on success, EINA_FALSE otherwise
14002 EAPI Eina_Bool elm_web_reload_full(Evas_Object *obj);
14004 * Goes back one step in the browsing history
14006 * This is equivalent to calling elm_web_object_navigate(obj, -1);
14008 * @param obj The web object
14010 * @return EINA_TRUE on success, EINA_FALSE otherwise
14012 * @see elm_web_history_enable_set()
14013 * @see elm_web_back_possible()
14014 * @see elm_web_forward()
14015 * @see elm_web_navigate()
14017 EAPI Eina_Bool elm_web_back(Evas_Object *obj);
14019 * Goes forward one step in the browsing history
14021 * This is equivalent to calling elm_web_object_navigate(obj, 1);
14023 * @param obj The web object
14025 * @return EINA_TRUE on success, EINA_FALSE otherwise
14027 * @see elm_web_history_enable_set()
14028 * @see elm_web_forward_possible()
14029 * @see elm_web_back()
14030 * @see elm_web_navigate()
14032 EAPI Eina_Bool elm_web_forward(Evas_Object *obj);
14034 * Jumps the given number of steps in the browsing history
14036 * The @p steps value can be a negative integer to back in history, or a
14037 * positive to move forward.
14039 * @param obj The web object
14040 * @param steps The number of steps to jump
14042 * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
14043 * history exists to jump the given number of steps
14045 * @see elm_web_history_enable_set()
14046 * @see elm_web_navigate_possible()
14047 * @see elm_web_back()
14048 * @see elm_web_forward()
14050 EAPI Eina_Bool elm_web_navigate(Evas_Object *obj, int steps);
14052 * Queries whether it's possible to go back in history
14054 * @param obj The web object
14056 * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
14059 EAPI Eina_Bool elm_web_back_possible(Evas_Object *obj);
14061 * Queries whether it's possible to go forward in history
14063 * @param obj The web object
14065 * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
14068 EAPI Eina_Bool elm_web_forward_possible(Evas_Object *obj);
14070 * Queries whether it's possible to jump the given number of steps
14072 * The @p steps value can be a negative integer to back in history, or a
14073 * positive to move forward.
14075 * @param obj The web object
14076 * @param steps The number of steps to check for
14078 * @return EINA_TRUE if enough history exists to perform the given jump,
14079 * EINA_FALSE otherwise
14081 EAPI Eina_Bool elm_web_navigate_possible(Evas_Object *obj, int steps);
14083 * Gets whether browsing history is enabled for the given object
14085 * @param obj The web object
14087 * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
14089 EAPI Eina_Bool elm_web_history_enable_get(const Evas_Object *obj);
14091 * Enables or disables the browsing history
14093 * @param obj The web object
14094 * @param enable Whether to enable or disable the browsing history
14096 EAPI void elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
14098 * Sets the zoom level of the web object
14100 * Zoom level matches the Webkit API, so 1.0 means normal zoom, with higher
14101 * values meaning zoom in and lower meaning zoom out. This function will
14102 * only affect the zoom level if the mode set with elm_web_zoom_mode_set()
14103 * is ::ELM_WEB_ZOOM_MODE_MANUAL.
14105 * @param obj The web object
14106 * @param zoom The zoom level to set
14108 EAPI void elm_web_zoom_set(Evas_Object *obj, double zoom);
14110 * Gets the current zoom level set on the web object
14112 * Note that this is the zoom level set on the web object and not that
14113 * of the underlying Webkit one. In the ::ELM_WEB_ZOOM_MODE_MANUAL mode,
14114 * the two zoom levels should match, but for the other two modes the
14115 * Webkit zoom is calculated internally to match the chosen mode without
14116 * changing the zoom level set for the web object.
14118 * @param obj The web object
14120 * @return The zoom level set on the object
14122 EAPI double elm_web_zoom_get(const Evas_Object *obj);
14124 * Sets the zoom mode to use
14126 * The modes can be any of those defined in ::Elm_Web_Zoom_Mode, except
14127 * ::ELM_WEB_ZOOM_MODE_LAST. The default is ::ELM_WEB_ZOOM_MODE_MANUAL.
14129 * ::ELM_WEB_ZOOM_MODE_MANUAL means the zoom level will be controlled
14130 * with the elm_web_zoom_set() function.
14131 * ::ELM_WEB_ZOOM_MODE_AUTO_FIT will calculate the needed zoom level to
14132 * make sure the entirety of the web object's contents are shown.
14133 * ::ELM_WEB_ZOOM_MODE_AUTO_FILL will calculate the needed zoom level to
14134 * fit the contents in the web object's size, without leaving any space
14137 * @param obj The web object
14138 * @param mode The mode to set
14140 EAPI void elm_web_zoom_mode_set(Evas_Object *obj, Elm_Web_Zoom_Mode mode);
14142 * Gets the currently set zoom mode
14144 * @param obj The web object
14146 * @return The current zoom mode set for the object, or
14147 * ::ELM_WEB_ZOOM_MODE_LAST on error
14149 EAPI Elm_Web_Zoom_Mode elm_web_zoom_mode_get(const Evas_Object *obj);
14151 * Shows the given region in the web object
14153 * @param obj The web object
14154 * @param x The x coordinate of the region to show
14155 * @param y The y coordinate of the region to show
14156 * @param w The width of the region to show
14157 * @param h The height of the region to show
14159 EAPI void elm_web_region_show(Evas_Object *obj, int x, int y, int w, int h);
14161 * Brings in the region to the visible area
14163 * Like elm_web_region_show(), but it animates the scrolling of the object
14166 * @param obj The web object
14167 * @param x The x coordinate of the region to show
14168 * @param y The y coordinate of the region to show
14169 * @param w The width of the region to show
14170 * @param h The height of the region to show
14172 EAPI void elm_web_region_bring_in(Evas_Object *obj, int x, int y, int w, int h);
14174 * Sets the default dialogs to use an Inwin instead of a normal window
14176 * If set, then the default implementation for the JavaScript dialogs and
14177 * file selector will be opened in an Inwin. Otherwise they will use a
14178 * normal separated window.
14180 * @param obj The web object
14181 * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
14183 EAPI void elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
14185 * Gets whether Inwin mode is set for the current object
14187 * @param obj The web object
14189 * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
14191 EAPI Eina_Bool elm_web_inwin_mode_get(const Evas_Object *obj);
14193 EAPI void elm_web_window_features_ref(Elm_Web_Window_Features *wf);
14194 EAPI void elm_web_window_features_unref(Elm_Web_Window_Features *wf);
14195 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);
14196 EAPI void elm_web_window_features_int_property_get(const Elm_Web_Window_Features *wf, int *x, int *y, int *w, int *h);
14203 * @defgroup Hoversel Hoversel
14205 * @image html img/widget/hoversel/preview-00.png
14206 * @image latex img/widget/hoversel/preview-00.eps
14208 * A hoversel is a button that pops up a list of items (automatically
14209 * choosing the direction to display) that have a label and, optionally, an
14210 * icon to select from. It is a convenience widget to avoid the need to do
14211 * all the piecing together yourself. It is intended for a small number of
14212 * items in the hoversel menu (no more than 8), though is capable of many
14215 * Signals that you can add callbacks for are:
14216 * "clicked" - the user clicked the hoversel button and popped up the sel
14217 * "selected" - an item in the hoversel list is selected. event_info is the item
14218 * "dismissed" - the hover is dismissed
14220 * See @ref tutorial_hoversel for an example.
14223 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
14225 * @brief Add a new Hoversel object
14227 * @param parent The parent object
14228 * @return The new object or NULL if it cannot be created
14230 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14232 * @brief This sets the hoversel to expand horizontally.
14234 * @param obj The hoversel object
14235 * @param horizontal If true, the hover will expand horizontally to the
14238 * @note The initial button will display horizontally regardless of this
14241 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14243 * @brief This returns whether the hoversel is set to expand horizontally.
14245 * @param obj The hoversel object
14246 * @return If true, the hover will expand horizontally to the right.
14248 * @see elm_hoversel_horizontal_set()
14250 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14252 * @brief Set the Hover parent
14254 * @param obj The hoversel object
14255 * @param parent The parent to use
14257 * Sets the hover parent object, the area that will be darkened when the
14258 * hoversel is clicked. Should probably be the window that the hoversel is
14259 * in. See @ref Hover objects for more information.
14261 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14263 * @brief Get the Hover parent
14265 * @param obj The hoversel object
14266 * @return The used parent
14268 * Gets the hover parent object.
14270 * @see elm_hoversel_hover_parent_set()
14272 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14274 * @brief Set the hoversel button label
14276 * @param obj The hoversel object
14277 * @param label The label text.
14279 * This sets the label of the button that is always visible (before it is
14280 * clicked and expanded).
14282 * @deprecated elm_object_text_set()
14284 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14286 * @brief Get the hoversel button label
14288 * @param obj The hoversel object
14289 * @return The label text.
14291 * @deprecated elm_object_text_get()
14293 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14295 * @brief Set the icon of the hoversel button
14297 * @param obj The hoversel object
14298 * @param icon The icon object
14300 * Sets the icon of the button that is always visible (before it is clicked
14301 * and expanded). Once the icon object is set, a previously set one will be
14302 * deleted, if you want to keep that old content object, use the
14303 * elm_hoversel_icon_unset() function.
14305 * @see elm_object_content_set() for the button widget
14307 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
14309 * @brief Get the icon of the hoversel button
14311 * @param obj The hoversel object
14312 * @return The icon object
14314 * Get the icon of the button that is always visible (before it is clicked
14315 * and expanded). Also see elm_object_content_get() for the button widget.
14317 * @see elm_hoversel_icon_set()
14319 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14321 * @brief Get and unparent the icon of the hoversel button
14323 * @param obj The hoversel object
14324 * @return The icon object that was being used
14326 * Unparent and return the icon of the button that is always visible
14327 * (before it is clicked and expanded).
14329 * @see elm_hoversel_icon_set()
14330 * @see elm_object_content_unset() for the button widget
14332 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14334 * @brief This triggers the hoversel popup from code, the same as if the user
14335 * had clicked the button.
14337 * @param obj The hoversel object
14339 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
14341 * @brief This dismisses the hoversel popup as if the user had clicked
14342 * outside the hover.
14344 * @param obj The hoversel object
14346 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
14348 * @brief Returns whether the hoversel is expanded.
14350 * @param obj The hoversel object
14351 * @return This will return EINA_TRUE if the hoversel is expanded or
14352 * EINA_FALSE if it is not expanded.
14354 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14356 * @brief This will remove all the children items from the hoversel.
14358 * @param obj The hoversel object
14360 * @warning Should @b not be called while the hoversel is active; use
14361 * elm_hoversel_expanded_get() to check first.
14363 * @see elm_hoversel_item_del_cb_set()
14364 * @see elm_hoversel_item_del()
14366 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14368 * @brief Get the list of items within the given hoversel.
14370 * @param obj The hoversel object
14371 * @return Returns a list of Elm_Hoversel_Item*
14373 * @see elm_hoversel_item_add()
14375 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14377 * @brief Add an item to the hoversel button
14379 * @param obj The hoversel object
14380 * @param label The text label to use for the item (NULL if not desired)
14381 * @param icon_file An image file path on disk to use for the icon or standard
14382 * icon name (NULL if not desired)
14383 * @param icon_type The icon type if relevant
14384 * @param func Convenience function to call when this item is selected
14385 * @param data Data to pass to item-related functions
14386 * @return A handle to the item added.
14388 * This adds an item to the hoversel to show when it is clicked. Note: if you
14389 * need to use an icon from an edje file then use
14390 * elm_hoversel_item_icon_set() right after the this function, and set
14391 * icon_file to NULL here.
14393 * For more information on what @p icon_file and @p icon_type are see the
14394 * @ref Icon "icon documentation".
14396 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);
14398 * @brief Delete an item from the hoversel
14400 * @param item The item to delete
14402 * This deletes the item from the hoversel (should not be called while the
14403 * hoversel is active; use elm_hoversel_expanded_get() to check first).
14405 * @see elm_hoversel_item_add()
14406 * @see elm_hoversel_item_del_cb_set()
14408 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
14410 * @brief Set the function to be called when an item from the hoversel is
14413 * @param item The item to set the callback on
14414 * @param func The function called
14416 * That function will receive these parameters:
14417 * @li void *item_data
14418 * @li Evas_Object *the_item_object
14419 * @li Elm_Hoversel_Item *the_object_struct
14421 * @see elm_hoversel_item_add()
14423 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14425 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
14426 * that will be passed to associated function callbacks.
14428 * @param item The item to get the data from
14429 * @return The data pointer set with elm_hoversel_item_add()
14431 * @see elm_hoversel_item_add()
14433 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14435 * @brief This returns the label text of the given hoversel item.
14437 * @param item The item to get the label
14438 * @return The label text of the hoversel item
14440 * @see elm_hoversel_item_add()
14442 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14444 * @brief This sets the icon for the given hoversel item.
14446 * @param item The item to set the icon
14447 * @param icon_file An image file path on disk to use for the icon or standard
14449 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
14450 * to NULL if the icon is not an edje file
14451 * @param icon_type The icon type
14453 * The icon can be loaded from the standard set, from an image file, or from
14456 * @see elm_hoversel_item_add()
14458 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);
14460 * @brief Get the icon object of the hoversel item
14462 * @param item The item to get the icon from
14463 * @param icon_file The image file path on disk used for the icon or standard
14465 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
14466 * if the icon is not an edje file
14467 * @param icon_type The icon type
14469 * @see elm_hoversel_item_icon_set()
14470 * @see elm_hoversel_item_add()
14472 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);
14478 * @defgroup Toolbar Toolbar
14479 * @ingroup Elementary
14481 * @image html img/widget/toolbar/preview-00.png
14482 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
14484 * @image html img/toolbar.png
14485 * @image latex img/toolbar.eps width=\textwidth
14487 * A toolbar is a widget that displays a list of items inside
14488 * a box. It can be scrollable, show a menu with items that don't fit
14489 * to toolbar size or even crop them.
14491 * Only one item can be selected at a time.
14493 * Items can have multiple states, or show menus when selected by the user.
14495 * Smart callbacks one can listen to:
14496 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
14497 * - "language,changed" - when the program language changes
14499 * Available styles for it:
14501 * - @c "transparent" - no background or shadow, just show the content
14503 * List of examples:
14504 * @li @ref toolbar_example_01
14505 * @li @ref toolbar_example_02
14506 * @li @ref toolbar_example_03
14510 * @addtogroup Toolbar
14515 * @enum _Elm_Toolbar_Shrink_Mode
14516 * @typedef Elm_Toolbar_Shrink_Mode
14518 * Set toolbar's items display behavior, it can be scrollabel,
14519 * show a menu with exceeding items, or simply hide them.
14521 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
14524 * Values <b> don't </b> work as bitmask, only one can be choosen.
14526 * @see elm_toolbar_mode_shrink_set()
14527 * @see elm_toolbar_mode_shrink_get()
14531 typedef enum _Elm_Toolbar_Shrink_Mode
14533 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
14534 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
14535 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
14536 ELM_TOOLBAR_SHRINK_MENU, /**< Inserts a button to pop up a menu with exceeding items. */
14537 ELM_TOOLBAR_SHRINK_LAST /**< Indicates error if returned by elm_toolbar_shrink_mode_get() */
14538 } Elm_Toolbar_Shrink_Mode;
14540 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(). */
14542 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(). */
14545 * Add a new toolbar widget to the given parent Elementary
14546 * (container) object.
14548 * @param parent The parent object.
14549 * @return a new toolbar widget handle or @c NULL, on errors.
14551 * This function inserts a new toolbar widget on the canvas.
14555 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14558 * Set the icon size, in pixels, to be used by toolbar items.
14560 * @param obj The toolbar object
14561 * @param icon_size The icon size in pixels
14563 * @note Default value is @c 32. It reads value from elm config.
14565 * @see elm_toolbar_icon_size_get()
14569 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
14572 * Get the icon size, in pixels, to be used by toolbar items.
14574 * @param obj The toolbar object.
14575 * @return The icon size in pixels.
14577 * @see elm_toolbar_icon_size_set() for details.
14581 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14584 * Sets icon lookup order, for toolbar items' icons.
14586 * @param obj The toolbar object.
14587 * @param order The icon lookup order.
14589 * Icons added before calling this function will not be affected.
14590 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
14592 * @see elm_toolbar_icon_order_lookup_get()
14596 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
14599 * Gets the icon lookup order.
14601 * @param obj The toolbar object.
14602 * @return The icon lookup order.
14604 * @see elm_toolbar_icon_order_lookup_set() for details.
14608 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14611 * Set whether the toolbar should always have an item selected.
14613 * @param obj The toolbar object.
14614 * @param wrap @c EINA_TRUE to enable always-select mode or @c EINA_FALSE to
14617 * This will cause the toolbar to always have an item selected, and clicking
14618 * the selected item will not cause a selected event to be emitted. Enabling this mode
14619 * will immediately select the first toolbar item.
14621 * Always-selected is disabled by default.
14623 * @see elm_toolbar_always_select_mode_get().
14627 EAPI void elm_toolbar_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14630 * Get whether the toolbar should always have an item selected.
14632 * @param obj The toolbar object.
14633 * @return @c EINA_TRUE means an item will always be selected, @c EINA_FALSE indicates
14634 * that it is possible to have no items selected. If @p obj is @c NULL, @c EINA_FALSE is returned.
14636 * @see elm_toolbar_always_select_mode_set() for details.
14640 EAPI Eina_Bool elm_toolbar_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14643 * Set whether the toolbar items' should be selected by the user or not.
14645 * @param obj The toolbar object.
14646 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
14649 * This will turn off the ability to select items entirely and they will
14650 * neither appear selected nor emit selected signals. The clicked
14651 * callback function will still be called.
14653 * Selection is enabled by default.
14655 * @see elm_toolbar_no_select_mode_get().
14659 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14662 * Set whether the toolbar items' should be selected by the user or not.
14664 * @param obj The toolbar object.
14665 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
14666 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
14668 * @see elm_toolbar_no_select_mode_set() for details.
14672 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14675 * Append item to the toolbar.
14677 * @param obj The toolbar object.
14678 * @param icon A string with icon name or the absolute path of an image file.
14679 * @param label The label of the item.
14680 * @param func The function to call when the item is clicked.
14681 * @param data The data to associate with the item for related callbacks.
14682 * @return The created item or @c NULL upon failure.
14684 * A new item will be created and appended to the toolbar, i.e., will
14685 * be set as @b last item.
14687 * Items created with this method can be deleted with
14688 * elm_toolbar_item_del().
14690 * Associated @p data can be properly freed when item is deleted if a
14691 * callback function is set with elm_toolbar_item_del_cb_set().
14693 * If a function is passed as argument, it will be called everytime this item
14694 * is selected, i.e., the user clicks over an unselected item.
14695 * If such function isn't needed, just passing
14696 * @c NULL as @p func is enough. The same should be done for @p data.
14698 * Toolbar will load icon image from fdo or current theme.
14699 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14700 * If an absolute path is provided it will load it direct from a file.
14702 * @see elm_toolbar_item_icon_set()
14703 * @see elm_toolbar_item_del()
14704 * @see elm_toolbar_item_del_cb_set()
14708 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);
14711 * Prepend item to the toolbar.
14713 * @param obj The toolbar object.
14714 * @param icon A string with icon name or the absolute path of an image file.
14715 * @param label The label of the item.
14716 * @param func The function to call when the item is clicked.
14717 * @param data The data to associate with the item for related callbacks.
14718 * @return The created item or @c NULL upon failure.
14720 * A new item will be created and prepended to the toolbar, i.e., will
14721 * be set as @b first item.
14723 * Items created with this method can be deleted with
14724 * elm_toolbar_item_del().
14726 * Associated @p data can be properly freed when item is deleted if a
14727 * callback function is set with elm_toolbar_item_del_cb_set().
14729 * If a function is passed as argument, it will be called everytime this item
14730 * is selected, i.e., the user clicks over an unselected item.
14731 * If such function isn't needed, just passing
14732 * @c NULL as @p func is enough. The same should be done for @p data.
14734 * Toolbar will load icon image from fdo or current theme.
14735 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14736 * If an absolute path is provided it will load it direct from a file.
14738 * @see elm_toolbar_item_icon_set()
14739 * @see elm_toolbar_item_del()
14740 * @see elm_toolbar_item_del_cb_set()
14744 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);
14747 * Insert a new item into the toolbar object before item @p before.
14749 * @param obj The toolbar object.
14750 * @param before The toolbar item to insert before.
14751 * @param icon A string with icon name or the absolute path of an image file.
14752 * @param label The label of the item.
14753 * @param func The function to call when the item is clicked.
14754 * @param data The data to associate with the item for related callbacks.
14755 * @return The created item or @c NULL upon failure.
14757 * A new item will be created and added to the toolbar. Its position in
14758 * this toolbar will be just before item @p before.
14760 * Items created with this method can be deleted with
14761 * elm_toolbar_item_del().
14763 * Associated @p data can be properly freed when item is deleted if a
14764 * callback function is set with elm_toolbar_item_del_cb_set().
14766 * If a function is passed as argument, it will be called everytime this item
14767 * is selected, i.e., the user clicks over an unselected item.
14768 * If such function isn't needed, just passing
14769 * @c NULL as @p func is enough. The same should be done for @p data.
14771 * Toolbar will load icon image from fdo or current theme.
14772 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14773 * If an absolute path is provided it will load it direct from a file.
14775 * @see elm_toolbar_item_icon_set()
14776 * @see elm_toolbar_item_del()
14777 * @see elm_toolbar_item_del_cb_set()
14781 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);
14784 * Insert a new item into the toolbar object after item @p after.
14786 * @param obj The toolbar object.
14787 * @param after The toolbar item to insert after.
14788 * @param icon A string with icon name or the absolute path of an image file.
14789 * @param label The label of the item.
14790 * @param func The function to call when the item is clicked.
14791 * @param data The data to associate with the item for related callbacks.
14792 * @return The created item or @c NULL upon failure.
14794 * A new item will be created and added to the toolbar. Its position in
14795 * this toolbar will be just after item @p after.
14797 * Items created with this method can be deleted with
14798 * elm_toolbar_item_del().
14800 * Associated @p data can be properly freed when item is deleted if a
14801 * callback function is set with elm_toolbar_item_del_cb_set().
14803 * If a function is passed as argument, it will be called everytime this item
14804 * is selected, i.e., the user clicks over an unselected item.
14805 * If such function isn't needed, just passing
14806 * @c NULL as @p func is enough. The same should be done for @p data.
14808 * Toolbar will load icon image from fdo or current theme.
14809 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14810 * If an absolute path is provided it will load it direct from a file.
14812 * @see elm_toolbar_item_icon_set()
14813 * @see elm_toolbar_item_del()
14814 * @see elm_toolbar_item_del_cb_set()
14818 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);
14821 * Get the first item in the given toolbar widget's list of
14824 * @param obj The toolbar object
14825 * @return The first item or @c NULL, if it has no items (and on
14828 * @see elm_toolbar_item_append()
14829 * @see elm_toolbar_last_item_get()
14833 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14836 * Get the last item in the given toolbar widget's list of
14839 * @param obj The toolbar object
14840 * @return The last item or @c NULL, if it has no items (and on
14843 * @see elm_toolbar_item_prepend()
14844 * @see elm_toolbar_first_item_get()
14848 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14851 * Get the item after @p item in toolbar.
14853 * @param item The toolbar item.
14854 * @return The item after @p item, or @c NULL if none or on failure.
14856 * @note If it is the last item, @c NULL will be returned.
14858 * @see elm_toolbar_item_append()
14862 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14865 * Get the item before @p item in toolbar.
14867 * @param item The toolbar item.
14868 * @return The item before @p item, or @c NULL if none or on failure.
14870 * @note If it is the first item, @c NULL will be returned.
14872 * @see elm_toolbar_item_prepend()
14876 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14879 * Get the toolbar object from an item.
14881 * @param item The item.
14882 * @return The toolbar object.
14884 * This returns the toolbar object itself that an item belongs to.
14888 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14891 * Set the priority of a toolbar item.
14893 * @param item The toolbar item.
14894 * @param priority The item priority. The default is zero.
14896 * This is used only when the toolbar shrink mode is set to
14897 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
14898 * When space is less than required, items with low priority
14899 * will be removed from the toolbar and added to a dynamically-created menu,
14900 * while items with higher priority will remain on the toolbar,
14901 * with the same order they were added.
14903 * @see elm_toolbar_item_priority_get()
14907 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
14910 * Get the priority of a toolbar item.
14912 * @param item The toolbar item.
14913 * @return The @p item priority, or @c 0 on failure.
14915 * @see elm_toolbar_item_priority_set() for details.
14919 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14922 * Get the label of item.
14924 * @param item The item of toolbar.
14925 * @return The label of item.
14927 * The return value is a pointer to the label associated to @p item when
14928 * it was created, with function elm_toolbar_item_append() or similar,
14930 * with function elm_toolbar_item_label_set. If no label
14931 * was passed as argument, it will return @c NULL.
14933 * @see elm_toolbar_item_label_set() for more details.
14934 * @see elm_toolbar_item_append()
14938 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14941 * Set the label of item.
14943 * @param item The item of toolbar.
14944 * @param text The label of item.
14946 * The label to be displayed by the item.
14947 * Label will be placed at icons bottom (if set).
14949 * If a label was passed as argument on item creation, with function
14950 * elm_toolbar_item_append() or similar, it will be already
14951 * displayed by the item.
14953 * @see elm_toolbar_item_label_get()
14954 * @see elm_toolbar_item_append()
14958 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
14961 * Return the data associated with a given toolbar widget item.
14963 * @param item The toolbar widget item handle.
14964 * @return The data associated with @p item.
14966 * @see elm_toolbar_item_data_set()
14970 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14973 * Set the data associated with a given toolbar widget item.
14975 * @param item The toolbar widget item handle.
14976 * @param data The new data pointer to set to @p item.
14978 * This sets new item data on @p item.
14980 * @warning The old data pointer won't be touched by this function, so
14981 * the user had better to free that old data himself/herself.
14985 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
14988 * Returns a pointer to a toolbar item by its label.
14990 * @param obj The toolbar object.
14991 * @param label The label of the item to find.
14993 * @return The pointer to the toolbar item matching @p label or @c NULL
14998 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
15001 * Get whether the @p item is selected or not.
15003 * @param item The toolbar item.
15004 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
15005 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
15007 * @see elm_toolbar_selected_item_set() for details.
15008 * @see elm_toolbar_item_selected_get()
15012 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15015 * Set the selected state of an item.
15017 * @param item The toolbar item
15018 * @param selected The selected state
15020 * This sets the selected state of the given item @p it.
15021 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
15023 * If a new item is selected the previosly selected will be unselected.
15024 * Previoulsy selected item can be get with function
15025 * elm_toolbar_selected_item_get().
15027 * Selected items will be highlighted.
15029 * @see elm_toolbar_item_selected_get()
15030 * @see elm_toolbar_selected_item_get()
15034 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15037 * Get the selected item.
15039 * @param obj The toolbar object.
15040 * @return The selected toolbar item.
15042 * The selected item can be unselected with function
15043 * elm_toolbar_item_selected_set().
15045 * The selected item always will be highlighted on toolbar.
15047 * @see elm_toolbar_selected_items_get()
15051 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15054 * Set the icon associated with @p item.
15056 * @param obj The parent of this item.
15057 * @param item The toolbar item.
15058 * @param icon A string with icon name or the absolute path of an image file.
15060 * Toolbar will load icon image from fdo or current theme.
15061 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15062 * If an absolute path is provided it will load it direct from a file.
15064 * @see elm_toolbar_icon_order_lookup_set()
15065 * @see elm_toolbar_icon_order_lookup_get()
15069 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
15072 * Get the string used to set the icon of @p item.
15074 * @param item The toolbar item.
15075 * @return The string associated with the icon object.
15077 * @see elm_toolbar_item_icon_set() for details.
15081 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15084 * Get the object of @p item.
15086 * @param item The toolbar item.
15087 * @return The object
15091 EAPI Evas_Object *elm_toolbar_item_object_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15094 * Get the icon object of @p item.
15096 * @param item The toolbar item.
15097 * @return The icon object
15099 * @see elm_toolbar_item_icon_set() or elm_toolbar_item_icon_memfile_set() for details.
15103 EAPI Evas_Object *elm_toolbar_item_icon_object_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15106 * Set the icon associated with @p item to an image in a binary buffer.
15108 * @param item The toolbar item.
15109 * @param img The binary data that will be used as an image
15110 * @param size The size of binary data @p img
15111 * @param format Optional format of @p img to pass to the image loader
15112 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
15114 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
15116 * @note The icon image set by this function can be changed by
15117 * elm_toolbar_item_icon_set().
15121 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);
15124 * Delete them item from the toolbar.
15126 * @param item The item of toolbar to be deleted.
15128 * @see elm_toolbar_item_append()
15129 * @see elm_toolbar_item_del_cb_set()
15133 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15136 * Set the function called when a toolbar item is freed.
15138 * @param item The item to set the callback on.
15139 * @param func The function called.
15141 * If there is a @p func, then it will be called prior item's memory release.
15142 * That will be called with the following arguments:
15144 * @li item's Evas object;
15147 * This way, a data associated to a toolbar item could be properly freed.
15151 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15154 * Get a value whether toolbar item is disabled or not.
15156 * @param item The item.
15157 * @return The disabled state.
15159 * @see elm_toolbar_item_disabled_set() for more details.
15163 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15166 * Sets the disabled/enabled state of a toolbar item.
15168 * @param item The item.
15169 * @param disabled The disabled state.
15171 * A disabled item cannot be selected or unselected. It will also
15172 * change its appearance (generally greyed out). This sets the
15173 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
15178 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15181 * Set or unset item as a separator.
15183 * @param item The toolbar item.
15184 * @param setting @c EINA_TRUE to set item @p item as separator or
15185 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
15187 * Items aren't set as separator by default.
15189 * If set as separator it will display separator theme, so won't display
15192 * @see elm_toolbar_item_separator_get()
15196 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
15199 * Get a value whether item is a separator or not.
15201 * @param item The toolbar item.
15202 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
15203 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
15205 * @see elm_toolbar_item_separator_set() for details.
15209 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15212 * Set the shrink state of toolbar @p obj.
15214 * @param obj The toolbar object.
15215 * @param shrink_mode Toolbar's items display behavior.
15217 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
15218 * but will enforce a minimun size so all the items will fit, won't scroll
15219 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
15220 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
15221 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
15225 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
15228 * Get the shrink mode of toolbar @p obj.
15230 * @param obj The toolbar object.
15231 * @return Toolbar's items display behavior.
15233 * @see elm_toolbar_mode_shrink_set() for details.
15237 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15240 * Enable/disable homogenous mode.
15242 * @param obj The toolbar object
15243 * @param homogeneous Assume the items within the toolbar are of the
15244 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15246 * This will enable the homogeneous mode where items are of the same size.
15247 * @see elm_toolbar_homogeneous_get()
15251 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
15254 * Get whether the homogenous mode is enabled.
15256 * @param obj The toolbar object.
15257 * @return Assume the items within the toolbar are of the same height
15258 * and width (EINA_TRUE = on, EINA_FALSE = off).
15260 * @see elm_toolbar_homogeneous_set()
15264 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15267 * Enable/disable homogenous mode.
15269 * @param obj The toolbar object
15270 * @param homogeneous Assume the items within the toolbar are of the
15271 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15273 * This will enable the homogeneous mode where items are of the same size.
15274 * @see elm_toolbar_homogeneous_get()
15276 * @deprecated use elm_toolbar_homogeneous_set() instead.
15280 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
15283 * Get whether the homogenous mode is enabled.
15285 * @param obj The toolbar object.
15286 * @return Assume the items within the toolbar are of the same height
15287 * and width (EINA_TRUE = on, EINA_FALSE = off).
15289 * @see elm_toolbar_homogeneous_set()
15290 * @deprecated use elm_toolbar_homogeneous_get() instead.
15294 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15297 * Set the parent object of the toolbar items' menus.
15299 * @param obj The toolbar object.
15300 * @param parent The parent of the menu objects.
15302 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
15304 * For more details about setting the parent for toolbar menus, see
15305 * elm_menu_parent_set().
15307 * @see elm_menu_parent_set() for details.
15308 * @see elm_toolbar_item_menu_set() for details.
15312 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15315 * Get the parent object of the toolbar items' menus.
15317 * @param obj The toolbar object.
15318 * @return The parent of the menu objects.
15320 * @see elm_toolbar_menu_parent_set() for details.
15324 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15327 * Set the alignment of the items.
15329 * @param obj The toolbar object.
15330 * @param align The new alignment, a float between <tt> 0.0 </tt>
15331 * and <tt> 1.0 </tt>.
15333 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
15334 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
15337 * Centered items by default.
15339 * @see elm_toolbar_align_get()
15343 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
15346 * Get the alignment of the items.
15348 * @param obj The toolbar object.
15349 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
15352 * @see elm_toolbar_align_set() for details.
15356 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15359 * Set whether the toolbar item opens a menu.
15361 * @param item The toolbar item.
15362 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
15364 * A toolbar item can be set to be a menu, using this function.
15366 * Once it is set to be a menu, it can be manipulated through the
15367 * menu-like function elm_toolbar_menu_parent_set() and the other
15368 * elm_menu functions, using the Evas_Object @c menu returned by
15369 * elm_toolbar_item_menu_get().
15371 * So, items to be displayed in this item's menu should be added with
15372 * elm_menu_item_add().
15374 * The following code exemplifies the most basic usage:
15376 * tb = elm_toolbar_add(win)
15377 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
15378 * elm_toolbar_item_menu_set(item, EINA_TRUE);
15379 * elm_toolbar_menu_parent_set(tb, win);
15380 * menu = elm_toolbar_item_menu_get(item);
15381 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
15382 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
15386 * @see elm_toolbar_item_menu_get()
15390 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
15393 * Get toolbar item's menu.
15395 * @param item The toolbar item.
15396 * @return Item's menu object or @c NULL on failure.
15398 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
15399 * this function will set it.
15401 * @see elm_toolbar_item_menu_set() for details.
15405 EAPI Evas_Object *elm_toolbar_item_menu_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15408 * Add a new state to @p item.
15410 * @param item The item.
15411 * @param icon A string with icon name or the absolute path of an image file.
15412 * @param label The label of the new state.
15413 * @param func The function to call when the item is clicked when this
15414 * state is selected.
15415 * @param data The data to associate with the state.
15416 * @return The toolbar item state, or @c NULL upon failure.
15418 * Toolbar will load icon image from fdo or current theme.
15419 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15420 * If an absolute path is provided it will load it direct from a file.
15422 * States created with this function can be removed with
15423 * elm_toolbar_item_state_del().
15425 * @see elm_toolbar_item_state_del()
15426 * @see elm_toolbar_item_state_sel()
15427 * @see elm_toolbar_item_state_get()
15431 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);
15434 * Delete a previoulsy added state to @p item.
15436 * @param item The toolbar item.
15437 * @param state The state to be deleted.
15438 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15440 * @see elm_toolbar_item_state_add()
15442 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15445 * Set @p state as the current state of @p it.
15447 * @param it The item.
15448 * @param state The state to use.
15449 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15451 * If @p state is @c NULL, it won't select any state and the default item's
15452 * icon and label will be used. It's the same behaviour than
15453 * elm_toolbar_item_state_unser().
15455 * @see elm_toolbar_item_state_unset()
15459 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15462 * Unset the state of @p it.
15464 * @param it The item.
15466 * The default icon and label from this item will be displayed.
15468 * @see elm_toolbar_item_state_set() for more details.
15472 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15475 * Get the current state of @p it.
15477 * @param item The item.
15478 * @return The selected state or @c NULL if none is selected or on failure.
15480 * @see elm_toolbar_item_state_set() for details.
15481 * @see elm_toolbar_item_state_unset()
15482 * @see elm_toolbar_item_state_add()
15486 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15489 * Get the state after selected state in toolbar's @p item.
15491 * @param it The toolbar item to change state.
15492 * @return The state after current state, or @c NULL on failure.
15494 * If last state is selected, this function will return first state.
15496 * @see elm_toolbar_item_state_set()
15497 * @see elm_toolbar_item_state_add()
15501 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15504 * Get the state before selected state in toolbar's @p item.
15506 * @param it The toolbar item to change state.
15507 * @return The state before current state, or @c NULL on failure.
15509 * If first state is selected, this function will return last state.
15511 * @see elm_toolbar_item_state_set()
15512 * @see elm_toolbar_item_state_add()
15516 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15519 * Set the text to be shown in a given toolbar item's tooltips.
15521 * @param item Target item.
15522 * @param text The text to set in the content.
15524 * Setup the text as tooltip to object. The item can have only one tooltip,
15525 * so any previous tooltip data - set with this function or
15526 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
15528 * @see elm_object_tooltip_text_set() for more details.
15532 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
15535 * Set the content to be shown in the tooltip item.
15537 * Setup the tooltip to item. The item can have only one tooltip,
15538 * so any previous tooltip data is removed. @p func(with @p data) will
15539 * be called every time that need show the tooltip and it should
15540 * return a valid Evas_Object. This object is then managed fully by
15541 * tooltip system and is deleted when the tooltip is gone.
15543 * @param item the toolbar item being attached a tooltip.
15544 * @param func the function used to create the tooltip contents.
15545 * @param data what to provide to @a func as callback data/context.
15546 * @param del_cb called when data is not needed anymore, either when
15547 * another callback replaces @a func, the tooltip is unset with
15548 * elm_toolbar_item_tooltip_unset() or the owner @a item
15549 * dies. This callback receives as the first parameter the
15550 * given @a data, and @c event_info is the item.
15552 * @see elm_object_tooltip_content_cb_set() for more details.
15556 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);
15559 * Unset tooltip from item.
15561 * @param item toolbar item to remove previously set tooltip.
15563 * Remove tooltip from item. The callback provided as del_cb to
15564 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
15565 * it is not used anymore.
15567 * @see elm_object_tooltip_unset() for more details.
15568 * @see elm_toolbar_item_tooltip_content_cb_set()
15572 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15575 * Sets a different style for this item tooltip.
15577 * @note before you set a style you should define a tooltip with
15578 * elm_toolbar_item_tooltip_content_cb_set() or
15579 * elm_toolbar_item_tooltip_text_set()
15581 * @param item toolbar item with tooltip already set.
15582 * @param style the theme style to use (default, transparent, ...)
15584 * @see elm_object_tooltip_style_set() for more details.
15588 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15591 * Get the style for this item tooltip.
15593 * @param item toolbar item with tooltip already set.
15594 * @return style the theme style in use, defaults to "default". If the
15595 * object does not have a tooltip set, then NULL is returned.
15597 * @see elm_object_tooltip_style_get() for more details.
15598 * @see elm_toolbar_item_tooltip_style_set()
15602 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15605 * Set the type of mouse pointer/cursor decoration to be shown,
15606 * when the mouse pointer is over the given toolbar widget item
15608 * @param item toolbar item to customize cursor on
15609 * @param cursor the cursor type's name
15611 * This function works analogously as elm_object_cursor_set(), but
15612 * here the cursor's changing area is restricted to the item's
15613 * area, and not the whole widget's. Note that that item cursors
15614 * have precedence over widget cursors, so that a mouse over an
15615 * item with custom cursor set will always show @b that cursor.
15617 * If this function is called twice for an object, a previously set
15618 * cursor will be unset on the second call.
15620 * @see elm_object_cursor_set()
15621 * @see elm_toolbar_item_cursor_get()
15622 * @see elm_toolbar_item_cursor_unset()
15626 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15629 * Get the type of mouse pointer/cursor decoration set to be shown,
15630 * when the mouse pointer is over the given toolbar widget item
15632 * @param item toolbar item with custom cursor set
15633 * @return the cursor type's name or @c NULL, if no custom cursors
15634 * were set to @p item (and on errors)
15636 * @see elm_object_cursor_get()
15637 * @see elm_toolbar_item_cursor_set()
15638 * @see elm_toolbar_item_cursor_unset()
15642 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15645 * Unset any custom mouse pointer/cursor decoration set to be
15646 * shown, when the mouse pointer is over the given toolbar widget
15647 * item, thus making it show the @b default cursor again.
15649 * @param item a toolbar item
15651 * Use this call to undo any custom settings on this item's cursor
15652 * decoration, bringing it back to defaults (no custom style set).
15654 * @see elm_object_cursor_unset()
15655 * @see elm_toolbar_item_cursor_set()
15659 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15662 * Set a different @b style for a given custom cursor set for a
15665 * @param item toolbar item with custom cursor set
15666 * @param style the <b>theme style</b> to use (e.g. @c "default",
15667 * @c "transparent", etc)
15669 * This function only makes sense when one is using custom mouse
15670 * cursor decorations <b>defined in a theme file</b>, which can have,
15671 * given a cursor name/type, <b>alternate styles</b> on it. It
15672 * works analogously as elm_object_cursor_style_set(), but here
15673 * applyed only to toolbar item objects.
15675 * @warning Before you set a cursor style you should have definen a
15676 * custom cursor previously on the item, with
15677 * elm_toolbar_item_cursor_set()
15679 * @see elm_toolbar_item_cursor_engine_only_set()
15680 * @see elm_toolbar_item_cursor_style_get()
15684 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15687 * Get the current @b style set for a given toolbar item's custom
15690 * @param item toolbar item with custom cursor set.
15691 * @return style the cursor style in use. If the object does not
15692 * have a cursor set, then @c NULL is returned.
15694 * @see elm_toolbar_item_cursor_style_set() for more details
15698 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15701 * Set if the (custom)cursor for a given toolbar item should be
15702 * searched in its theme, also, or should only rely on the
15703 * rendering engine.
15705 * @param item item with custom (custom) cursor already set on
15706 * @param engine_only Use @c EINA_TRUE to have cursors looked for
15707 * only on those provided by the rendering engine, @c EINA_FALSE to
15708 * have them searched on the widget's theme, as well.
15710 * @note This call is of use only if you've set a custom cursor
15711 * for toolbar items, with elm_toolbar_item_cursor_set().
15713 * @note By default, cursors will only be looked for between those
15714 * provided by the rendering engine.
15718 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15721 * Get if the (custom) cursor for a given toolbar item is being
15722 * searched in its theme, also, or is only relying on the rendering
15725 * @param item a toolbar item
15726 * @return @c EINA_TRUE, if cursors are being looked for only on
15727 * those provided by the rendering engine, @c EINA_FALSE if they
15728 * are being searched on the widget's theme, as well.
15730 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
15734 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15737 * Change a toolbar's orientation
15738 * @param obj The toolbar object
15739 * @param vertical If @c EINA_TRUE, the toolbar is vertical
15740 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15742 * @deprecated use elm_toolbar_horizontal_set() instead.
15744 EINA_DEPRECATED EAPI void elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
15747 * Change a toolbar's orientation
15748 * @param obj The toolbar object
15749 * @param horizontal If @c EINA_TRUE, the toolbar is horizontal
15750 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15753 EAPI void elm_toolbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15756 * Get a toolbar's orientation
15757 * @param obj The toolbar object
15758 * @return If @c EINA_TRUE, the toolbar is vertical
15759 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15761 * @deprecated use elm_toolbar_horizontal_get() instead.
15763 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_orientation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15766 * Get a toolbar's orientation
15767 * @param obj The toolbar object
15768 * @return If @c EINA_TRUE, the toolbar is horizontal
15769 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15772 EAPI Eina_Bool elm_toolbar_horizontal_get(const Evas_Object *obj);
15778 * @defgroup Tooltips Tooltips
15780 * The Tooltip is an (internal, for now) smart object used to show a
15781 * content in a frame on mouse hover of objects(or widgets), with
15782 * tips/information about them.
15787 EAPI double elm_tooltip_delay_get(void);
15788 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
15789 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
15790 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
15791 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
15792 EAPI void elm_object_tooltip_domain_translatable_text_set(Evas_Object *obj, const char *domain, const char *text) EINA_ARG_NONNULL(1, 3);
15793 #define elm_object_tooltip_translatable_text_set(obj, text) elm_object_tooltip_domain_translatable_text_set((obj), NULL, (text))
15794 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);
15795 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15796 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15797 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15798 EAPI Eina_Bool elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
15799 EAPI Eina_Bool elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15806 * @defgroup Cursors Cursors
15808 * The Elementary cursor is an internal smart object used to
15809 * customize the mouse cursor displayed over objects (or
15810 * widgets). In the most common scenario, the cursor decoration
15811 * comes from the graphical @b engine Elementary is running
15812 * on. Those engines may provide different decorations for cursors,
15813 * and Elementary provides functions to choose them (think of X11
15814 * cursors, as an example).
15816 * There's also the possibility of, besides using engine provided
15817 * cursors, also use ones coming from Edje theming files. Both
15818 * globally and per widget, Elementary makes it possible for one to
15819 * make the cursors lookup to be held on engines only or on
15820 * Elementary's theme file, too. To set cursor's hot spot,
15821 * two data items should be added to cursor's theme: "hot_x" and
15822 * "hot_y", that are the offset from upper-left corner of the cursor
15823 * (coordinates 0,0).
15829 * Set the cursor to be shown when mouse is over the object
15831 * Set the cursor that will be displayed when mouse is over the
15832 * object. The object can have only one cursor set to it, so if
15833 * this function is called twice for an object, the previous set
15835 * If using X cursors, a definition of all the valid cursor names
15836 * is listed on Elementary_Cursors.h. If an invalid name is set
15837 * the default cursor will be used.
15839 * @param obj the object being set a cursor.
15840 * @param cursor the cursor name to be used.
15844 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
15847 * Get the cursor to be shown when mouse is over the object
15849 * @param obj an object with cursor already set.
15850 * @return the cursor name.
15854 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15857 * Unset cursor for object
15859 * Unset cursor for object, and set the cursor to default if the mouse
15860 * was over this object.
15862 * @param obj Target object
15863 * @see elm_object_cursor_set()
15867 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15870 * Sets a different style for this object cursor.
15872 * @note before you set a style you should define a cursor with
15873 * elm_object_cursor_set()
15875 * @param obj an object with cursor already set.
15876 * @param style the theme style to use (default, transparent, ...)
15880 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15883 * Get the style for this object cursor.
15885 * @param obj an object with cursor already set.
15886 * @return style the theme style in use, defaults to "default". If the
15887 * object does not have a cursor set, then NULL is returned.
15891 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15894 * Set if the cursor set should be searched on the theme or should use
15895 * the provided by the engine, only.
15897 * @note before you set if should look on theme you should define a cursor
15898 * with elm_object_cursor_set(). By default it will only look for cursors
15899 * provided by the engine.
15901 * @param obj an object with cursor already set.
15902 * @param engine_only boolean to define it cursors should be looked only
15903 * between the provided by the engine or searched on widget's theme as well.
15907 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15910 * Get the cursor engine only usage for this object cursor.
15912 * @param obj an object with cursor already set.
15913 * @return engine_only boolean to define it cursors should be
15914 * looked only between the provided by the engine or searched on
15915 * widget's theme as well. If the object does not have a cursor
15916 * set, then EINA_FALSE is returned.
15920 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15923 * Get the configured cursor engine only usage
15925 * This gets the globally configured exclusive usage of engine cursors.
15927 * @return 1 if only engine cursors should be used
15930 EAPI int elm_cursor_engine_only_get(void);
15933 * Set the configured cursor engine only usage
15935 * This sets the globally configured exclusive usage of engine cursors.
15936 * It won't affect cursors set before changing this value.
15938 * @param engine_only If 1 only engine cursors will be enabled, if 0 will
15939 * look for them on theme before.
15940 * @return EINA_TRUE if value is valid and setted (0 or 1)
15943 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
15950 * @defgroup Menu Menu
15952 * @image html img/widget/menu/preview-00.png
15953 * @image latex img/widget/menu/preview-00.eps
15955 * A menu is a list of items displayed above its parent. When the menu is
15956 * showing its parent is darkened. Each item can have a sub-menu. The menu
15957 * object can be used to display a menu on a right click event, in a toolbar,
15960 * Signals that you can add callbacks for are:
15961 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
15962 * event_info is NULL.
15964 * @see @ref tutorial_menu
15967 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
15969 * @brief Add a new menu to the parent
15971 * @param parent The parent object.
15972 * @return The new object or NULL if it cannot be created.
15974 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15976 * @brief Set the parent for the given menu widget
15978 * @param obj The menu object.
15979 * @param parent The new parent.
15981 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15983 * @brief Get the parent for the given menu widget
15985 * @param obj The menu object.
15986 * @return The parent.
15988 * @see elm_menu_parent_set()
15990 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15992 * @brief Move the menu to a new position
15994 * @param obj The menu object.
15995 * @param x The new position.
15996 * @param y The new position.
15998 * Sets the top-left position of the menu to (@p x,@p y).
16000 * @note @p x and @p y coordinates are relative to parent.
16002 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
16004 * @brief Close a opened menu
16006 * @param obj the menu object
16009 * Hides the menu and all it's sub-menus.
16011 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
16013 * @brief Returns a list of @p item's items.
16015 * @param obj The menu object
16016 * @return An Eina_List* of @p item's items
16018 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16020 * @brief Get the Evas_Object of an Elm_Menu_Item
16022 * @param item The menu item object.
16023 * @return The edje object containing the swallowed content
16025 * @warning Don't manipulate this object!
16027 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16029 * @brief Add an item at the end of the given menu widget
16031 * @param obj The menu object.
16032 * @param parent The parent menu item (optional)
16033 * @param icon A icon display on the item. The icon will be destryed by the menu.
16034 * @param label The label of the item.
16035 * @param func Function called when the user select the item.
16036 * @param data Data sent by the callback.
16037 * @return Returns the new item.
16039 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);
16041 * @brief Add an object swallowed in an item at the end of the given menu
16044 * @param obj The menu object.
16045 * @param parent The parent menu item (optional)
16046 * @param subobj The object to swallow
16047 * @param func Function called when the user select the item.
16048 * @param data Data sent by the callback.
16049 * @return Returns the new item.
16051 * Add an evas object as an item to the menu.
16053 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);
16055 * @brief Set the label of a menu item
16057 * @param item The menu item object.
16058 * @param label The label to set for @p item
16060 * @warning Don't use this funcion on items created with
16061 * elm_menu_item_add_object() or elm_menu_item_separator_add().
16063 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
16065 * @brief Get the label of a menu item
16067 * @param item The menu item object.
16068 * @return The label of @p item
16070 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16072 * @brief Set the icon of a menu item to the standard icon with name @p icon
16074 * @param item The menu item object.
16075 * @param icon The icon object to set for the content of @p item
16077 * Once this icon is set, any previously set icon will be deleted.
16079 EAPI void elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
16081 * @brief Get the string representation from the icon of a menu item
16083 * @param item The menu item object.
16084 * @return The string representation of @p item's icon or NULL
16086 * @see elm_menu_item_object_icon_name_set()
16088 EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16090 * @brief Set the content object of a menu item
16092 * @param item The menu item object
16093 * @param The content object or NULL
16094 * @return EINA_TRUE on success, else EINA_FALSE
16096 * Use this function to change the object swallowed by a menu item, deleting
16097 * any previously swallowed object.
16099 EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
16101 * @brief Get the content object of a menu item
16103 * @param item The menu item object
16104 * @return The content object or NULL
16105 * @note If @p item was added with elm_menu_item_add_object, this
16106 * function will return the object passed, else it will return the
16109 * @see elm_menu_item_object_content_set()
16111 EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16113 * @brief Set the selected state of @p item.
16115 * @param item The menu item object.
16116 * @param selected The selected/unselected state of the item
16118 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16120 * @brief Get the selected state of @p item.
16122 * @param item The menu item object.
16123 * @return The selected/unselected state of the item
16125 * @see elm_menu_item_selected_set()
16127 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16129 * @brief Set the disabled state of @p item.
16131 * @param item The menu item object.
16132 * @param disabled The enabled/disabled state of the item
16134 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
16136 * @brief Get the disabled state of @p item.
16138 * @param item The menu item object.
16139 * @return The enabled/disabled state of the item
16141 * @see elm_menu_item_disabled_set()
16143 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16145 * @brief Add a separator item to menu @p obj under @p parent.
16147 * @param obj The menu object
16148 * @param parent The item to add the separator under
16149 * @return The created item or NULL on failure
16151 * This is item is a @ref Separator.
16153 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
16155 * @brief Returns whether @p item is a separator.
16157 * @param item The item to check
16158 * @return If true, @p item is a separator
16160 * @see elm_menu_item_separator_add()
16162 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16164 * @brief Deletes an item from the menu.
16166 * @param item The item to delete.
16168 * @see elm_menu_item_add()
16170 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16172 * @brief Set the function called when a menu item is deleted.
16174 * @param item The item to set the callback on
16175 * @param func The function called
16177 * @see elm_menu_item_add()
16178 * @see elm_menu_item_del()
16180 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16182 * @brief Returns the data associated with menu item @p item.
16184 * @param item The item
16185 * @return The data associated with @p item or NULL if none was set.
16187 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
16189 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16191 * @brief Sets the data to be associated with menu item @p item.
16193 * @param item The item
16194 * @param data The data to be associated with @p item
16196 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
16198 * @brief Returns a list of @p item's subitems.
16200 * @param item The item
16201 * @return An Eina_List* of @p item's subitems
16203 * @see elm_menu_add()
16205 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16207 * @brief Get the position of a menu item
16209 * @param item The menu item
16210 * @return The item's index
16212 * This function returns the index position of a menu item in a menu.
16213 * For a sub-menu, this number is relative to the first item in the sub-menu.
16215 * @note Index values begin with 0
16217 EAPI unsigned int elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
16219 * @brief @brief Return a menu item's owner menu
16221 * @param item The menu item
16222 * @return The menu object owning @p item, or NULL on failure
16224 * Use this function to get the menu object owning an item.
16226 EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
16228 * @brief Get the selected item in the menu
16230 * @param obj The menu object
16231 * @return The selected item, or NULL if none
16233 * @see elm_menu_item_selected_get()
16234 * @see elm_menu_item_selected_set()
16236 EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16238 * @brief Get the last item in the menu
16240 * @param obj The menu object
16241 * @return The last item, or NULL if none
16243 EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16245 * @brief Get the first item in the menu
16247 * @param obj The menu object
16248 * @return The first item, or NULL if none
16250 EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16252 * @brief Get the next item in the menu.
16254 * @param item The menu item object.
16255 * @return The item after it, or NULL if none
16257 EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16259 * @brief Get the previous item in the menu.
16261 * @param item The menu item object.
16262 * @return The item before it, or NULL if none
16264 EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16270 * @defgroup List List
16271 * @ingroup Elementary
16273 * @image html img/widget/list/preview-00.png
16274 * @image latex img/widget/list/preview-00.eps width=\textwidth
16276 * @image html img/list.png
16277 * @image latex img/list.eps width=\textwidth
16279 * A list widget is a container whose children are displayed vertically or
16280 * horizontally, in order, and can be selected.
16281 * The list can accept only one or multiple items selection. Also has many
16282 * modes of items displaying.
16284 * A list is a very simple type of list widget. For more robust
16285 * lists, @ref Genlist should probably be used.
16287 * Smart callbacks one can listen to:
16288 * - @c "activated" - The user has double-clicked or pressed
16289 * (enter|return|spacebar) on an item. The @c event_info parameter
16290 * is the item that was activated.
16291 * - @c "clicked,double" - The user has double-clicked an item.
16292 * The @c event_info parameter is the item that was double-clicked.
16293 * - "selected" - when the user selected an item
16294 * - "unselected" - when the user unselected an item
16295 * - "longpressed" - an item in the list is long-pressed
16296 * - "edge,top" - the list is scrolled until the top edge
16297 * - "edge,bottom" - the list is scrolled until the bottom edge
16298 * - "edge,left" - the list is scrolled until the left edge
16299 * - "edge,right" - the list is scrolled until the right edge
16300 * - "language,changed" - the program's language changed
16302 * Available styles for it:
16305 * List of examples:
16306 * @li @ref list_example_01
16307 * @li @ref list_example_02
16308 * @li @ref list_example_03
16317 * @enum _Elm_List_Mode
16318 * @typedef Elm_List_Mode
16320 * Set list's resize behavior, transverse axis scroll and
16321 * items cropping. See each mode's description for more details.
16323 * @note Default value is #ELM_LIST_SCROLL.
16325 * Values <b> don't </b> work as bitmask, only one can be choosen.
16327 * @see elm_list_mode_set()
16328 * @see elm_list_mode_get()
16332 typedef enum _Elm_List_Mode
16334 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. */
16335 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). */
16336 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. */
16337 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. */
16338 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
16341 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(). */
16344 * Add a new list widget to the given parent Elementary
16345 * (container) object.
16347 * @param parent The parent object.
16348 * @return a new list widget handle or @c NULL, on errors.
16350 * This function inserts a new list widget on the canvas.
16354 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16359 * @param obj The list object
16361 * @note Call before running show() on the list object.
16362 * @warning If not called, it won't display the list properly.
16365 * li = elm_list_add(win);
16366 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
16367 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
16369 * evas_object_show(li);
16374 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
16377 * Enable or disable multiple items selection on the list object.
16379 * @param obj The list object
16380 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
16383 * Disabled by default. If disabled, the user can select a single item of
16384 * the list each time. Selected items are highlighted on list.
16385 * If enabled, many items can be selected.
16387 * If a selected item is selected again, it will be unselected.
16389 * @see elm_list_multi_select_get()
16393 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
16396 * Get a value whether multiple items selection is enabled or not.
16398 * @see elm_list_multi_select_set() for details.
16400 * @param obj The list object.
16401 * @return @c EINA_TRUE means multiple items selection is enabled.
16402 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16403 * @c EINA_FALSE is returned.
16407 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16410 * Set which mode to use for the list object.
16412 * @param obj The list object
16413 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16414 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
16416 * Set list's resize behavior, transverse axis scroll and
16417 * items cropping. See each mode's description for more details.
16419 * @note Default value is #ELM_LIST_SCROLL.
16421 * Only one can be set, if a previous one was set, it will be changed
16422 * by the new mode set. Bitmask won't work as well.
16424 * @see elm_list_mode_get()
16428 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16431 * Get the mode the list is at.
16433 * @param obj The list object
16434 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16435 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
16437 * @note see elm_list_mode_set() for more information.
16441 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16444 * Enable or disable horizontal mode on the list object.
16446 * @param obj The list object.
16447 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
16448 * disable it, i.e., to enable vertical mode.
16450 * @note Vertical mode is set by default.
16452 * On horizontal mode items are displayed on list from left to right,
16453 * instead of from top to bottom. Also, the list will scroll horizontally.
16454 * Each item will presents left icon on top and right icon, or end, at
16457 * @see elm_list_horizontal_get()
16461 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16464 * Get a value whether horizontal mode is enabled or not.
16466 * @param obj The list object.
16467 * @return @c EINA_TRUE means horizontal mode selection is enabled.
16468 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16469 * @c EINA_FALSE is returned.
16471 * @see elm_list_horizontal_set() for details.
16475 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16478 * Enable or disable always select mode on the list object.
16480 * @param obj The list object
16481 * @param always_select @c EINA_TRUE to enable always select mode or
16482 * @c EINA_FALSE to disable it.
16484 * @note Always select mode is disabled by default.
16486 * Default behavior of list items is to only call its callback function
16487 * the first time it's pressed, i.e., when it is selected. If a selected
16488 * item is pressed again, and multi-select is disabled, it won't call
16489 * this function (if multi-select is enabled it will unselect the item).
16491 * If always select is enabled, it will call the callback function
16492 * everytime a item is pressed, so it will call when the item is selected,
16493 * and again when a selected item is pressed.
16495 * @see elm_list_always_select_mode_get()
16496 * @see elm_list_multi_select_set()
16500 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16503 * Get a value whether always select mode is enabled or not, meaning that
16504 * an item will always call its callback function, even if already selected.
16506 * @param obj The list object
16507 * @return @c EINA_TRUE means horizontal mode selection is enabled.
16508 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16509 * @c EINA_FALSE is returned.
16511 * @see elm_list_always_select_mode_set() for details.
16515 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16518 * Set bouncing behaviour when the scrolled content reaches an edge.
16520 * Tell the internal scroller object whether it should bounce or not
16521 * when it reaches the respective edges for each axis.
16523 * @param obj The list object
16524 * @param h_bounce Whether to bounce or not in the horizontal axis.
16525 * @param v_bounce Whether to bounce or not in the vertical axis.
16527 * @see elm_scroller_bounce_set()
16531 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
16534 * Get the bouncing behaviour of the internal scroller.
16536 * Get whether the internal scroller should bounce when the edge of each
16537 * axis is reached scrolling.
16539 * @param obj The list object.
16540 * @param h_bounce Pointer where to store the bounce state of the horizontal
16542 * @param v_bounce Pointer where to store the bounce state of the vertical
16545 * @see elm_scroller_bounce_get()
16546 * @see elm_list_bounce_set()
16550 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
16553 * Set the scrollbar policy.
16555 * @param obj The list object
16556 * @param policy_h Horizontal scrollbar policy.
16557 * @param policy_v Vertical scrollbar policy.
16559 * This sets the scrollbar visibility policy for the given scroller.
16560 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
16561 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
16562 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
16563 * This applies respectively for the horizontal and vertical scrollbars.
16565 * The both are disabled by default, i.e., are set to
16566 * #ELM_SCROLLER_POLICY_OFF.
16570 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
16573 * Get the scrollbar policy.
16575 * @see elm_list_scroller_policy_get() for details.
16577 * @param obj The list object.
16578 * @param policy_h Pointer where to store horizontal scrollbar policy.
16579 * @param policy_v Pointer where to store vertical scrollbar policy.
16583 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);
16586 * Append a new item to the list object.
16588 * @param obj The list object.
16589 * @param label The label of the list item.
16590 * @param icon The icon object to use for the left side of the item. An
16591 * icon can be any Evas object, but usually it is an icon created
16592 * with elm_icon_add().
16593 * @param end The icon object to use for the right side of the item. An
16594 * icon can be any Evas object.
16595 * @param func The function to call when the item is clicked.
16596 * @param data The data to associate with the item for related callbacks.
16598 * @return The created item or @c NULL upon failure.
16600 * A new item will be created and appended to the list, i.e., will
16601 * be set as @b last item.
16603 * Items created with this method can be deleted with
16604 * elm_list_item_del().
16606 * Associated @p data can be properly freed when item is deleted if a
16607 * callback function is set with elm_list_item_del_cb_set().
16609 * If a function is passed as argument, it will be called everytime this item
16610 * is selected, i.e., the user clicks over an unselected item.
16611 * If always select is enabled it will call this function every time
16612 * user clicks over an item (already selected or not).
16613 * If such function isn't needed, just passing
16614 * @c NULL as @p func is enough. The same should be done for @p data.
16616 * Simple example (with no function callback or data associated):
16618 * li = elm_list_add(win);
16619 * ic = elm_icon_add(win);
16620 * elm_icon_file_set(ic, "path/to/image", NULL);
16621 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
16622 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
16624 * evas_object_show(li);
16627 * @see elm_list_always_select_mode_set()
16628 * @see elm_list_item_del()
16629 * @see elm_list_item_del_cb_set()
16630 * @see elm_list_clear()
16631 * @see elm_icon_add()
16635 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);
16638 * Prepend a new item to the list object.
16640 * @param obj The list object.
16641 * @param label The label of the list item.
16642 * @param icon The icon object to use for the left side of the item. An
16643 * icon can be any Evas object, but usually it is an icon created
16644 * with elm_icon_add().
16645 * @param end The icon object to use for the right side of the item. An
16646 * icon can be any Evas object.
16647 * @param func The function to call when the item is clicked.
16648 * @param data The data to associate with the item for related callbacks.
16650 * @return The created item or @c NULL upon failure.
16652 * A new item will be created and prepended to the list, i.e., will
16653 * be set as @b first item.
16655 * Items created with this method can be deleted with
16656 * elm_list_item_del().
16658 * Associated @p data can be properly freed when item is deleted if a
16659 * callback function is set with elm_list_item_del_cb_set().
16661 * If a function is passed as argument, it will be called everytime this item
16662 * is selected, i.e., the user clicks over an unselected item.
16663 * If always select is enabled it will call this function every time
16664 * user clicks over an item (already selected or not).
16665 * If such function isn't needed, just passing
16666 * @c NULL as @p func is enough. The same should be done for @p data.
16668 * @see elm_list_item_append() for a simple code example.
16669 * @see elm_list_always_select_mode_set()
16670 * @see elm_list_item_del()
16671 * @see elm_list_item_del_cb_set()
16672 * @see elm_list_clear()
16673 * @see elm_icon_add()
16677 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);
16680 * Insert a new item into the list object before item @p before.
16682 * @param obj The list object.
16683 * @param before The list item to insert before.
16684 * @param label The label of the list item.
16685 * @param icon The icon object to use for the left side of the item. An
16686 * icon can be any Evas object, but usually it is an icon created
16687 * with elm_icon_add().
16688 * @param end The icon object to use for the right side of the item. An
16689 * icon can be any Evas object.
16690 * @param func The function to call when the item is clicked.
16691 * @param data The data to associate with the item for related callbacks.
16693 * @return The created item or @c NULL upon failure.
16695 * A new item will be created and added to the list. Its position in
16696 * this list will be just before item @p before.
16698 * Items created with this method can be deleted with
16699 * elm_list_item_del().
16701 * Associated @p data can be properly freed when item is deleted if a
16702 * callback function is set with elm_list_item_del_cb_set().
16704 * If a function is passed as argument, it will be called everytime this item
16705 * is selected, i.e., the user clicks over an unselected item.
16706 * If always select is enabled it will call this function every time
16707 * user clicks over an item (already selected or not).
16708 * If such function isn't needed, just passing
16709 * @c NULL as @p func is enough. The same should be done for @p data.
16711 * @see elm_list_item_append() for a simple code example.
16712 * @see elm_list_always_select_mode_set()
16713 * @see elm_list_item_del()
16714 * @see elm_list_item_del_cb_set()
16715 * @see elm_list_clear()
16716 * @see elm_icon_add()
16720 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);
16723 * Insert a new item into the list object after item @p after.
16725 * @param obj The list object.
16726 * @param after The list item to insert after.
16727 * @param label The label of the list item.
16728 * @param icon The icon object to use for the left side of the item. An
16729 * icon can be any Evas object, but usually it is an icon created
16730 * with elm_icon_add().
16731 * @param end The icon object to use for the right side of the item. An
16732 * icon can be any Evas object.
16733 * @param func The function to call when the item is clicked.
16734 * @param data The data to associate with the item for related callbacks.
16736 * @return The created item or @c NULL upon failure.
16738 * A new item will be created and added to the list. Its position in
16739 * this list will be just after item @p after.
16741 * Items created with this method can be deleted with
16742 * elm_list_item_del().
16744 * Associated @p data can be properly freed when item is deleted if a
16745 * callback function is set with elm_list_item_del_cb_set().
16747 * If a function is passed as argument, it will be called everytime this item
16748 * is selected, i.e., the user clicks over an unselected item.
16749 * If always select is enabled it will call this function every time
16750 * user clicks over an item (already selected or not).
16751 * If such function isn't needed, just passing
16752 * @c NULL as @p func is enough. The same should be done for @p data.
16754 * @see elm_list_item_append() for a simple code example.
16755 * @see elm_list_always_select_mode_set()
16756 * @see elm_list_item_del()
16757 * @see elm_list_item_del_cb_set()
16758 * @see elm_list_clear()
16759 * @see elm_icon_add()
16763 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);
16766 * Insert a new item into the sorted list object.
16768 * @param obj The list object.
16769 * @param label The label of the list item.
16770 * @param icon The icon object to use for the left side of the item. An
16771 * icon can be any Evas object, but usually it is an icon created
16772 * with elm_icon_add().
16773 * @param end The icon object to use for the right side of the item. An
16774 * icon can be any Evas object.
16775 * @param func The function to call when the item is clicked.
16776 * @param data The data to associate with the item for related callbacks.
16777 * @param cmp_func The comparing function to be used to sort list
16778 * items <b>by #Elm_List_Item item handles</b>. This function will
16779 * receive two items and compare them, returning a non-negative integer
16780 * if the second item should be place after the first, or negative value
16781 * if should be placed before.
16783 * @return The created item or @c NULL upon failure.
16785 * @note This function inserts values into a list object assuming it was
16786 * sorted and the result will be sorted.
16788 * A new item will be created and added to the list. Its position in
16789 * this list will be found comparing the new item with previously inserted
16790 * items using function @p cmp_func.
16792 * Items created with this method can be deleted with
16793 * elm_list_item_del().
16795 * Associated @p data can be properly freed when item is deleted if a
16796 * callback function is set with elm_list_item_del_cb_set().
16798 * If a function is passed as argument, it will be called everytime this item
16799 * is selected, i.e., the user clicks over an unselected item.
16800 * If always select is enabled it will call this function every time
16801 * user clicks over an item (already selected or not).
16802 * If such function isn't needed, just passing
16803 * @c NULL as @p func is enough. The same should be done for @p data.
16805 * @see elm_list_item_append() for a simple code example.
16806 * @see elm_list_always_select_mode_set()
16807 * @see elm_list_item_del()
16808 * @see elm_list_item_del_cb_set()
16809 * @see elm_list_clear()
16810 * @see elm_icon_add()
16814 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);
16817 * Remove all list's items.
16819 * @param obj The list object
16821 * @see elm_list_item_del()
16822 * @see elm_list_item_append()
16826 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16829 * Get a list of all the list items.
16831 * @param obj The list object
16832 * @return An @c Eina_List of list items, #Elm_List_Item,
16833 * or @c NULL on failure.
16835 * @see elm_list_item_append()
16836 * @see elm_list_item_del()
16837 * @see elm_list_clear()
16841 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16844 * Get the selected item.
16846 * @param obj The list object.
16847 * @return The selected list item.
16849 * The selected item can be unselected with function
16850 * elm_list_item_selected_set().
16852 * The selected item always will be highlighted on list.
16854 * @see elm_list_selected_items_get()
16858 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16861 * Return a list of the currently selected list items.
16863 * @param obj The list object.
16864 * @return An @c Eina_List of list items, #Elm_List_Item,
16865 * or @c NULL on failure.
16867 * Multiple items can be selected if multi select is enabled. It can be
16868 * done with elm_list_multi_select_set().
16870 * @see elm_list_selected_item_get()
16871 * @see elm_list_multi_select_set()
16875 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16878 * Set the selected state of an item.
16880 * @param item The list item
16881 * @param selected The selected state
16883 * This sets the selected state of the given item @p it.
16884 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
16886 * If a new item is selected the previosly selected will be unselected,
16887 * unless multiple selection is enabled with elm_list_multi_select_set().
16888 * Previoulsy selected item can be get with function
16889 * elm_list_selected_item_get().
16891 * Selected items will be highlighted.
16893 * @see elm_list_item_selected_get()
16894 * @see elm_list_selected_item_get()
16895 * @see elm_list_multi_select_set()
16899 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16902 * Get whether the @p item is selected or not.
16904 * @param item The list item.
16905 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
16906 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
16908 * @see elm_list_selected_item_set() for details.
16909 * @see elm_list_item_selected_get()
16913 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16916 * Set or unset item as a separator.
16918 * @param it The list item.
16919 * @param setting @c EINA_TRUE to set item @p it as separator or
16920 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
16922 * Items aren't set as separator by default.
16924 * If set as separator it will display separator theme, so won't display
16927 * @see elm_list_item_separator_get()
16931 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
16934 * Get a value whether item is a separator or not.
16936 * @see elm_list_item_separator_set() for details.
16938 * @param it The list item.
16939 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
16940 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
16944 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16947 * Show @p item in the list view.
16949 * @param item The list item to be shown.
16951 * It won't animate list until item is visible. If such behavior is wanted,
16952 * use elm_list_bring_in() intead.
16956 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16959 * Bring in the given item to list view.
16961 * @param item The item.
16963 * This causes list to jump to the given item @p item and show it
16964 * (by scrolling), if it is not fully visible.
16966 * This may use animation to do so and take a period of time.
16968 * If animation isn't wanted, elm_list_item_show() can be used.
16972 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16975 * Delete them item from the list.
16977 * @param item The item of list to be deleted.
16979 * If deleting all list items is required, elm_list_clear()
16980 * should be used instead of getting items list and deleting each one.
16982 * @see elm_list_clear()
16983 * @see elm_list_item_append()
16984 * @see elm_list_item_del_cb_set()
16988 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16991 * Set the function called when a list item is freed.
16993 * @param item The item to set the callback on
16994 * @param func The function called
16996 * If there is a @p func, then it will be called prior item's memory release.
16997 * That will be called with the following arguments:
16999 * @li item's Evas object;
17002 * This way, a data associated to a list item could be properly freed.
17006 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
17009 * Get the data associated to the item.
17011 * @param item The list item
17012 * @return The data associated to @p item
17014 * The return value is a pointer to data associated to @p item when it was
17015 * created, with function elm_list_item_append() or similar. If no data
17016 * was passed as argument, it will return @c NULL.
17018 * @see elm_list_item_append()
17022 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17025 * Get the left side icon associated to the item.
17027 * @param item The list item
17028 * @return The left side icon associated to @p item
17030 * The return value is a pointer to the icon associated to @p item when
17032 * created, with function elm_list_item_append() or similar, or later
17033 * with function elm_list_item_icon_set(). If no icon
17034 * was passed as argument, it will return @c NULL.
17036 * @see elm_list_item_append()
17037 * @see elm_list_item_icon_set()
17041 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17044 * Set the left side icon associated to the item.
17046 * @param item The list item
17047 * @param icon The left side icon object to associate with @p item
17049 * The icon object to use at left side of the item. An
17050 * icon can be any Evas object, but usually it is an icon created
17051 * with elm_icon_add().
17053 * Once the icon object is set, a previously set one will be deleted.
17054 * @warning Setting the same icon for two items will cause the icon to
17055 * dissapear from the first item.
17057 * If an icon was passed as argument on item creation, with function
17058 * elm_list_item_append() or similar, it will be already
17059 * associated to the item.
17061 * @see elm_list_item_append()
17062 * @see elm_list_item_icon_get()
17066 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
17069 * Get the right side icon associated to the item.
17071 * @param item The list item
17072 * @return The right side icon associated to @p item
17074 * The return value is a pointer to the icon associated to @p item when
17076 * created, with function elm_list_item_append() or similar, or later
17077 * with function elm_list_item_icon_set(). If no icon
17078 * was passed as argument, it will return @c NULL.
17080 * @see elm_list_item_append()
17081 * @see elm_list_item_icon_set()
17085 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17088 * Set the right side icon associated to the item.
17090 * @param item The list item
17091 * @param end The right side icon object to associate with @p item
17093 * The icon object to use at right side of the item. An
17094 * icon can be any Evas object, but usually it is an icon created
17095 * with elm_icon_add().
17097 * Once the icon object is set, a previously set one will be deleted.
17098 * @warning Setting the same icon for two items will cause the icon to
17099 * dissapear from the first item.
17101 * If an icon was passed as argument on item creation, with function
17102 * elm_list_item_append() or similar, it will be already
17103 * associated to the item.
17105 * @see elm_list_item_append()
17106 * @see elm_list_item_end_get()
17110 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
17113 * Gets the base object of the item.
17115 * @param item The list item
17116 * @return The base object associated with @p item
17118 * Base object is the @c Evas_Object that represents that item.
17122 EAPI Evas_Object *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17123 EINA_DEPRECATED EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17126 * Get the label of item.
17128 * @param item The item of list.
17129 * @return The label of item.
17131 * The return value is a pointer to the label associated to @p item when
17132 * it was created, with function elm_list_item_append(), or later
17133 * with function elm_list_item_label_set. If no label
17134 * was passed as argument, it will return @c NULL.
17136 * @see elm_list_item_label_set() for more details.
17137 * @see elm_list_item_append()
17141 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17144 * Set the label of item.
17146 * @param item The item of list.
17147 * @param text The label of item.
17149 * The label to be displayed by the item.
17150 * Label will be placed between left and right side icons (if set).
17152 * If a label was passed as argument on item creation, with function
17153 * elm_list_item_append() or similar, it will be already
17154 * displayed by the item.
17156 * @see elm_list_item_label_get()
17157 * @see elm_list_item_append()
17161 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17165 * Get the item before @p it in list.
17167 * @param it The list item.
17168 * @return The item before @p it, or @c NULL if none or on failure.
17170 * @note If it is the first item, @c NULL will be returned.
17172 * @see elm_list_item_append()
17173 * @see elm_list_items_get()
17177 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17180 * Get the item after @p it in list.
17182 * @param it The list item.
17183 * @return The item after @p it, or @c NULL if none or on failure.
17185 * @note If it is the last item, @c NULL will be returned.
17187 * @see elm_list_item_append()
17188 * @see elm_list_items_get()
17192 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17195 * Sets the disabled/enabled state of a list item.
17197 * @param it The item.
17198 * @param disabled The disabled state.
17200 * A disabled item cannot be selected or unselected. It will also
17201 * change its appearance (generally greyed out). This sets the
17202 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
17207 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
17210 * Get a value whether list item is disabled or not.
17212 * @param it The item.
17213 * @return The disabled state.
17215 * @see elm_list_item_disabled_set() for more details.
17219 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17222 * Set the text to be shown in a given list item's tooltips.
17224 * @param item Target item.
17225 * @param text The text to set in the content.
17227 * Setup the text as tooltip to object. The item can have only one tooltip,
17228 * so any previous tooltip data - set with this function or
17229 * elm_list_item_tooltip_content_cb_set() - is removed.
17231 * @see elm_object_tooltip_text_set() for more details.
17235 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17239 * @brief Disable size restrictions on an object's tooltip
17240 * @param item The tooltip's anchor object
17241 * @param disable If EINA_TRUE, size restrictions are disabled
17242 * @return EINA_FALSE on failure, EINA_TRUE on success
17244 * This function allows a tooltip to expand beyond its parant window's canvas.
17245 * It will instead be limited only by the size of the display.
17247 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
17249 * @brief Retrieve size restriction state of an object's tooltip
17250 * @param obj The tooltip's anchor object
17251 * @return If EINA_TRUE, size restrictions are disabled
17253 * This function returns whether a tooltip is allowed to expand beyond
17254 * its parant window's canvas.
17255 * It will instead be limited only by the size of the display.
17257 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17260 * Set the content to be shown in the tooltip item.
17262 * Setup the tooltip to item. The item can have only one tooltip,
17263 * so any previous tooltip data is removed. @p func(with @p data) will
17264 * be called every time that need show the tooltip and it should
17265 * return a valid Evas_Object. This object is then managed fully by
17266 * tooltip system and is deleted when the tooltip is gone.
17268 * @param item the list item being attached a tooltip.
17269 * @param func the function used to create the tooltip contents.
17270 * @param data what to provide to @a func as callback data/context.
17271 * @param del_cb called when data is not needed anymore, either when
17272 * another callback replaces @a func, the tooltip is unset with
17273 * elm_list_item_tooltip_unset() or the owner @a item
17274 * dies. This callback receives as the first parameter the
17275 * given @a data, and @c event_info is the item.
17277 * @see elm_object_tooltip_content_cb_set() for more details.
17281 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);
17284 * Unset tooltip from item.
17286 * @param item list item to remove previously set tooltip.
17288 * Remove tooltip from item. The callback provided as del_cb to
17289 * elm_list_item_tooltip_content_cb_set() will be called to notify
17290 * it is not used anymore.
17292 * @see elm_object_tooltip_unset() for more details.
17293 * @see elm_list_item_tooltip_content_cb_set()
17297 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17300 * Sets a different style for this item tooltip.
17302 * @note before you set a style you should define a tooltip with
17303 * elm_list_item_tooltip_content_cb_set() or
17304 * elm_list_item_tooltip_text_set()
17306 * @param item list item with tooltip already set.
17307 * @param style the theme style to use (default, transparent, ...)
17309 * @see elm_object_tooltip_style_set() for more details.
17313 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17316 * Get the style for this item tooltip.
17318 * @param item list item with tooltip already set.
17319 * @return style the theme style in use, defaults to "default". If the
17320 * object does not have a tooltip set, then NULL is returned.
17322 * @see elm_object_tooltip_style_get() for more details.
17323 * @see elm_list_item_tooltip_style_set()
17327 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17330 * Set the type of mouse pointer/cursor decoration to be shown,
17331 * when the mouse pointer is over the given list widget item
17333 * @param item list item to customize cursor on
17334 * @param cursor the cursor type's name
17336 * This function works analogously as elm_object_cursor_set(), but
17337 * here the cursor's changing area is restricted to the item's
17338 * area, and not the whole widget's. Note that that item cursors
17339 * have precedence over widget cursors, so that a mouse over an
17340 * item with custom cursor set will always show @b that cursor.
17342 * If this function is called twice for an object, a previously set
17343 * cursor will be unset on the second call.
17345 * @see elm_object_cursor_set()
17346 * @see elm_list_item_cursor_get()
17347 * @see elm_list_item_cursor_unset()
17351 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
17354 * Get the type of mouse pointer/cursor decoration set to be shown,
17355 * when the mouse pointer is over the given list widget item
17357 * @param item list item with custom cursor set
17358 * @return the cursor type's name or @c NULL, if no custom cursors
17359 * were set to @p item (and on errors)
17361 * @see elm_object_cursor_get()
17362 * @see elm_list_item_cursor_set()
17363 * @see elm_list_item_cursor_unset()
17367 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17370 * Unset any custom mouse pointer/cursor decoration set to be
17371 * shown, when the mouse pointer is over the given list widget
17372 * item, thus making it show the @b default cursor again.
17374 * @param item a list item
17376 * Use this call to undo any custom settings on this item's cursor
17377 * decoration, bringing it back to defaults (no custom style set).
17379 * @see elm_object_cursor_unset()
17380 * @see elm_list_item_cursor_set()
17384 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17387 * Set a different @b style for a given custom cursor set for a
17390 * @param item list item with custom cursor set
17391 * @param style the <b>theme style</b> to use (e.g. @c "default",
17392 * @c "transparent", etc)
17394 * This function only makes sense when one is using custom mouse
17395 * cursor decorations <b>defined in a theme file</b>, which can have,
17396 * given a cursor name/type, <b>alternate styles</b> on it. It
17397 * works analogously as elm_object_cursor_style_set(), but here
17398 * applyed only to list item objects.
17400 * @warning Before you set a cursor style you should have definen a
17401 * custom cursor previously on the item, with
17402 * elm_list_item_cursor_set()
17404 * @see elm_list_item_cursor_engine_only_set()
17405 * @see elm_list_item_cursor_style_get()
17409 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17412 * Get the current @b style set for a given list item's custom
17415 * @param item list item with custom cursor set.
17416 * @return style the cursor style in use. If the object does not
17417 * have a cursor set, then @c NULL is returned.
17419 * @see elm_list_item_cursor_style_set() for more details
17423 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17426 * Set if the (custom)cursor for a given list item should be
17427 * searched in its theme, also, or should only rely on the
17428 * rendering engine.
17430 * @param item item with custom (custom) cursor already set on
17431 * @param engine_only Use @c EINA_TRUE to have cursors looked for
17432 * only on those provided by the rendering engine, @c EINA_FALSE to
17433 * have them searched on the widget's theme, as well.
17435 * @note This call is of use only if you've set a custom cursor
17436 * for list items, with elm_list_item_cursor_set().
17438 * @note By default, cursors will only be looked for between those
17439 * provided by the rendering engine.
17443 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
17446 * Get if the (custom) cursor for a given list item is being
17447 * searched in its theme, also, or is only relying on the rendering
17450 * @param item a list item
17451 * @return @c EINA_TRUE, if cursors are being looked for only on
17452 * those provided by the rendering engine, @c EINA_FALSE if they
17453 * are being searched on the widget's theme, as well.
17455 * @see elm_list_item_cursor_engine_only_set(), for more details
17459 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17466 * @defgroup Slider Slider
17467 * @ingroup Elementary
17469 * @image html img/widget/slider/preview-00.png
17470 * @image latex img/widget/slider/preview-00.eps width=\textwidth
17472 * The slider adds a dragable āsliderā widget for selecting the value of
17473 * something within a range.
17475 * A slider can be horizontal or vertical. It can contain an Icon and has a
17476 * primary label as well as a units label (that is formatted with floating
17477 * point values and thus accepts a printf-style format string, like
17478 * ā%1.2f unitsā. There is also an indicator string that may be somewhere
17479 * else (like on the slider itself) that also accepts a format string like
17480 * units. Label, Icon Unit and Indicator strings/objects are optional.
17482 * A slider may be inverted which means values invert, with high vales being
17483 * on the left or top and low values on the right or bottom (as opposed to
17484 * normally being low on the left or top and high on the bottom and right).
17486 * The slider should have its minimum and maximum values set by the
17487 * application with elm_slider_min_max_set() and value should also be set by
17488 * the application before use with elm_slider_value_set(). The span of the
17489 * slider is its length (horizontally or vertically). This will be scaled by
17490 * the object or applications scaling factor. At any point code can query the
17491 * slider for its value with elm_slider_value_get().
17493 * Smart callbacks one can listen to:
17494 * - "changed" - Whenever the slider value is changed by the user.
17495 * - "slider,drag,start" - dragging the slider indicator around has started.
17496 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
17497 * - "delay,changed" - A short time after the value is changed by the user.
17498 * This will be called only when the user stops dragging for
17499 * a very short period or when they release their
17500 * finger/mouse, so it avoids possibly expensive reactions to
17501 * the value change.
17503 * Available styles for it:
17506 * Default contents parts of the slider widget that you can use for are:
17507 * @li "icon" - A icon of the slider
17508 * @li "end" - A end part content of the slider
17510 * Default text parts of the silder widget that you can use for are:
17511 * @li "default" - Label of the silder
17512 * Here is an example on its usage:
17513 * @li @ref slider_example
17517 * @addtogroup Slider
17522 * Add a new slider widget to the given parent Elementary
17523 * (container) object.
17525 * @param parent The parent object.
17526 * @return a new slider widget handle or @c NULL, on errors.
17528 * This function inserts a new slider widget on the canvas.
17532 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17535 * Set the label of a given slider widget
17537 * @param obj The progress bar object
17538 * @param label The text label string, in UTF-8
17541 * @deprecated use elm_object_text_set() instead.
17543 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17546 * Get the label of a given slider widget
17548 * @param obj The progressbar object
17549 * @return The text label string, in UTF-8
17552 * @deprecated use elm_object_text_get() instead.
17554 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17557 * Set the icon object of the slider object.
17559 * @param obj The slider object.
17560 * @param icon The icon object.
17562 * On horizontal mode, icon is placed at left, and on vertical mode,
17565 * @note Once the icon object is set, a previously set one will be deleted.
17566 * If you want to keep that old content object, use the
17567 * elm_slider_icon_unset() function.
17569 * @warning If the object being set does not have minimum size hints set,
17570 * it won't get properly displayed.
17573 * @deprecated use elm_object_part_content_set() instead.
17575 EINA_DEPRECATED EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17578 * Unset an icon set on a given slider widget.
17580 * @param obj The slider object.
17581 * @return The icon object that was being used, if any was set, or
17582 * @c NULL, otherwise (and on errors).
17584 * On horizontal mode, icon is placed at left, and on vertical mode,
17587 * This call will unparent and return the icon object which was set
17588 * for this widget, previously, on success.
17590 * @see elm_slider_icon_set() for more details
17591 * @see elm_slider_icon_get()
17592 * @deprecated use elm_object_part_content_unset() instead.
17596 EINA_DEPRECATED EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17599 * Retrieve the icon object set for a given slider widget.
17601 * @param obj The slider object.
17602 * @return The icon object's handle, if @p obj had one set, or @c NULL,
17603 * otherwise (and on errors).
17605 * On horizontal mode, icon is placed at left, and on vertical mode,
17608 * @see elm_slider_icon_set() for more details
17609 * @see elm_slider_icon_unset()
17611 * @deprecated use elm_object_part_content_get() instead.
17615 EINA_DEPRECATED EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17618 * Set the end object of the slider object.
17620 * @param obj The slider object.
17621 * @param end The end object.
17623 * On horizontal mode, end is placed at left, and on vertical mode,
17624 * placed at bottom.
17626 * @note Once the icon object is set, a previously set one will be deleted.
17627 * If you want to keep that old content object, use the
17628 * elm_slider_end_unset() function.
17630 * @warning If the object being set does not have minimum size hints set,
17631 * it won't get properly displayed.
17633 * @deprecated use elm_object_part_content_set() instead.
17637 EINA_DEPRECATED EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
17640 * Unset an end object set on a given slider widget.
17642 * @param obj The slider object.
17643 * @return The end object that was being used, if any was set, or
17644 * @c NULL, otherwise (and on errors).
17646 * On horizontal mode, end is placed at left, and on vertical mode,
17647 * placed at bottom.
17649 * This call will unparent and return the icon object which was set
17650 * for this widget, previously, on success.
17652 * @see elm_slider_end_set() for more details.
17653 * @see elm_slider_end_get()
17655 * @deprecated use elm_object_part_content_unset() instead
17660 EINA_DEPRECATED EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17663 * Retrieve the end object set for a given slider widget.
17665 * @param obj The slider object.
17666 * @return The end object's handle, if @p obj had one set, or @c NULL,
17667 * otherwise (and on errors).
17669 * On horizontal mode, icon is placed at right, and on vertical mode,
17670 * placed at bottom.
17672 * @see elm_slider_end_set() for more details.
17673 * @see elm_slider_end_unset()
17676 * @deprecated use elm_object_part_content_get() instead
17681 EINA_DEPRECATED EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17684 * Set the (exact) length of the bar region of a given slider widget.
17686 * @param obj The slider object.
17687 * @param size The length of the slider's bar region.
17689 * This sets the minimum width (when in horizontal mode) or height
17690 * (when in vertical mode) of the actual bar area of the slider
17691 * @p obj. This in turn affects the object's minimum size. Use
17692 * this when you're not setting other size hints expanding on the
17693 * given direction (like weight and alignment hints) and you would
17694 * like it to have a specific size.
17696 * @note Icon, end, label, indicator and unit text around @p obj
17697 * will require their
17698 * own space, which will make @p obj to require more the @p size,
17701 * @see elm_slider_span_size_get()
17705 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17708 * Get the length set for the bar region of a given slider widget
17710 * @param obj The slider object.
17711 * @return The length of the slider's bar region.
17713 * If that size was not set previously, with
17714 * elm_slider_span_size_set(), this call will return @c 0.
17718 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17721 * Set the format string for the unit label.
17723 * @param obj The slider object.
17724 * @param format The format string for the unit display.
17726 * Unit label is displayed all the time, if set, after slider's bar.
17727 * In horizontal mode, at right and in vertical mode, at bottom.
17729 * If @c NULL, unit label won't be visible. If not it sets the format
17730 * string for the label text. To the label text is provided a floating point
17731 * value, so the label text can display up to 1 floating point value.
17732 * Note that this is optional.
17734 * Use a format string such as "%1.2f meters" for example, and it will
17735 * display values like: "3.14 meters" for a value equal to 3.14159.
17737 * Default is unit label disabled.
17739 * @see elm_slider_indicator_format_get()
17743 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17746 * Get the unit label format of the slider.
17748 * @param obj The slider object.
17749 * @return The unit label format string in UTF-8.
17751 * Unit label is displayed all the time, if set, after slider's bar.
17752 * In horizontal mode, at right and in vertical mode, at bottom.
17754 * @see elm_slider_unit_format_set() for more
17755 * information on how this works.
17759 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17762 * Set the format string for the indicator label.
17764 * @param obj The slider object.
17765 * @param indicator The format string for the indicator display.
17767 * The slider may display its value somewhere else then unit label,
17768 * for example, above the slider knob that is dragged around. This function
17769 * sets the format string used for this.
17771 * If @c NULL, indicator label won't be visible. If not it sets the format
17772 * string for the label text. To the label text is provided a floating point
17773 * value, so the label text can display up to 1 floating point value.
17774 * Note that this is optional.
17776 * Use a format string such as "%1.2f meters" for example, and it will
17777 * display values like: "3.14 meters" for a value equal to 3.14159.
17779 * Default is indicator label disabled.
17781 * @see elm_slider_indicator_format_get()
17785 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
17788 * Get the indicator label format of the slider.
17790 * @param obj The slider object.
17791 * @return The indicator label format string in UTF-8.
17793 * The slider may display its value somewhere else then unit label,
17794 * for example, above the slider knob that is dragged around. This function
17795 * gets the format string used for this.
17797 * @see elm_slider_indicator_format_set() for more
17798 * information on how this works.
17802 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17805 * Set the format function pointer for the indicator label
17807 * @param obj The slider object.
17808 * @param func The indicator format function.
17809 * @param free_func The freeing function for the format string.
17811 * Set the callback function to format the indicator string.
17813 * @see elm_slider_indicator_format_set() for more info on how this works.
17817 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);
17820 * Set the format function pointer for the units label
17822 * @param obj The slider object.
17823 * @param func The units format function.
17824 * @param free_func The freeing function for the format string.
17826 * Set the callback function to format the indicator string.
17828 * @see elm_slider_units_format_set() for more info on how this works.
17832 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);
17835 * Set the orientation of a given slider widget.
17837 * @param obj The slider object.
17838 * @param horizontal Use @c EINA_TRUE to make @p obj to be
17839 * @b horizontal, @c EINA_FALSE to make it @b vertical.
17841 * Use this function to change how your slider is to be
17842 * disposed: vertically or horizontally.
17844 * By default it's displayed horizontally.
17846 * @see elm_slider_horizontal_get()
17850 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17853 * Retrieve the orientation of a given slider widget
17855 * @param obj The slider object.
17856 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17857 * @c EINA_FALSE if it's @b vertical (and on errors).
17859 * @see elm_slider_horizontal_set() for more details.
17863 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17866 * Set the minimum and maximum values for the slider.
17868 * @param obj The slider object.
17869 * @param min The minimum value.
17870 * @param max The maximum value.
17872 * Define the allowed range of values to be selected by the user.
17874 * If actual value is less than @p min, it will be updated to @p min. If it
17875 * is bigger then @p max, will be updated to @p max. Actual value can be
17876 * get with elm_slider_value_get().
17878 * By default, min is equal to 0.0, and max is equal to 1.0.
17880 * @warning Maximum must be greater than minimum, otherwise behavior
17883 * @see elm_slider_min_max_get()
17887 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17890 * Get the minimum and maximum values of the slider.
17892 * @param obj The slider object.
17893 * @param min Pointer where to store the minimum value.
17894 * @param max Pointer where to store the maximum value.
17896 * @note If only one value is needed, the other pointer can be passed
17899 * @see elm_slider_min_max_set() for details.
17903 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17906 * Set the value the slider displays.
17908 * @param obj The slider object.
17909 * @param val The value to be displayed.
17911 * Value will be presented on the unit label following format specified with
17912 * elm_slider_unit_format_set() and on indicator with
17913 * elm_slider_indicator_format_set().
17915 * @warning The value must to be between min and max values. This values
17916 * are set by elm_slider_min_max_set().
17918 * @see elm_slider_value_get()
17919 * @see elm_slider_unit_format_set()
17920 * @see elm_slider_indicator_format_set()
17921 * @see elm_slider_min_max_set()
17925 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17928 * Get the value displayed by the spinner.
17930 * @param obj The spinner object.
17931 * @return The value displayed.
17933 * @see elm_spinner_value_set() for details.
17937 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17940 * Invert a given slider widget's displaying values order
17942 * @param obj The slider object.
17943 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17944 * @c EINA_FALSE to bring it back to default, non-inverted values.
17946 * A slider may be @b inverted, in which state it gets its
17947 * values inverted, with high vales being on the left or top and
17948 * low values on the right or bottom, as opposed to normally have
17949 * the low values on the former and high values on the latter,
17950 * respectively, for horizontal and vertical modes.
17952 * @see elm_slider_inverted_get()
17956 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
17959 * Get whether a given slider widget's displaying values are
17962 * @param obj The slider object.
17963 * @return @c EINA_TRUE, if @p obj has inverted values,
17964 * @c EINA_FALSE otherwise (and on errors).
17966 * @see elm_slider_inverted_set() for more details.
17970 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17973 * Set whether to enlarge slider indicator (augmented knob) or not.
17975 * @param obj The slider object.
17976 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
17977 * let the knob always at default size.
17979 * By default, indicator will be bigger while dragged by the user.
17981 * @warning It won't display values set with
17982 * elm_slider_indicator_format_set() if you disable indicator.
17986 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
17989 * Get whether a given slider widget's enlarging indicator or not.
17991 * @param obj The slider object.
17992 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
17993 * @c EINA_FALSE otherwise (and on errors).
17995 * @see elm_slider_indicator_show_set() for details.
17999 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18006 * @addtogroup Actionslider Actionslider
18008 * @image html img/widget/actionslider/preview-00.png
18009 * @image latex img/widget/actionslider/preview-00.eps
18011 * An actionslider is a switcher for 2 or 3 labels with customizable magnet
18012 * properties. The user drags and releases the indicator, to choose a label.
18014 * Labels occupy the following positions.
18019 * Positions can be enabled or disabled.
18021 * Magnets can be set on the above positions.
18023 * When the indicator is released, it will move to its nearest "enabled and magnetized" position.
18025 * @note By default all positions are set as enabled.
18027 * Signals that you can add callbacks for are:
18029 * "selected" - when user selects an enabled position (the label is passed
18032 * "pos_changed" - when the indicator reaches any of the positions("left",
18033 * "right" or "center").
18035 * See an example of actionslider usage @ref actionslider_example_page "here"
18038 typedef enum _Elm_Actionslider_Pos
18040 ELM_ACTIONSLIDER_NONE = 0,
18041 ELM_ACTIONSLIDER_LEFT = 1 << 0,
18042 ELM_ACTIONSLIDER_CENTER = 1 << 1,
18043 ELM_ACTIONSLIDER_RIGHT = 1 << 2,
18044 ELM_ACTIONSLIDER_ALL = (1 << 3) -1
18045 } Elm_Actionslider_Pos;
18048 * Add a new actionslider to the parent.
18050 * @param parent The parent object
18051 * @return The new actionslider object or NULL if it cannot be created
18053 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18055 * Set actionslider labels.
18057 * @param obj The actionslider object
18058 * @param left_label The label to be set on the left.
18059 * @param center_label The label to be set on the center.
18060 * @param right_label The label to be set on the right.
18061 * @deprecated use elm_object_text_set() instead.
18063 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);
18065 * Get actionslider labels.
18067 * @param obj The actionslider object
18068 * @param left_label A char** to place the left_label of @p obj into.
18069 * @param center_label A char** to place the center_label of @p obj into.
18070 * @param right_label A char** to place the right_label of @p obj into.
18071 * @deprecated use elm_object_text_set() instead.
18073 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);
18075 * Get actionslider selected label.
18077 * @param obj The actionslider object
18078 * @return The selected label
18080 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18082 * Set actionslider indicator position.
18084 * @param obj The actionslider object.
18085 * @param pos The position of the indicator.
18087 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
18089 * Get actionslider indicator position.
18091 * @param obj The actionslider object.
18092 * @return The position of the indicator.
18094 EAPI Elm_Actionslider_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18096 * Set actionslider magnet position. To make multiple positions magnets @c or
18097 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
18099 * @param obj The actionslider object.
18100 * @param pos Bit mask indicating the magnet positions.
18102 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
18104 * Get actionslider magnet position.
18106 * @param obj The actionslider object.
18107 * @return The positions with magnet property.
18109 EAPI Elm_Actionslider_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18111 * Set actionslider enabled position. To set multiple positions as enabled @c or
18112 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
18114 * @note All the positions are enabled by default.
18116 * @param obj The actionslider object.
18117 * @param pos Bit mask indicating the enabled positions.
18119 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
18121 * Get actionslider enabled position.
18123 * @param obj The actionslider object.
18124 * @return The enabled positions.
18126 EAPI Elm_Actionslider_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18128 * Set the label used on the indicator.
18130 * @param obj The actionslider object
18131 * @param label The label to be set on the indicator.
18132 * @deprecated use elm_object_text_set() instead.
18134 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18136 * Get the label used on the indicator object.
18138 * @param obj The actionslider object
18139 * @return The indicator label
18140 * @deprecated use elm_object_text_get() instead.
18142 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
18148 * @defgroup Genlist Genlist
18150 * @image html img/widget/genlist/preview-00.png
18151 * @image latex img/widget/genlist/preview-00.eps
18152 * @image html img/genlist.png
18153 * @image latex img/genlist.eps
18155 * This widget aims to have more expansive list than the simple list in
18156 * Elementary that could have more flexible items and allow many more entries
18157 * while still being fast and low on memory usage. At the same time it was
18158 * also made to be able to do tree structures. But the price to pay is more
18159 * complexity when it comes to usage. If all you want is a simple list with
18160 * icons and a single label, use the normal @ref List object.
18162 * Genlist has a fairly large API, mostly because it's relatively complex,
18163 * trying to be both expansive, powerful and efficient. First we will begin
18164 * an overview on the theory behind genlist.
18166 * @section Genlist_Item_Class Genlist item classes - creating items
18168 * In order to have the ability to add and delete items on the fly, genlist
18169 * implements a class (callback) system where the application provides a
18170 * structure with information about that type of item (genlist may contain
18171 * multiple different items with different classes, states and styles).
18172 * Genlist will call the functions in this struct (methods) when an item is
18173 * "realized" (i.e., created dynamically, while the user is scrolling the
18174 * grid). All objects will simply be deleted when no longer needed with
18175 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
18176 * following members:
18177 * - @c item_style - This is a constant string and simply defines the name
18178 * of the item style. It @b must be specified and the default should be @c
18181 * - @c func - A struct with pointers to functions that will be called when
18182 * an item is going to be actually created. All of them receive a @c data
18183 * parameter that will point to the same data passed to
18184 * elm_genlist_item_append() and related item creation functions, and a @c
18185 * obj parameter that points to the genlist object itself.
18187 * The function pointers inside @c func are @c label_get, @c icon_get, @c
18188 * state_get and @c del. The 3 first functions also receive a @c part
18189 * parameter described below. A brief description of these functions follows:
18191 * - @c label_get - The @c part parameter is the name string of one of the
18192 * existing text parts in the Edje group implementing the item's theme.
18193 * This function @b must return a strdup'()ed string, as the caller will
18194 * free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
18195 * - @c content_get - The @c part parameter is the name string of one of the
18196 * existing (content) swallow parts in the Edje group implementing the item's
18197 * theme. It must return @c NULL, when no content is desired, or a valid
18198 * object handle, otherwise. The object will be deleted by the genlist on
18199 * its deletion or when the item is "unrealized". See
18200 * #Elm_Genlist_Item_Icon_Get_Cb.
18201 * - @c func.state_get - The @c part parameter is the name string of one of
18202 * the state parts in the Edje group implementing the item's theme. Return
18203 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
18204 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
18205 * and @c "elm" as "emission" and "source" arguments, respectively, when
18206 * the state is true (the default is false), where @c XXX is the name of
18207 * the (state) part. See #Elm_Genlist_Item_State_Get_Cb.
18208 * - @c func.del - This is intended for use when genlist items are deleted,
18209 * so any data attached to the item (e.g. its data parameter on creation)
18210 * can be deleted. See #Elm_Genlist_Item_Del_Cb.
18212 * available item styles:
18214 * - default_style - The text part is a textblock
18216 * @image html img/widget/genlist/preview-04.png
18217 * @image latex img/widget/genlist/preview-04.eps
18221 * @image html img/widget/genlist/preview-01.png
18222 * @image latex img/widget/genlist/preview-01.eps
18224 * - icon_top_text_bottom
18226 * @image html img/widget/genlist/preview-02.png
18227 * @image latex img/widget/genlist/preview-02.eps
18231 * @image html img/widget/genlist/preview-03.png
18232 * @image latex img/widget/genlist/preview-03.eps
18234 * @section Genlist_Items Structure of items
18236 * An item in a genlist can have 0 or more text labels (they can be regular
18237 * text or textblock Evas objects - that's up to the style to determine), 0
18238 * or more contents (which are simply objects swallowed into the genlist item's
18239 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
18240 * behavior left to the user to define. The Edje part names for each of
18241 * these properties will be looked up, in the theme file for the genlist,
18242 * under the Edje (string) data items named @c "labels", @c "contents" and @c
18243 * "states", respectively. For each of those properties, if more than one
18244 * part is provided, they must have names listed separated by spaces in the
18245 * data fields. For the default genlist item theme, we have @b one label
18246 * part (@c "elm.text"), @b two content parts (@c "elm.swalllow.icon" and @c
18247 * "elm.swallow.end") and @b no state parts.
18249 * A genlist item may be at one of several styles. Elementary provides one
18250 * by default - "default", but this can be extended by system or application
18251 * custom themes/overlays/extensions (see @ref Theme "themes" for more
18254 * @section Genlist_Manipulation Editing and Navigating
18256 * Items can be added by several calls. All of them return a @ref
18257 * Elm_Genlist_Item handle that is an internal member inside the genlist.
18258 * They all take a data parameter that is meant to be used for a handle to
18259 * the applications internal data (eg the struct with the original item
18260 * data). The parent parameter is the parent genlist item this belongs to if
18261 * it is a tree or an indexed group, and NULL if there is no parent. The
18262 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
18263 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
18264 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
18265 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
18266 * is set then this item is group index item that is displayed at the top
18267 * until the next group comes. The func parameter is a convenience callback
18268 * that is called when the item is selected and the data parameter will be
18269 * the func_data parameter, obj be the genlist object and event_info will be
18270 * the genlist item.
18272 * elm_genlist_item_append() adds an item to the end of the list, or if
18273 * there is a parent, to the end of all the child items of the parent.
18274 * elm_genlist_item_prepend() is the same but adds to the beginning of
18275 * the list or children list. elm_genlist_item_insert_before() inserts at
18276 * item before another item and elm_genlist_item_insert_after() inserts after
18277 * the indicated item.
18279 * The application can clear the list with elm_gen_clear() which deletes
18280 * all the items in the list and elm_genlist_item_del() will delete a specific
18281 * item. elm_genlist_item_subitems_clear() will clear all items that are
18282 * children of the indicated parent item.
18284 * To help inspect list items you can jump to the item at the top of the list
18285 * with elm_genlist_first_item_get() which will return the item pointer, and
18286 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
18287 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
18288 * and previous items respectively relative to the indicated item. Using
18289 * these calls you can walk the entire item list/tree. Note that as a tree
18290 * the items are flattened in the list, so elm_genlist_item_parent_get() will
18291 * let you know which item is the parent (and thus know how to skip them if
18294 * @section Genlist_Muti_Selection Multi-selection
18296 * If the application wants multiple items to be able to be selected,
18297 * elm_genlist_multi_select_set() can enable this. If the list is
18298 * single-selection only (the default), then elm_genlist_selected_item_get()
18299 * will return the selected item, if any, or NULL I none is selected. If the
18300 * list is multi-select then elm_genlist_selected_items_get() will return a
18301 * list (that is only valid as long as no items are modified (added, deleted,
18302 * selected or unselected)).
18304 * @section Genlist_Usage_Hints Usage hints
18306 * There are also convenience functions. elm_gen_item_genlist_get() will
18307 * return the genlist object the item belongs to. elm_genlist_item_show()
18308 * will make the scroller scroll to show that specific item so its visible.
18309 * elm_genlist_item_data_get() returns the data pointer set by the item
18310 * creation functions.
18312 * If an item changes (state of boolean changes, label or contents change),
18313 * then use elm_genlist_item_update() to have genlist update the item with
18314 * the new state. Genlist will re-realize the item thus call the functions
18315 * in the _Elm_Genlist_Item_Class for that item.
18317 * To programmatically (un)select an item use elm_genlist_item_selected_set().
18318 * To get its selected state use elm_genlist_item_selected_get(). Similarly
18319 * to expand/contract an item and get its expanded state, use
18320 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
18321 * again to make an item disabled (unable to be selected and appear
18322 * differently) use elm_genlist_item_disabled_set() to set this and
18323 * elm_genlist_item_disabled_get() to get the disabled state.
18325 * In general to indicate how the genlist should expand items horizontally to
18326 * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
18327 * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
18328 * mode means that if items are too wide to fit, the scroller will scroll
18329 * horizontally. Otherwise items are expanded to fill the width of the
18330 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
18331 * to the viewport width and limited to that size. This can be combined with
18332 * a different style that uses edjes' ellipsis feature (cutting text off like
18335 * Items will only call their selection func and callback when first becoming
18336 * selected. Any further clicks will do nothing, unless you enable always
18337 * select with elm_gen_always_select_mode_set(). This means even if
18338 * selected, every click will make the selected callbacks be called.
18339 * elm_genlist_no_select_mode_set() will turn off the ability to select
18340 * items entirely and they will neither appear selected nor call selected
18341 * callback functions.
18343 * Remember that you can create new styles and add your own theme augmentation
18344 * per application with elm_theme_extension_add(). If you absolutely must
18345 * have a specific style that overrides any theme the user or system sets up
18346 * you can use elm_theme_overlay_add() to add such a file.
18348 * @section Genlist_Implementation Implementation
18350 * Evas tracks every object you create. Every time it processes an event
18351 * (mouse move, down, up etc.) it needs to walk through objects and find out
18352 * what event that affects. Even worse every time it renders display updates,
18353 * in order to just calculate what to re-draw, it needs to walk through many
18354 * many many objects. Thus, the more objects you keep active, the more
18355 * overhead Evas has in just doing its work. It is advisable to keep your
18356 * active objects to the minimum working set you need. Also remember that
18357 * object creation and deletion carries an overhead, so there is a
18358 * middle-ground, which is not easily determined. But don't keep massive lists
18359 * of objects you can't see or use. Genlist does this with list objects. It
18360 * creates and destroys them dynamically as you scroll around. It groups them
18361 * into blocks so it can determine the visibility etc. of a whole block at
18362 * once as opposed to having to walk the whole list. This 2-level list allows
18363 * for very large numbers of items to be in the list (tests have used up to
18364 * 2,000,000 items). Also genlist employs a queue for adding items. As items
18365 * may be different sizes, every item added needs to be calculated as to its
18366 * size and thus this presents a lot of overhead on populating the list, this
18367 * genlist employs a queue. Any item added is queued and spooled off over
18368 * time, actually appearing some time later, so if your list has many members
18369 * you may find it takes a while for them to all appear, with your process
18370 * consuming a lot of CPU while it is busy spooling.
18372 * Genlist also implements a tree structure, but it does so with callbacks to
18373 * the application, with the application filling in tree structures when
18374 * requested (allowing for efficient building of a very deep tree that could
18375 * even be used for file-management). See the above smart signal callbacks for
18378 * @section Genlist_Smart_Events Genlist smart events
18380 * Signals that you can add callbacks for are:
18381 * - @c "activated" - The user has double-clicked or pressed
18382 * (enter|return|spacebar) on an item. The @c event_info parameter is the
18383 * item that was activated.
18384 * - @c "clicked,double" - The user has double-clicked an item. The @c
18385 * event_info parameter is the item that was double-clicked.
18386 * - @c "selected" - This is called when a user has made an item selected.
18387 * The event_info parameter is the genlist item that was selected.
18388 * - @c "unselected" - This is called when a user has made an item
18389 * unselected. The event_info parameter is the genlist item that was
18391 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
18392 * called and the item is now meant to be expanded. The event_info
18393 * parameter is the genlist item that was indicated to expand. It is the
18394 * job of this callback to then fill in the child items.
18395 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
18396 * called and the item is now meant to be contracted. The event_info
18397 * parameter is the genlist item that was indicated to contract. It is the
18398 * job of this callback to then delete the child items.
18399 * - @c "expand,request" - This is called when a user has indicated they want
18400 * to expand a tree branch item. The callback should decide if the item can
18401 * expand (has any children) and then call elm_genlist_item_expanded_set()
18402 * appropriately to set the state. The event_info parameter is the genlist
18403 * item that was indicated to expand.
18404 * - @c "contract,request" - This is called when a user has indicated they
18405 * want to contract a tree branch item. The callback should decide if the
18406 * item can contract (has any children) and then call
18407 * elm_genlist_item_expanded_set() appropriately to set the state. The
18408 * event_info parameter is the genlist item that was indicated to contract.
18409 * - @c "realized" - This is called when the item in the list is created as a
18410 * real evas object. event_info parameter is the genlist item that was
18411 * created. The object may be deleted at any time, so it is up to the
18412 * caller to not use the object pointer from elm_genlist_item_object_get()
18413 * in a way where it may point to freed objects.
18414 * - @c "unrealized" - This is called just before an item is unrealized.
18415 * After this call content objects provided will be deleted and the item
18416 * object itself delete or be put into a floating cache.
18417 * - @c "drag,start,up" - This is called when the item in the list has been
18418 * dragged (not scrolled) up.
18419 * - @c "drag,start,down" - This is called when the item in the list has been
18420 * dragged (not scrolled) down.
18421 * - @c "drag,start,left" - This is called when the item in the list has been
18422 * dragged (not scrolled) left.
18423 * - @c "drag,start,right" - This is called when the item in the list has
18424 * been dragged (not scrolled) right.
18425 * - @c "drag,stop" - This is called when the item in the list has stopped
18427 * - @c "drag" - This is called when the item in the list is being dragged.
18428 * - @c "longpressed" - This is called when the item is pressed for a certain
18429 * amount of time. By default it's 1 second.
18430 * - @c "scroll,anim,start" - This is called when scrolling animation has
18432 * - @c "scroll,anim,stop" - This is called when scrolling animation has
18434 * - @c "scroll,drag,start" - This is called when dragging the content has
18436 * - @c "scroll,drag,stop" - This is called when dragging the content has
18438 * - @c "edge,top" - This is called when the genlist is scrolled until
18440 * - @c "edge,bottom" - This is called when the genlist is scrolled
18441 * until the bottom edge.
18442 * - @c "edge,left" - This is called when the genlist is scrolled
18443 * until the left edge.
18444 * - @c "edge,right" - This is called when the genlist is scrolled
18445 * until the right edge.
18446 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
18448 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
18450 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
18452 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
18454 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
18455 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
18456 * multi-touch pinched in.
18457 * - @c "swipe" - This is called when the genlist is swiped.
18458 * - @c "moved" - This is called when a genlist item is moved.
18459 * - @c "language,changed" - This is called when the program's language is
18462 * @section Genlist_Examples Examples
18464 * Here is a list of examples that use the genlist, trying to show some of
18465 * its capabilities:
18466 * - @ref genlist_example_01
18467 * - @ref genlist_example_02
18468 * - @ref genlist_example_03
18469 * - @ref genlist_example_04
18470 * - @ref genlist_example_05
18474 * @addtogroup Genlist
18479 * @enum _Elm_Genlist_Item_Flags
18480 * @typedef Elm_Genlist_Item_Flags
18482 * Defines if the item is of any special type (has subitems or it's the
18483 * index of a group), or is just a simple item.
18487 typedef enum _Elm_Genlist_Item_Flags
18489 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
18490 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
18491 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
18492 } Elm_Genlist_Item_Flags;
18493 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
18494 #define Elm_Genlist_Item_Class Elm_Gen_Item_Class
18495 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18496 #define Elm_Genlist_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18497 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
18499 * Label fetching class function for Elm_Gen_Item_Class.
18500 * @param data The data passed in the item creation function
18501 * @param obj The base widget object
18502 * @param part The part name of the swallow
18503 * @return The allocated (NOT stringshared) string to set as the label
18505 typedef char *(*Elm_Genlist_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part);
18507 * Content (swallowed object) fetching class function for Elm_Gen_Item_Class.
18508 * @param data The data passed in the item creation function
18509 * @param obj The base widget object
18510 * @param part The part name of the swallow
18511 * @return The content object to swallow
18513 typedef Evas_Object *(*Elm_Genlist_Item_Content_Get_Cb) (void *data, Evas_Object *obj, const char *part);
18515 * State fetching class function for Elm_Gen_Item_Class.
18516 * @param data The data passed in the item creation function
18517 * @param obj The base widget object
18518 * @param part The part name of the swallow
18519 * @return The hell if I know
18521 typedef Eina_Bool (*Elm_Genlist_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part);
18523 * Deletion class function for Elm_Gen_Item_Class.
18524 * @param data The data passed in the item creation function
18525 * @param obj The base widget object
18527 typedef void (*Elm_Genlist_Item_Del_Cb) (void *data, Evas_Object *obj);
18530 * @struct _Elm_Genlist_Item_Class
18532 * Genlist item class definition structs.
18534 * This struct contains the style and fetching functions that will define the
18535 * contents of each item.
18537 * @see @ref Genlist_Item_Class
18539 struct _Elm_Genlist_Item_Class
18541 const char *item_style; /**< style of this class. */
18542 struct Elm_Genlist_Item_Class_Func
18544 Elm_Genlist_Item_Label_Get_Cb label_get; /**< Label fetching class function for genlist item classes.*/
18545 Elm_Genlist_Item_Content_Get_Cb content_get; /**< Content fetching class function for genlist item classes. */
18546 Elm_Genlist_Item_State_Get_Cb state_get; /**< State fetching class function for genlist item classes. */
18547 Elm_Genlist_Item_Del_Cb del; /**< Deletion class function for genlist item classes. */
18550 #define Elm_Genlist_Item_Class_Func Elm_Gen_Item_Class_Func
18552 * Add a new genlist widget to the given parent Elementary
18553 * (container) object
18555 * @param parent The parent object
18556 * @return a new genlist widget handle or @c NULL, on errors
18558 * This function inserts a new genlist widget on the canvas.
18560 * @see elm_genlist_item_append()
18561 * @see elm_genlist_item_del()
18562 * @see elm_gen_clear()
18566 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18568 * Remove all items from a given genlist widget.
18570 * @param obj The genlist object
18572 * This removes (and deletes) all items in @p obj, leaving it empty.
18574 * This is deprecated. Please use elm_gen_clear() instead.
18576 * @see elm_genlist_item_del(), to remove just one item.
18580 EINA_DEPRECATED EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18582 * Enable or disable multi-selection in the genlist
18584 * @param obj The genlist object
18585 * @param multi Multi-select enable/disable. Default is disabled.
18587 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
18588 * the list. This allows more than 1 item to be selected. To retrieve the list
18589 * of selected items, use elm_genlist_selected_items_get().
18591 * @see elm_genlist_selected_items_get()
18592 * @see elm_genlist_multi_select_get()
18596 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
18598 * Gets if multi-selection in genlist is enabled or disabled.
18600 * @param obj The genlist object
18601 * @return Multi-select enabled/disabled
18602 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
18604 * @see elm_genlist_multi_select_set()
18608 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18610 * This sets the horizontal stretching mode.
18612 * @param obj The genlist object
18613 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
18615 * This sets the mode used for sizing items horizontally. Valid modes
18616 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
18617 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
18618 * the scroller will scroll horizontally. Otherwise items are expanded
18619 * to fill the width of the viewport of the scroller. If it is
18620 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
18621 * limited to that size.
18623 * @see elm_genlist_horizontal_get()
18627 EAPI void elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18628 EINA_DEPRECATED EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18630 * Gets the horizontal stretching mode.
18632 * @param obj The genlist object
18633 * @return The mode to use
18634 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
18636 * @see elm_genlist_horizontal_set()
18640 EAPI Elm_List_Mode elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18641 EINA_DEPRECATED EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18643 * Set the always select mode.
18645 * @param obj The genlist object
18646 * @param always_select The always select mode (@c EINA_TRUE = on, @c
18647 * EINA_FALSE = off). Default is @c EINA_FALSE.
18649 * Items will only call their selection func and callback when first
18650 * becoming selected. Any further clicks will do nothing, unless you
18651 * enable always select with elm_gen_always_select_mode_set().
18652 * This means that, even if selected, every click will make the selected
18653 * callbacks be called.
18655 * This function is deprecated. please see elm_gen_always_select_mode_set()
18657 * @see elm_genlist_always_select_mode_get()
18661 EINA_DEPRECATED EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
18663 * Get the always select mode.
18665 * @param obj The genlist object
18666 * @return The always select mode
18667 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18669 * @see elm_genlist_always_select_mode_set()
18673 EINA_DEPRECATED EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18675 * Enable/disable the no select mode.
18677 * @param obj The genlist object
18678 * @param no_select The no select mode
18679 * (EINA_TRUE = on, EINA_FALSE = off)
18681 * This will turn off the ability to select items entirely and they
18682 * will neither appear selected nor call selected callback functions.
18684 * @see elm_genlist_no_select_mode_get()
18688 EINA_DEPRECATED EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
18690 * Gets whether the no select mode is enabled.
18692 * @param obj The genlist object
18693 * @return The no select mode
18694 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18696 * @see elm_genlist_no_select_mode_set()
18700 EINA_DEPRECATED EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18702 * Enable/disable compress mode.
18704 * @param obj The genlist object
18705 * @param compress The compress mode
18706 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
18708 * This will enable the compress mode where items are "compressed"
18709 * horizontally to fit the genlist scrollable viewport width. This is
18710 * special for genlist. Do not rely on
18711 * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
18712 * work as genlist needs to handle it specially.
18714 * @see elm_genlist_compress_mode_get()
18718 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
18720 * Get whether the compress mode is enabled.
18722 * @param obj The genlist object
18723 * @return The compress mode
18724 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18726 * @see elm_genlist_compress_mode_set()
18730 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18732 * Enable/disable height-for-width mode.
18734 * @param obj The genlist object
18735 * @param setting The height-for-width mode (@c EINA_TRUE = on,
18736 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
18738 * With height-for-width mode the item width will be fixed (restricted
18739 * to a minimum of) to the list width when calculating its size in
18740 * order to allow the height to be calculated based on it. This allows,
18741 * for instance, text block to wrap lines if the Edje part is
18742 * configured with "text.min: 0 1".
18744 * @note This mode will make list resize slower as it will have to
18745 * recalculate every item height again whenever the list width
18748 * @note When height-for-width mode is enabled, it also enables
18749 * compress mode (see elm_genlist_compress_mode_set()) and
18750 * disables homogeneous (see elm_genlist_homogeneous_set()).
18754 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
18756 * Get whether the height-for-width mode is enabled.
18758 * @param obj The genlist object
18759 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
18764 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18766 * Enable/disable horizontal and vertical bouncing effect.
18768 * @param obj The genlist object
18769 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
18770 * EINA_FALSE = off). Default is @c EINA_FALSE.
18771 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
18772 * EINA_FALSE = off). Default is @c EINA_TRUE.
18774 * This will enable or disable the scroller bouncing effect for the
18775 * genlist. See elm_scroller_bounce_set() for details.
18777 * @see elm_scroller_bounce_set()
18778 * @see elm_genlist_bounce_get()
18782 EINA_DEPRECATED EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18784 * Get whether the horizontal and vertical bouncing effect is enabled.
18786 * @param obj The genlist object
18787 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
18789 * @param v_bounce Pointer to a bool to receive if the bounce vertically
18792 * @see elm_genlist_bounce_set()
18796 EINA_DEPRECATED EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18798 * Enable/disable homogenous mode.
18800 * @param obj The genlist object
18801 * @param homogeneous Assume the items within the genlist are of the
18802 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
18805 * This will enable the homogeneous mode where items are of the same
18806 * height and width so that genlist may do the lazy-loading at its
18807 * maximum (which increases the performance for scrolling the list). This
18808 * implies 'compressed' mode.
18810 * @see elm_genlist_compress_mode_set()
18811 * @see elm_genlist_homogeneous_get()
18815 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
18817 * Get whether the homogenous mode is enabled.
18819 * @param obj The genlist object
18820 * @return Assume the items within the genlist are of the same height
18821 * and width (EINA_TRUE = on, EINA_FALSE = off)
18823 * @see elm_genlist_homogeneous_set()
18827 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18829 * Set the maximum number of items within an item block
18831 * @param obj The genlist object
18832 * @param n Maximum number of items within an item block. Default is 32.
18834 * This will configure the block count to tune to the target with
18835 * particular performance matrix.
18837 * A block of objects will be used to reduce the number of operations due to
18838 * many objects in the screen. It can determine the visibility, or if the
18839 * object has changed, it theme needs to be updated, etc. doing this kind of
18840 * calculation to the entire block, instead of per object.
18842 * The default value for the block count is enough for most lists, so unless
18843 * you know you will have a lot of objects visible in the screen at the same
18844 * time, don't try to change this.
18846 * @see elm_genlist_block_count_get()
18847 * @see @ref Genlist_Implementation
18851 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
18853 * Get the maximum number of items within an item block
18855 * @param obj The genlist object
18856 * @return Maximum number of items within an item block
18858 * @see elm_genlist_block_count_set()
18862 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18864 * Set the timeout in seconds for the longpress event.
18866 * @param obj The genlist object
18867 * @param timeout timeout in seconds. Default is 1.
18869 * This option will change how long it takes to send an event "longpressed"
18870 * after the mouse down signal is sent to the list. If this event occurs, no
18871 * "clicked" event will be sent.
18873 * @see elm_genlist_longpress_timeout_set()
18877 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18879 * Get the timeout in seconds for the longpress event.
18881 * @param obj The genlist object
18882 * @return timeout in seconds
18884 * @see elm_genlist_longpress_timeout_get()
18888 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18890 * Append a new item in a given genlist widget.
18892 * @param obj The genlist object
18893 * @param itc The item class for the item
18894 * @param data The item data
18895 * @param parent The parent item, or NULL if none
18896 * @param flags Item flags
18897 * @param func Convenience function called when the item is selected
18898 * @param func_data Data passed to @p func above.
18899 * @return A handle to the item added or @c NULL if not possible
18901 * This adds the given item to the end of the list or the end of
18902 * the children list if the @p parent is given.
18904 * @see elm_genlist_item_prepend()
18905 * @see elm_genlist_item_insert_before()
18906 * @see elm_genlist_item_insert_after()
18907 * @see elm_genlist_item_del()
18911 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);
18913 * Prepend a new item in a given genlist widget.
18915 * @param obj The genlist object
18916 * @param itc The item class for the item
18917 * @param data The item data
18918 * @param parent The parent item, or NULL if none
18919 * @param flags Item flags
18920 * @param func Convenience function called when the item is selected
18921 * @param func_data Data passed to @p func above.
18922 * @return A handle to the item added or NULL if not possible
18924 * This adds an item to the beginning of the list or beginning of the
18925 * children of the parent if given.
18927 * @see elm_genlist_item_append()
18928 * @see elm_genlist_item_insert_before()
18929 * @see elm_genlist_item_insert_after()
18930 * @see elm_genlist_item_del()
18934 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);
18936 * Insert an item before another in a genlist widget
18938 * @param obj The genlist object
18939 * @param itc The item class for the item
18940 * @param data The item data
18941 * @param before The item to place this new one before.
18942 * @param flags Item flags
18943 * @param func Convenience function called when the item is selected
18944 * @param func_data Data passed to @p func above.
18945 * @return A handle to the item added or @c NULL if not possible
18947 * This inserts an item before another in the list. It will be in the
18948 * same tree level or group as the item it is inserted before.
18950 * @see elm_genlist_item_append()
18951 * @see elm_genlist_item_prepend()
18952 * @see elm_genlist_item_insert_after()
18953 * @see elm_genlist_item_del()
18957 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);
18959 * Insert an item after another in a genlist widget
18961 * @param obj The genlist object
18962 * @param itc The item class for the item
18963 * @param data The item data
18964 * @param after The item to place this new one after.
18965 * @param flags Item flags
18966 * @param func Convenience function called when the item is selected
18967 * @param func_data Data passed to @p func above.
18968 * @return A handle to the item added or @c NULL if not possible
18970 * This inserts an item after another in the list. It will be in the
18971 * same tree level or group as the item it is inserted after.
18973 * @see elm_genlist_item_append()
18974 * @see elm_genlist_item_prepend()
18975 * @see elm_genlist_item_insert_before()
18976 * @see elm_genlist_item_del()
18980 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);
18982 * Insert a new item into the sorted genlist object
18984 * @param obj The genlist object
18985 * @param itc The item class for the item
18986 * @param data The item data
18987 * @param parent The parent item, or NULL if none
18988 * @param flags Item flags
18989 * @param comp The function called for the sort
18990 * @param func Convenience function called when item selected
18991 * @param func_data Data passed to @p func above.
18992 * @return A handle to the item added or NULL if not possible
18996 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);
18997 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);
18998 /* operations to retrieve existing items */
19000 * Get the selectd item in the genlist.
19002 * @param obj The genlist object
19003 * @return The selected item, or NULL if none is selected.
19005 * This gets the selected item in the list (if multi-selection is enabled, only
19006 * the item that was first selected in the list is returned - which is not very
19007 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
19010 * If no item is selected, NULL is returned.
19012 * @see elm_genlist_selected_items_get()
19016 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19018 * Get a list of selected items in the genlist.
19020 * @param obj The genlist object
19021 * @return The list of selected items, or NULL if none are selected.
19023 * It returns a list of the selected items. This list pointer is only valid so
19024 * long as the selection doesn't change (no items are selected or unselected, or
19025 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
19026 * pointers. The order of the items in this list is the order which they were
19027 * selected, i.e. the first item in this list is the first item that was
19028 * selected, and so on.
19030 * @note If not in multi-select mode, consider using function
19031 * elm_genlist_selected_item_get() instead.
19033 * @see elm_genlist_multi_select_set()
19034 * @see elm_genlist_selected_item_get()
19038 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19040 * Get the mode item style of items in the genlist
19041 * @param obj The genlist object
19042 * @return The mode item style string, or NULL if none is specified
19044 * This is a constant string and simply defines the name of the
19045 * style that will be used for mode animations. It can be
19046 * @c NULL if you don't plan to use Genlist mode. See
19047 * elm_genlist_item_mode_set() for more info.
19051 EAPI const char *elm_genlist_mode_item_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19053 * Set the mode item style of items in the genlist
19054 * @param obj The genlist object
19055 * @param style The mode item style string, or NULL if none is desired
19057 * This is a constant string and simply defines the name of the
19058 * style that will be used for mode animations. It can be
19059 * @c NULL if you don't plan to use Genlist mode. See
19060 * elm_genlist_item_mode_set() for more info.
19064 EAPI void elm_genlist_mode_item_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
19066 * Get a list of realized items in genlist
19068 * @param obj The genlist object
19069 * @return The list of realized items, nor NULL if none are realized.
19071 * This returns a list of the realized items in the genlist. The list
19072 * contains Elm_Genlist_Item pointers. The list must be freed by the
19073 * caller when done with eina_list_free(). The item pointers in the
19074 * list are only valid so long as those items are not deleted or the
19075 * genlist is not deleted.
19077 * @see elm_genlist_realized_items_update()
19081 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19083 * Get the item that is at the x, y canvas coords.
19085 * @param obj The gelinst object.
19086 * @param x The input x coordinate
19087 * @param y The input y coordinate
19088 * @param posret The position relative to the item returned here
19089 * @return The item at the coordinates or NULL if none
19091 * This returns the item at the given coordinates (which are canvas
19092 * relative, not object-relative). If an item is at that coordinate,
19093 * that item handle is returned, and if @p posret is not NULL, the
19094 * integer pointed to is set to a value of -1, 0 or 1, depending if
19095 * the coordinate is on the upper portion of that item (-1), on the
19096 * middle section (0) or on the lower part (1). If NULL is returned as
19097 * an item (no item found there), then posret may indicate -1 or 1
19098 * based if the coordinate is above or below all items respectively in
19103 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);
19105 * Get the first item in the genlist
19107 * This returns the first item in the list.
19109 * @param obj The genlist object
19110 * @return The first item, or NULL if none
19114 EINA_DEPRECATED EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19116 * Get the last item in the genlist
19118 * This returns the last item in the list.
19120 * @return The last item, or NULL if none
19124 EINA_DEPRECATED EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19126 * Set the scrollbar policy
19128 * @param obj The genlist object
19129 * @param policy_h Horizontal scrollbar policy.
19130 * @param policy_v Vertical scrollbar policy.
19132 * This sets the scrollbar visibility policy for the given genlist
19133 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
19134 * made visible if it is needed, and otherwise kept hidden.
19135 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
19136 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
19137 * respectively for the horizontal and vertical scrollbars. Default is
19138 * #ELM_SMART_SCROLLER_POLICY_AUTO
19140 * @see elm_genlist_scroller_policy_get()
19144 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
19146 * Get the scrollbar policy
19148 * @param obj The genlist object
19149 * @param policy_h Pointer to store the horizontal scrollbar policy.
19150 * @param policy_v Pointer to store the vertical scrollbar policy.
19152 * @see elm_genlist_scroller_policy_set()
19156 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);
19158 * Get the @b next item in a genlist widget's internal list of items,
19159 * given a handle to one of those items.
19161 * @param item The genlist item to fetch next from
19162 * @return The item after @p item, or @c NULL if there's none (and
19165 * This returns the item placed after the @p item, on the container
19168 * @see elm_genlist_item_prev_get()
19172 EINA_DEPRECATED EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19174 * Get the @b previous item in a genlist widget's internal list of items,
19175 * given a handle to one of those items.
19177 * @param item The genlist item to fetch previous from
19178 * @return The item before @p item, or @c NULL if there's none (and
19181 * This returns the item placed before the @p item, on the container
19184 * @see elm_genlist_item_next_get()
19188 EINA_DEPRECATED EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19190 * Get the genlist object's handle which contains a given genlist
19193 * @param item The item to fetch the container from
19194 * @return The genlist (parent) object
19196 * This returns the genlist object itself that an item belongs to.
19198 * This function is deprecated. Please use elm_gen_item_widget_get()
19202 EINA_DEPRECATED EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19204 * Get the parent item of the given item
19206 * @param it The item
19207 * @return The parent of the item or @c NULL if it has no parent.
19209 * This returns the item that was specified as parent of the item @p it on
19210 * elm_genlist_item_append() and insertion related functions.
19214 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19216 * Remove all sub-items (children) of the given item
19218 * @param it The item
19220 * This removes all items that are children (and their descendants) of the
19221 * given item @p it.
19223 * @see elm_genlist_clear()
19224 * @see elm_genlist_item_del()
19228 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19230 * Set whether a given genlist item is selected or not
19232 * @param it The item
19233 * @param selected Use @c EINA_TRUE, to make it selected, @c
19234 * EINA_FALSE to make it unselected
19236 * This sets the selected state of an item. If multi selection is
19237 * not enabled on the containing genlist and @p selected is @c
19238 * EINA_TRUE, any other previously selected items will get
19239 * unselected in favor of this new one.
19241 * @see elm_genlist_item_selected_get()
19245 EINA_DEPRECATED EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
19247 * Get whether a given genlist item is selected or not
19249 * @param it The item
19250 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
19252 * @see elm_genlist_item_selected_set() for more details
19256 EINA_DEPRECATED EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19258 * Sets the expanded state of an item.
19260 * @param it The item
19261 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
19263 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
19266 * The theme will respond to this change visually, and a signal "expanded" or
19267 * "contracted" will be sent from the genlist with a pointer to the item that
19268 * has been expanded/contracted.
19270 * Calling this function won't show or hide any child of this item (if it is
19271 * a parent). You must manually delete and create them on the callbacks fo
19272 * the "expanded" or "contracted" signals.
19274 * @see elm_genlist_item_expanded_get()
19278 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
19280 * Get the expanded state of an item
19282 * @param it The item
19283 * @return The expanded state
19285 * This gets the expanded state of an item.
19287 * @see elm_genlist_item_expanded_set()
19291 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19293 * Get the depth of expanded item
19295 * @param it The genlist item object
19296 * @return The depth of expanded item
19300 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19302 * Set whether a given genlist item is disabled or not.
19304 * @param it The item
19305 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
19306 * to enable it back.
19308 * A disabled item cannot be selected or unselected. It will also
19309 * change its appearance, to signal the user it's disabled.
19311 * @see elm_genlist_item_disabled_get()
19315 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
19317 * Get whether a given genlist item is disabled or not.
19319 * @param it The item
19320 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
19323 * @see elm_genlist_item_disabled_set() for more details
19327 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19329 * Sets the display only state of an item.
19331 * @param it The item
19332 * @param display_only @c EINA_TRUE if the item is display only, @c
19333 * EINA_FALSE otherwise.
19335 * A display only item cannot be selected or unselected. It is for
19336 * display only and not selecting or otherwise clicking, dragging
19337 * etc. by the user, thus finger size rules will not be applied to
19340 * It's good to set group index items to display only state.
19342 * @see elm_genlist_item_display_only_get()
19346 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
19348 * Get the display only state of an item
19350 * @param it The item
19351 * @return @c EINA_TRUE if the item is display only, @c
19352 * EINA_FALSE otherwise.
19354 * @see elm_genlist_item_display_only_set()
19358 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19360 * Show the portion of a genlist's internal list containing a given
19361 * item, immediately.
19363 * @param it The item to display
19365 * This causes genlist to jump to the given item @p it and show it (by
19366 * immediately scrolling to that position), if it is not fully visible.
19368 * @see elm_genlist_item_bring_in()
19369 * @see elm_genlist_item_top_show()
19370 * @see elm_genlist_item_middle_show()
19374 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19376 * Animatedly bring in, to the visible are of a genlist, a given
19379 * @param it The item to display
19381 * This causes genlist to jump to the given item @p it and show it (by
19382 * animatedly scrolling), if it is not fully visible. This may use animation
19383 * to do so and take a period of time
19385 * @see elm_genlist_item_show()
19386 * @see elm_genlist_item_top_bring_in()
19387 * @see elm_genlist_item_middle_bring_in()
19391 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19393 * Show the portion of a genlist's internal list containing a given
19394 * item, immediately.
19396 * @param it The item to display
19398 * This causes genlist to jump to the given item @p it and show it (by
19399 * immediately scrolling to that position), if it is not fully visible.
19401 * The item will be positioned at the top of the genlist viewport.
19403 * @see elm_genlist_item_show()
19404 * @see elm_genlist_item_top_bring_in()
19408 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19410 * Animatedly bring in, to the visible are of a genlist, a given
19413 * @param it The item
19415 * This causes genlist to jump to the given item @p it and show it (by
19416 * animatedly scrolling), if it is not fully visible. This may use animation
19417 * to do so and take a period of time
19419 * The item will be positioned at the top of the genlist viewport.
19421 * @see elm_genlist_item_bring_in()
19422 * @see elm_genlist_item_top_show()
19426 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19428 * Show the portion of a genlist's internal list containing a given
19429 * item, immediately.
19431 * @param it The item to display
19433 * This causes genlist to jump to the given item @p it and show it (by
19434 * immediately scrolling to that position), if it is not fully visible.
19436 * The item will be positioned at the middle of the genlist viewport.
19438 * @see elm_genlist_item_show()
19439 * @see elm_genlist_item_middle_bring_in()
19443 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19445 * Animatedly bring in, to the visible are of a genlist, a given
19448 * @param it The item
19450 * This causes genlist to jump to the given item @p it and show it (by
19451 * animatedly scrolling), if it is not fully visible. This may use animation
19452 * to do so and take a period of time
19454 * The item will be positioned at the middle of the genlist viewport.
19456 * @see elm_genlist_item_bring_in()
19457 * @see elm_genlist_item_middle_show()
19461 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19463 * Remove a genlist item from the its parent, deleting it.
19465 * @param item The item to be removed.
19466 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
19468 * @see elm_genlist_clear(), to remove all items in a genlist at
19473 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19475 * Return the data associated to a given genlist item
19477 * @param item The genlist item.
19478 * @return the data associated to this item.
19480 * This returns the @c data value passed on the
19481 * elm_genlist_item_append() and related item addition calls.
19483 * @see elm_genlist_item_append()
19484 * @see elm_genlist_item_data_set()
19488 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19490 * Set the data associated to a given genlist item
19492 * @param item The genlist item
19493 * @param data The new data pointer to set on it
19495 * This @b overrides the @c data value passed on the
19496 * elm_genlist_item_append() and related item addition calls. This
19497 * function @b won't call elm_genlist_item_update() automatically,
19498 * so you'd issue it afterwards if you want to hove the item
19499 * updated to reflect the that new data.
19501 * @see elm_genlist_item_data_get()
19505 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
19507 * Tells genlist to "orphan" icons fetchs by the item class
19509 * @param it The item
19511 * This instructs genlist to release references to icons in the item,
19512 * meaning that they will no longer be managed by genlist and are
19513 * floating "orphans" that can be re-used elsewhere if the user wants
19518 EAPI void elm_genlist_item_contents_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19519 EINA_DEPRECATED EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19521 * Get the real Evas object created to implement the view of a
19522 * given genlist item
19524 * @param item The genlist item.
19525 * @return the Evas object implementing this item's view.
19527 * This returns the actual Evas object used to implement the
19528 * specified genlist item's view. This may be @c NULL, as it may
19529 * not have been created or may have been deleted, at any time, by
19530 * the genlist. <b>Do not modify this object</b> (move, resize,
19531 * show, hide, etc.), as the genlist is controlling it. This
19532 * function is for querying, emitting custom signals or hooking
19533 * lower level callbacks for events on that object. Do not delete
19534 * this object under any circumstances.
19536 * @see elm_genlist_item_data_get()
19540 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19542 * Update the contents of an item
19544 * @param it The item
19546 * This updates an item by calling all the item class functions again
19547 * to get the icons, labels and states. Use this when the original
19548 * item data has changed and the changes are desired to be reflected.
19550 * Use elm_genlist_realized_items_update() to update all already realized
19553 * @see elm_genlist_realized_items_update()
19557 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19559 * Update the item class of an item
19561 * @param it The item
19562 * @param itc The item class for the item
19564 * This sets another class fo the item, changing the way that it is
19565 * displayed. After changing the item class, elm_genlist_item_update() is
19566 * called on the item @p it.
19570 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
19571 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19573 * Set the text to be shown in a given genlist item's tooltips.
19575 * @param item The genlist item
19576 * @param text The text to set in the content
19578 * This call will setup the text to be used as tooltip to that item
19579 * (analogous to elm_object_tooltip_text_set(), but being item
19580 * tooltips with higher precedence than object tooltips). It can
19581 * have only one tooltip at a time, so any previous tooltip data
19582 * will get removed.
19584 * In order to set an icon or something else as a tooltip, look at
19585 * elm_genlist_item_tooltip_content_cb_set().
19589 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
19591 * Set the content to be shown in a given genlist item's tooltips
19593 * @param item The genlist item.
19594 * @param func The function returning the tooltip contents.
19595 * @param data What to provide to @a func as callback data/context.
19596 * @param del_cb Called when data is not needed anymore, either when
19597 * another callback replaces @p func, the tooltip is unset with
19598 * elm_genlist_item_tooltip_unset() or the owner @p item
19599 * dies. This callback receives as its first parameter the
19600 * given @p data, being @c event_info the item handle.
19602 * This call will setup the tooltip's contents to @p item
19603 * (analogous to elm_object_tooltip_content_cb_set(), but being
19604 * item tooltips with higher precedence than object tooltips). It
19605 * can have only one tooltip at a time, so any previous tooltip
19606 * content will get removed. @p func (with @p data) will be called
19607 * every time Elementary needs to show the tooltip and it should
19608 * return a valid Evas object, which will be fully managed by the
19609 * tooltip system, getting deleted when the tooltip is gone.
19611 * In order to set just a text as a tooltip, look at
19612 * elm_genlist_item_tooltip_text_set().
19616 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);
19618 * Unset a tooltip from a given genlist item
19620 * @param item genlist item to remove a previously set tooltip from.
19622 * This call removes any tooltip set on @p item. The callback
19623 * provided as @c del_cb to
19624 * elm_genlist_item_tooltip_content_cb_set() will be called to
19625 * notify it is not used anymore (and have resources cleaned, if
19628 * @see elm_genlist_item_tooltip_content_cb_set()
19632 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19634 * Set a different @b style for a given genlist item's tooltip.
19636 * @param item genlist item with tooltip set
19637 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
19638 * "default", @c "transparent", etc)
19640 * Tooltips can have <b>alternate styles</b> to be displayed on,
19641 * which are defined by the theme set on Elementary. This function
19642 * works analogously as elm_object_tooltip_style_set(), but here
19643 * applied only to genlist item objects. The default style for
19644 * tooltips is @c "default".
19646 * @note before you set a style you should define a tooltip with
19647 * elm_genlist_item_tooltip_content_cb_set() or
19648 * elm_genlist_item_tooltip_text_set()
19650 * @see elm_genlist_item_tooltip_style_get()
19654 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19656 * Get the style set a given genlist item's tooltip.
19658 * @param item genlist item with tooltip already set on.
19659 * @return style the theme style in use, which defaults to
19660 * "default". If the object does not have a tooltip set,
19661 * then @c NULL is returned.
19663 * @see elm_genlist_item_tooltip_style_set() for more details
19667 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19669 * @brief Disable size restrictions on an object's tooltip
19670 * @param item The tooltip's anchor object
19671 * @param disable If EINA_TRUE, size restrictions are disabled
19672 * @return EINA_FALSE on failure, EINA_TRUE on success
19674 * This function allows a tooltip to expand beyond its parant window's canvas.
19675 * It will instead be limited only by the size of the display.
19677 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
19679 * @brief Retrieve size restriction state of an object's tooltip
19680 * @param item The tooltip's anchor object
19681 * @return If EINA_TRUE, size restrictions are disabled
19683 * This function returns whether a tooltip is allowed to expand beyond
19684 * its parant window's canvas.
19685 * It will instead be limited only by the size of the display.
19687 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
19689 * Set the type of mouse pointer/cursor decoration to be shown,
19690 * when the mouse pointer is over the given genlist widget item
19692 * @param item genlist item to customize cursor on
19693 * @param cursor the cursor type's name
19695 * This function works analogously as elm_object_cursor_set(), but
19696 * here the cursor's changing area is restricted to the item's
19697 * area, and not the whole widget's. Note that that item cursors
19698 * have precedence over widget cursors, so that a mouse over @p
19699 * item will always show cursor @p type.
19701 * If this function is called twice for an object, a previously set
19702 * cursor will be unset on the second call.
19704 * @see elm_object_cursor_set()
19705 * @see elm_genlist_item_cursor_get()
19706 * @see elm_genlist_item_cursor_unset()
19710 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
19712 * Get the type of mouse pointer/cursor decoration set to be shown,
19713 * when the mouse pointer is over the given genlist widget item
19715 * @param item genlist item with custom cursor set
19716 * @return the cursor type's name or @c NULL, if no custom cursors
19717 * were set to @p item (and on errors)
19719 * @see elm_object_cursor_get()
19720 * @see elm_genlist_item_cursor_set() for more details
19721 * @see elm_genlist_item_cursor_unset()
19725 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19727 * Unset any custom mouse pointer/cursor decoration set to be
19728 * shown, when the mouse pointer is over the given genlist widget
19729 * item, thus making it show the @b default cursor again.
19731 * @param item a genlist item
19733 * Use this call to undo any custom settings on this item's cursor
19734 * decoration, bringing it back to defaults (no custom style set).
19736 * @see elm_object_cursor_unset()
19737 * @see elm_genlist_item_cursor_set() for more details
19741 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19743 * Set a different @b style for a given custom cursor set for a
19746 * @param item genlist item with custom cursor set
19747 * @param style the <b>theme style</b> to use (e.g. @c "default",
19748 * @c "transparent", etc)
19750 * This function only makes sense when one is using custom mouse
19751 * cursor decorations <b>defined in a theme file</b> , which can
19752 * have, given a cursor name/type, <b>alternate styles</b> on
19753 * it. It works analogously as elm_object_cursor_style_set(), but
19754 * here applied only to genlist item objects.
19756 * @warning Before you set a cursor style you should have defined a
19757 * custom cursor previously on the item, with
19758 * elm_genlist_item_cursor_set()
19760 * @see elm_genlist_item_cursor_engine_only_set()
19761 * @see elm_genlist_item_cursor_style_get()
19765 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19767 * Get the current @b style set for a given genlist item's custom
19770 * @param item genlist item with custom cursor set.
19771 * @return style the cursor style in use. If the object does not
19772 * have a cursor set, then @c NULL is returned.
19774 * @see elm_genlist_item_cursor_style_set() for more details
19778 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19780 * Set if the (custom) cursor for a given genlist item should be
19781 * searched in its theme, also, or should only rely on the
19782 * rendering engine.
19784 * @param item item with custom (custom) cursor already set on
19785 * @param engine_only Use @c EINA_TRUE to have cursors looked for
19786 * only on those provided by the rendering engine, @c EINA_FALSE to
19787 * have them searched on the widget's theme, as well.
19789 * @note This call is of use only if you've set a custom cursor
19790 * for genlist items, with elm_genlist_item_cursor_set().
19792 * @note By default, cursors will only be looked for between those
19793 * provided by the rendering engine.
19797 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
19799 * Get if the (custom) cursor for a given genlist item is being
19800 * searched in its theme, also, or is only relying on the rendering
19803 * @param item a genlist item
19804 * @return @c EINA_TRUE, if cursors are being looked for only on
19805 * those provided by the rendering engine, @c EINA_FALSE if they
19806 * are being searched on the widget's theme, as well.
19808 * @see elm_genlist_item_cursor_engine_only_set(), for more details
19812 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19814 * Update the contents of all realized items.
19816 * @param obj The genlist object.
19818 * This updates all realized items by calling all the item class functions again
19819 * to get the icons, labels and states. Use this when the original
19820 * item data has changed and the changes are desired to be reflected.
19822 * To update just one item, use elm_genlist_item_update().
19824 * @see elm_genlist_realized_items_get()
19825 * @see elm_genlist_item_update()
19829 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
19831 * Activate a genlist mode on an item
19833 * @param item The genlist item
19834 * @param mode Mode name
19835 * @param mode_set Boolean to define set or unset mode.
19837 * A genlist mode is a different way of selecting an item. Once a mode is
19838 * activated on an item, any other selected item is immediately unselected.
19839 * This feature provides an easy way of implementing a new kind of animation
19840 * for selecting an item, without having to entirely rewrite the item style
19841 * theme. However, the elm_genlist_selected_* API can't be used to get what
19842 * item is activate for a mode.
19844 * The current item style will still be used, but applying a genlist mode to
19845 * an item will select it using a different kind of animation.
19847 * The current active item for a mode can be found by
19848 * elm_genlist_mode_item_get().
19850 * The characteristics of genlist mode are:
19851 * - Only one mode can be active at any time, and for only one item.
19852 * - Genlist handles deactivating other items when one item is activated.
19853 * - A mode is defined in the genlist theme (edc), and more modes can easily
19855 * - A mode style and the genlist item style are different things. They
19856 * can be combined to provide a default style to the item, with some kind
19857 * of animation for that item when the mode is activated.
19859 * When a mode is activated on an item, a new view for that item is created.
19860 * The theme of this mode defines the animation that will be used to transit
19861 * the item from the old view to the new view. This second (new) view will be
19862 * active for that item while the mode is active on the item, and will be
19863 * destroyed after the mode is totally deactivated from that item.
19865 * @see elm_genlist_mode_get()
19866 * @see elm_genlist_mode_item_get()
19870 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
19872 * Get the last (or current) genlist mode used.
19874 * @param obj The genlist object
19876 * This function just returns the name of the last used genlist mode. It will
19877 * be the current mode if it's still active.
19879 * @see elm_genlist_item_mode_set()
19880 * @see elm_genlist_mode_item_get()
19884 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19886 * Get active genlist mode item
19888 * @param obj The genlist object
19889 * @return The active item for that current mode. Or @c NULL if no item is
19890 * activated with any mode.
19892 * This function returns the item that was activated with a mode, by the
19893 * function elm_genlist_item_mode_set().
19895 * @see elm_genlist_item_mode_set()
19896 * @see elm_genlist_mode_get()
19900 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19905 * @param obj The genlist object
19906 * @param reorder_mode The reorder mode
19907 * (EINA_TRUE = on, EINA_FALSE = off)
19911 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
19914 * Get the reorder mode
19916 * @param obj The genlist object
19917 * @return The reorder mode
19918 * (EINA_TRUE = on, EINA_FALSE = off)
19922 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19929 * @defgroup Check Check
19931 * @image html img/widget/check/preview-00.png
19932 * @image latex img/widget/check/preview-00.eps
19933 * @image html img/widget/check/preview-01.png
19934 * @image latex img/widget/check/preview-01.eps
19935 * @image html img/widget/check/preview-02.png
19936 * @image latex img/widget/check/preview-02.eps
19938 * @brief The check widget allows for toggling a value between true and
19941 * Check objects are a lot like radio objects in layout and functionality
19942 * except they do not work as a group, but independently and only toggle the
19943 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
19944 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
19945 * returns the current state. For convenience, like the radio objects, you
19946 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
19947 * for it to modify.
19949 * Signals that you can add callbacks for are:
19950 * "changed" - This is called whenever the user changes the state of one of
19951 * the check object(event_info is NULL).
19953 * Default contents parts of the check widget that you can use for are:
19954 * @li "icon" - A icon of the check
19956 * Default text parts of the check widget that you can use for are:
19957 * @li "elm.text" - Label of the check
19959 * @ref tutorial_check should give you a firm grasp of how to use this widget
19964 * @brief Add a new Check object
19966 * @param parent The parent object
19967 * @return The new object or NULL if it cannot be created
19969 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19971 * @brief Set the text label of the check object
19973 * @param obj The check object
19974 * @param label The text label string in UTF-8
19976 * @deprecated use elm_object_text_set() instead.
19978 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19980 * @brief Get the text label of the check object
19982 * @param obj The check object
19983 * @return The text label string in UTF-8
19985 * @deprecated use elm_object_text_get() instead.
19987 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19989 * @brief Set the icon object of the check object
19991 * @param obj The check object
19992 * @param icon The icon object
19994 * Once the icon object is set, a previously set one will be deleted.
19995 * If you want to keep that old content object, use the
19996 * elm_object_content_unset() function.
19998 * @deprecated use elm_object_part_content_set() instead.
20001 EINA_DEPRECATED EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
20003 * @brief Get the icon object of the check object
20005 * @param obj The check object
20006 * @return The icon object
20008 * @deprecated use elm_object_part_content_get() instead.
20011 EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20013 * @brief Unset the icon used for the check object
20015 * @param obj The check object
20016 * @return The icon object that was being used
20018 * Unparent and return the icon object which was set for this widget.
20020 * @deprecated use elm_object_part_content_unset() instead.
20023 EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20025 * @brief Set the on/off state of the check object
20027 * @param obj The check object
20028 * @param state The state to use (1 == on, 0 == off)
20030 * This sets the state of the check. If set
20031 * with elm_check_state_pointer_set() the state of that variable is also
20032 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
20034 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
20036 * @brief Get the state of the check object
20038 * @param obj The check object
20039 * @return The boolean state
20041 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20043 * @brief Set a convenience pointer to a boolean to change
20045 * @param obj The check object
20046 * @param statep Pointer to the boolean to modify
20048 * This sets a pointer to a boolean, that, in addition to the check objects
20049 * state will also be modified directly. To stop setting the object pointed
20050 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
20051 * then when this is called, the check objects state will also be modified to
20052 * reflect the value of the boolean @p statep points to, just like calling
20053 * elm_check_state_set().
20055 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
20056 EINA_DEPRECATED EAPI void elm_check_states_labels_set(Evas_Object *obj, const char *ontext, const char *offtext) EINA_ARG_NONNULL(1,2,3);
20057 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);
20064 * @defgroup Radio Radio
20066 * @image html img/widget/radio/preview-00.png
20067 * @image latex img/widget/radio/preview-00.eps
20069 * @brief Radio is a widget that allows for 1 or more options to be displayed
20070 * and have the user choose only 1 of them.
20072 * A radio object contains an indicator, an optional Label and an optional
20073 * icon object. While it's possible to have a group of only one radio they,
20074 * are normally used in groups of 2 or more. To add a radio to a group use
20075 * elm_radio_group_add(). The radio object(s) will select from one of a set
20076 * of integer values, so any value they are configuring needs to be mapped to
20077 * a set of integers. To configure what value that radio object represents,
20078 * use elm_radio_state_value_set() to set the integer it represents. To set
20079 * the value the whole group(which one is currently selected) is to indicate
20080 * use elm_radio_value_set() on any group member, and to get the groups value
20081 * use elm_radio_value_get(). For convenience the radio objects are also able
20082 * to directly set an integer(int) to the value that is selected. To specify
20083 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
20084 * The radio objects will modify this directly. That implies the pointer must
20085 * point to valid memory for as long as the radio objects exist.
20087 * Signals that you can add callbacks for are:
20088 * @li changed - This is called whenever the user changes the state of one of
20089 * the radio objects within the group of radio objects that work together.
20091 * Default contents parts of the radio widget that you can use for are:
20092 * @li "icon" - A icon of the radio
20094 * @ref tutorial_radio show most of this API in action.
20098 * @brief Add a new radio to the parent
20100 * @param parent The parent object
20101 * @return The new object or NULL if it cannot be created
20103 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20105 * @brief Set the text label of the radio object
20107 * @param obj The radio object
20108 * @param label The text label string in UTF-8
20110 * @deprecated use elm_object_text_set() instead.
20112 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
20114 * @brief Get the text label of the radio object
20116 * @param obj The radio object
20117 * @return The text label string in UTF-8
20119 * @deprecated use elm_object_text_set() instead.
20121 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20123 * @brief Set the icon object of the radio object
20125 * @param obj The radio object
20126 * @param icon The icon object
20128 * Once the icon object is set, a previously set one will be deleted. If you
20129 * want to keep that old content object, use the elm_radio_icon_unset()
20132 * @deprecated use elm_object_part_content_set() instead.
20135 EINA_DEPRECATED EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
20137 * @brief Get the icon object of the radio object
20139 * @param obj The radio object
20140 * @return The icon object
20142 * @see elm_radio_icon_set()
20144 * @deprecated use elm_object_part_content_get() instead.
20147 EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20149 * @brief Unset the icon used for the radio object
20151 * @param obj The radio object
20152 * @return The icon object that was being used
20154 * Unparent and return the icon object which was set for this widget.
20156 * @see elm_radio_icon_set()
20157 * @deprecated use elm_object_part_content_unset() instead.
20160 EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20162 * @brief Add this radio to a group of other radio objects
20164 * @param obj The radio object
20165 * @param group Any object whose group the @p obj is to join.
20167 * Radio objects work in groups. Each member should have a different integer
20168 * value assigned. In order to have them work as a group, they need to know
20169 * about each other. This adds the given radio object to the group of which
20170 * the group object indicated is a member.
20172 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
20174 * @brief Set the integer value that this radio object represents
20176 * @param obj The radio object
20177 * @param value The value to use if this radio object is selected
20179 * This sets the value of the radio.
20181 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
20183 * @brief Get the integer value that this radio object represents
20185 * @param obj The radio object
20186 * @return The value used if this radio object is selected
20188 * This gets the value of the radio.
20190 * @see elm_radio_value_set()
20192 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20194 * @brief Set the value of the radio.
20196 * @param obj The radio object
20197 * @param value The value to use for the group
20199 * This sets the value of the radio group and will also set the value if
20200 * pointed to, to the value supplied, but will not call any callbacks.
20202 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
20204 * @brief Get the state of the radio object
20206 * @param obj The radio object
20207 * @return The integer state
20209 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20211 * @brief Set a convenience pointer to a integer to change
20213 * @param obj The radio object
20214 * @param valuep Pointer to the integer to modify
20216 * This sets a pointer to a integer, that, in addition to the radio objects
20217 * state will also be modified directly. To stop setting the object pointed
20218 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
20219 * when this is called, the radio objects state will also be modified to
20220 * reflect the value of the integer valuep points to, just like calling
20221 * elm_radio_value_set().
20223 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
20229 * @defgroup Pager Pager
20231 * @image html img/widget/pager/preview-00.png
20232 * @image latex img/widget/pager/preview-00.eps
20234 * @brief Widget that allows flipping between 1 or more āpagesā of objects.
20236 * The flipping between āpagesā of objects is animated. All content in pager
20237 * is kept in a stack, the last content to be added will be on the top of the
20238 * stack(be visible).
20240 * Objects can be pushed or popped from the stack or deleted as normal.
20241 * Pushes and pops will animate (and a pop will delete the object once the
20242 * animation is finished). Any object already in the pager can be promoted to
20243 * the top(from its current stacking position) through the use of
20244 * elm_pager_content_promote(). Objects are pushed to the top with
20245 * elm_pager_content_push() and when the top item is no longer wanted, simply
20246 * pop it with elm_pager_content_pop() and it will also be deleted. If an
20247 * object is no longer needed and is not the top item, just delete it as
20248 * normal. You can query which objects are the top and bottom with
20249 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
20251 * Signals that you can add callbacks for are:
20252 * "hide,finished" - when the previous page is hided
20254 * This widget has the following styles available:
20257 * @li fade_translucide
20258 * @li fade_invisible
20259 * @note This styles affect only the flipping animations, the appearance when
20260 * not animating is unaffected by styles.
20262 * @ref tutorial_pager gives a good overview of the usage of the API.
20266 * Add a new pager to the parent
20268 * @param parent The parent object
20269 * @return The new object or NULL if it cannot be created
20273 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20275 * @brief Push an object to the top of the pager stack (and show it).
20277 * @param obj The pager object
20278 * @param content The object to push
20280 * The object pushed becomes a child of the pager, it will be controlled and
20281 * deleted when the pager is deleted.
20283 * @note If the content is already in the stack use
20284 * elm_pager_content_promote().
20285 * @warning Using this function on @p content already in the stack results in
20286 * undefined behavior.
20288 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20290 * @brief Pop the object that is on top of the stack
20292 * @param obj The pager object
20294 * This pops the object that is on the top(visible) of the pager, makes it
20295 * disappear, then deletes the object. The object that was underneath it on
20296 * the stack will become visible.
20298 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
20300 * @brief Moves an object already in the pager stack to the top of the stack.
20302 * @param obj The pager object
20303 * @param content The object to promote
20305 * This will take the @p content and move it to the top of the stack as
20306 * if it had been pushed there.
20308 * @note If the content isn't already in the stack use
20309 * elm_pager_content_push().
20310 * @warning Using this function on @p content not already in the stack
20311 * results in undefined behavior.
20313 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20315 * @brief Return the object at the bottom of the pager stack
20317 * @param obj The pager object
20318 * @return The bottom object or NULL if none
20320 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20322 * @brief Return the object at the top of the pager stack
20324 * @param obj The pager object
20325 * @return The top object or NULL if none
20327 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20334 * @defgroup Slideshow Slideshow
20336 * @image html img/widget/slideshow/preview-00.png
20337 * @image latex img/widget/slideshow/preview-00.eps
20339 * This widget, as the name indicates, is a pre-made image
20340 * slideshow panel, with API functions acting on (child) image
20341 * items presentation. Between those actions, are:
20342 * - advance to next/previous image
20343 * - select the style of image transition animation
20344 * - set the exhibition time for each image
20345 * - start/stop the slideshow
20347 * The transition animations are defined in the widget's theme,
20348 * consequently new animations can be added without having to
20349 * update the widget's code.
20351 * @section Slideshow_Items Slideshow items
20353 * For slideshow items, just like for @ref Genlist "genlist" ones,
20354 * the user defines a @b classes, specifying functions that will be
20355 * called on the item's creation and deletion times.
20357 * The #Elm_Slideshow_Item_Class structure contains the following
20360 * - @c func.get - When an item is displayed, this function is
20361 * called, and it's where one should create the item object, de
20362 * facto. For example, the object can be a pure Evas image object
20363 * or an Elementary @ref Photocam "photocam" widget. See
20364 * #SlideshowItemGetFunc.
20365 * - @c func.del - When an item is no more displayed, this function
20366 * is called, where the user must delete any data associated to
20367 * the item. See #SlideshowItemDelFunc.
20369 * @section Slideshow_Caching Slideshow caching
20371 * The slideshow provides facilities to have items adjacent to the
20372 * one being displayed <b>already "realized"</b> (i.e. loaded) for
20373 * you, so that the system does not have to decode image data
20374 * anymore at the time it has to actually switch images on its
20375 * viewport. The user is able to set the numbers of items to be
20376 * cached @b before and @b after the current item, in the widget's
20379 * Smart events one can add callbacks for are:
20381 * - @c "changed" - when the slideshow switches its view to a new
20384 * List of examples for the slideshow widget:
20385 * @li @ref slideshow_example
20389 * @addtogroup Slideshow
20393 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
20394 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
20395 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Slideshow item handle */
20396 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
20397 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
20400 * @struct _Elm_Slideshow_Item_Class
20402 * Slideshow item class definition. See @ref Slideshow_Items for
20405 struct _Elm_Slideshow_Item_Class
20407 struct _Elm_Slideshow_Item_Class_Func
20409 SlideshowItemGetFunc get;
20410 SlideshowItemDelFunc del;
20412 }; /**< #Elm_Slideshow_Item_Class member definitions */
20415 * Add a new slideshow widget to the given parent Elementary
20416 * (container) object
20418 * @param parent The parent object
20419 * @return A new slideshow widget handle or @c NULL, on errors
20421 * This function inserts a new slideshow widget on the canvas.
20423 * @ingroup Slideshow
20425 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20428 * Add (append) a new item in a given slideshow widget.
20430 * @param obj The slideshow object
20431 * @param itc The item class for the item
20432 * @param data The item's data
20433 * @return A handle to the item added or @c NULL, on errors
20435 * Add a new item to @p obj's internal list of items, appending it.
20436 * The item's class must contain the function really fetching the
20437 * image object to show for this item, which could be an Evas image
20438 * object or an Elementary photo, for example. The @p data
20439 * parameter is going to be passed to both class functions of the
20442 * @see #Elm_Slideshow_Item_Class
20443 * @see elm_slideshow_item_sorted_insert()
20445 * @ingroup Slideshow
20447 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
20450 * Insert a new item into the given slideshow widget, using the @p func
20451 * function to sort items (by item handles).
20453 * @param obj The slideshow object
20454 * @param itc The item class for the item
20455 * @param data The item's data
20456 * @param func The comparing function to be used to sort slideshow
20457 * items <b>by #Elm_Slideshow_Item item handles</b>
20458 * @return Returns The slideshow item handle, on success, or
20459 * @c NULL, on errors
20461 * Add a new item to @p obj's internal list of items, in a position
20462 * determined by the @p func comparing function. The item's class
20463 * must contain the function really fetching the image object to
20464 * show for this item, which could be an Evas image object or an
20465 * Elementary photo, for example. The @p data parameter is going to
20466 * be passed to both class functions of the item.
20468 * @see #Elm_Slideshow_Item_Class
20469 * @see elm_slideshow_item_add()
20471 * @ingroup Slideshow
20473 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);
20476 * Display a given slideshow widget's item, programmatically.
20478 * @param obj The slideshow object
20479 * @param item The item to display on @p obj's viewport
20481 * The change between the current item and @p item will use the
20482 * transition @p obj is set to use (@see
20483 * elm_slideshow_transition_set()).
20485 * @ingroup Slideshow
20487 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20490 * Slide to the @b next item, in a given slideshow widget
20492 * @param obj The slideshow object
20494 * The sliding animation @p obj is set to use will be the
20495 * transition effect used, after this call is issued.
20497 * @note If the end of the slideshow's internal list of items is
20498 * reached, it'll wrap around to the list's beginning, again.
20500 * @ingroup Slideshow
20502 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20505 * Slide to the @b previous item, in a given slideshow widget
20507 * @param obj The slideshow object
20509 * The sliding animation @p obj is set to use will be the
20510 * transition effect used, after this call is issued.
20512 * @note If the beginning of the slideshow's internal list of items
20513 * is reached, it'll wrap around to the list's end, again.
20515 * @ingroup Slideshow
20517 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
20520 * Returns the list of sliding transition/effect names available, for a
20521 * given slideshow widget.
20523 * @param obj The slideshow object
20524 * @return The list of transitions (list of @b stringshared strings
20527 * The transitions, which come from @p obj's theme, must be an EDC
20528 * data item named @c "transitions" on the theme file, with (prefix)
20529 * names of EDC programs actually implementing them.
20531 * The available transitions for slideshows on the default theme are:
20532 * - @c "fade" - the current item fades out, while the new one
20533 * fades in to the slideshow's viewport.
20534 * - @c "black_fade" - the current item fades to black, and just
20535 * then, the new item will fade in.
20536 * - @c "horizontal" - the current item slides horizontally, until
20537 * it gets out of the slideshow's viewport, while the new item
20538 * comes from the left to take its place.
20539 * - @c "vertical" - the current item slides vertically, until it
20540 * gets out of the slideshow's viewport, while the new item comes
20541 * from the bottom to take its place.
20542 * - @c "square" - the new item starts to appear from the middle of
20543 * the current one, but with a tiny size, growing until its
20544 * target (full) size and covering the old one.
20546 * @warning The stringshared strings get no new references
20547 * exclusive to the user grabbing the list, here, so if you'd like
20548 * to use them out of this call's context, you'd better @c
20549 * eina_stringshare_ref() them.
20551 * @see elm_slideshow_transition_set()
20553 * @ingroup Slideshow
20555 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20558 * Set the current slide transition/effect in use for a given
20561 * @param obj The slideshow object
20562 * @param transition The new transition's name string
20564 * If @p transition is implemented in @p obj's theme (i.e., is
20565 * contained in the list returned by
20566 * elm_slideshow_transitions_get()), this new sliding effect will
20567 * be used on the widget.
20569 * @see elm_slideshow_transitions_get() for more details
20571 * @ingroup Slideshow
20573 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
20576 * Get the current slide transition/effect in use for a given
20579 * @param obj The slideshow object
20580 * @return The current transition's name
20582 * @see elm_slideshow_transition_set() for more details
20584 * @ingroup Slideshow
20586 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20589 * Set the interval between each image transition on a given
20590 * slideshow widget, <b>and start the slideshow, itself</b>
20592 * @param obj The slideshow object
20593 * @param timeout The new displaying timeout for images
20595 * After this call, the slideshow widget will start cycling its
20596 * view, sequentially and automatically, with the images of the
20597 * items it has. The time between each new image displayed is going
20598 * to be @p timeout, in @b seconds. If a different timeout was set
20599 * previously and an slideshow was in progress, it will continue
20600 * with the new time between transitions, after this call.
20602 * @note A value less than or equal to 0 on @p timeout will disable
20603 * the widget's internal timer, thus halting any slideshow which
20604 * could be happening on @p obj.
20606 * @see elm_slideshow_timeout_get()
20608 * @ingroup Slideshow
20610 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
20613 * Get the interval set for image transitions on a given slideshow
20616 * @param obj The slideshow object
20617 * @return Returns the timeout set on it
20619 * @see elm_slideshow_timeout_set() for more details
20621 * @ingroup Slideshow
20623 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20626 * Set if, after a slideshow is started, for a given slideshow
20627 * widget, its items should be displayed cyclically or not.
20629 * @param obj The slideshow object
20630 * @param loop Use @c EINA_TRUE to make it cycle through items or
20631 * @c EINA_FALSE for it to stop at the end of @p obj's internal
20634 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
20635 * ignore what is set by this functions, i.e., they'll @b always
20636 * cycle through items. This affects only the "automatic"
20637 * slideshow, as set by elm_slideshow_timeout_set().
20639 * @see elm_slideshow_loop_get()
20641 * @ingroup Slideshow
20643 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
20646 * Get if, after a slideshow is started, for a given slideshow
20647 * widget, its items are to be displayed cyclically or not.
20649 * @param obj The slideshow object
20650 * @return @c EINA_TRUE, if the items in @p obj will be cycled
20651 * through or @c EINA_FALSE, otherwise
20653 * @see elm_slideshow_loop_set() for more details
20655 * @ingroup Slideshow
20657 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20660 * Remove all items from a given slideshow widget
20662 * @param obj The slideshow object
20664 * This removes (and deletes) all items in @p obj, leaving it
20667 * @see elm_slideshow_item_del(), to remove just one item.
20669 * @ingroup Slideshow
20671 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20674 * Get the internal list of items in a given slideshow widget.
20676 * @param obj The slideshow object
20677 * @return The list of items (#Elm_Slideshow_Item as data) or
20678 * @c NULL on errors.
20680 * This list is @b not to be modified in any way and must not be
20681 * freed. Use the list members with functions like
20682 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
20684 * @warning This list is only valid until @p obj object's internal
20685 * items list is changed. It should be fetched again with another
20686 * call to this function when changes happen.
20688 * @ingroup Slideshow
20690 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20693 * Delete a given item from a slideshow widget.
20695 * @param item The slideshow item
20697 * @ingroup Slideshow
20699 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20702 * Return the data associated with a given slideshow item
20704 * @param item The slideshow item
20705 * @return Returns the data associated to this item
20707 * @ingroup Slideshow
20709 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20712 * Returns the currently displayed item, in a given slideshow widget
20714 * @param obj The slideshow object
20715 * @return A handle to the item being displayed in @p obj or
20716 * @c NULL, if none is (and on errors)
20718 * @ingroup Slideshow
20720 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20723 * Get the real Evas object created to implement the view of a
20724 * given slideshow item
20726 * @param item The slideshow item.
20727 * @return the Evas object implementing this item's view.
20729 * This returns the actual Evas object used to implement the
20730 * specified slideshow item's view. This may be @c NULL, as it may
20731 * not have been created or may have been deleted, at any time, by
20732 * the slideshow. <b>Do not modify this object</b> (move, resize,
20733 * show, hide, etc.), as the slideshow is controlling it. This
20734 * function is for querying, emitting custom signals or hooking
20735 * lower level callbacks for events on that object. Do not delete
20736 * this object under any circumstances.
20738 * @see elm_slideshow_item_data_get()
20740 * @ingroup Slideshow
20742 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
20745 * Get the the item, in a given slideshow widget, placed at
20746 * position @p nth, in its internal items list
20748 * @param obj The slideshow object
20749 * @param nth The number of the item to grab a handle to (0 being
20751 * @return The item stored in @p obj at position @p nth or @c NULL,
20752 * if there's no item with that index (and on errors)
20754 * @ingroup Slideshow
20756 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
20759 * Set the current slide layout in use for a given slideshow widget
20761 * @param obj The slideshow object
20762 * @param layout The new layout's name string
20764 * If @p layout is implemented in @p obj's theme (i.e., is contained
20765 * in the list returned by elm_slideshow_layouts_get()), this new
20766 * images layout will be used on the widget.
20768 * @see elm_slideshow_layouts_get() for more details
20770 * @ingroup Slideshow
20772 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
20775 * Get the current slide layout in use for a given slideshow widget
20777 * @param obj The slideshow object
20778 * @return The current layout's name
20780 * @see elm_slideshow_layout_set() for more details
20782 * @ingroup Slideshow
20784 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20787 * Returns the list of @b layout names available, for a given
20788 * slideshow widget.
20790 * @param obj The slideshow object
20791 * @return The list of layouts (list of @b stringshared strings
20794 * Slideshow layouts will change how the widget is to dispose each
20795 * image item in its viewport, with regard to cropping, scaling,
20798 * The layouts, which come from @p obj's theme, must be an EDC
20799 * data item name @c "layouts" on the theme file, with (prefix)
20800 * names of EDC programs actually implementing them.
20802 * The available layouts for slideshows on the default theme are:
20803 * - @c "fullscreen" - item images with original aspect, scaled to
20804 * touch top and down slideshow borders or, if the image's heigh
20805 * is not enough, left and right slideshow borders.
20806 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
20807 * one, but always leaving 10% of the slideshow's dimensions of
20808 * distance between the item image's borders and the slideshow
20809 * borders, for each axis.
20811 * @warning The stringshared strings get no new references
20812 * exclusive to the user grabbing the list, here, so if you'd like
20813 * to use them out of this call's context, you'd better @c
20814 * eina_stringshare_ref() them.
20816 * @see elm_slideshow_layout_set()
20818 * @ingroup Slideshow
20820 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20823 * Set the number of items to cache, on a given slideshow widget,
20824 * <b>before the current item</b>
20826 * @param obj The slideshow object
20827 * @param count Number of items to cache before the current one
20829 * The default value for this property is @c 2. See
20830 * @ref Slideshow_Caching "slideshow caching" for more details.
20832 * @see elm_slideshow_cache_before_get()
20834 * @ingroup Slideshow
20836 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20839 * Retrieve the number of items to cache, on a given slideshow widget,
20840 * <b>before the current item</b>
20842 * @param obj The slideshow object
20843 * @return The number of items set to be cached before the current one
20845 * @see elm_slideshow_cache_before_set() for more details
20847 * @ingroup Slideshow
20849 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20852 * Set the number of items to cache, on a given slideshow widget,
20853 * <b>after the current item</b>
20855 * @param obj The slideshow object
20856 * @param count Number of items to cache after the current one
20858 * The default value for this property is @c 2. See
20859 * @ref Slideshow_Caching "slideshow caching" for more details.
20861 * @see elm_slideshow_cache_after_get()
20863 * @ingroup Slideshow
20865 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20868 * Retrieve the number of items to cache, on a given slideshow widget,
20869 * <b>after the current item</b>
20871 * @param obj The slideshow object
20872 * @return The number of items set to be cached after the current one
20874 * @see elm_slideshow_cache_after_set() for more details
20876 * @ingroup Slideshow
20878 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20881 * Get the number of items stored in a given slideshow widget
20883 * @param obj The slideshow object
20884 * @return The number of items on @p obj, at the moment of this call
20886 * @ingroup Slideshow
20888 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20895 * @defgroup Fileselector File Selector
20897 * @image html img/widget/fileselector/preview-00.png
20898 * @image latex img/widget/fileselector/preview-00.eps
20900 * A file selector is a widget that allows a user to navigate
20901 * through a file system, reporting file selections back via its
20904 * It contains shortcut buttons for home directory (@c ~) and to
20905 * jump one directory upwards (..), as well as cancel/ok buttons to
20906 * confirm/cancel a given selection. After either one of those two
20907 * former actions, the file selector will issue its @c "done" smart
20910 * There's a text entry on it, too, showing the name of the current
20911 * selection. There's the possibility of making it editable, so it
20912 * is useful on file saving dialogs on applications, where one
20913 * gives a file name to save contents to, in a given directory in
20914 * the system. This custom file name will be reported on the @c
20915 * "done" smart callback (explained in sequence).
20917 * Finally, it has a view to display file system items into in two
20922 * If Elementary is built with support of the Ethumb thumbnailing
20923 * library, the second form of view will display preview thumbnails
20924 * of files which it supports.
20926 * Smart callbacks one can register to:
20928 * - @c "selected" - the user has clicked on a file (when not in
20929 * folders-only mode) or directory (when in folders-only mode)
20930 * - @c "directory,open" - the list has been populated with new
20931 * content (@c event_info is a pointer to the directory's
20932 * path, a @b stringshared string)
20933 * - @c "done" - the user has clicked on the "ok" or "cancel"
20934 * buttons (@c event_info is a pointer to the selection's
20935 * path, a @b stringshared string)
20937 * Here is an example on its usage:
20938 * @li @ref fileselector_example
20942 * @addtogroup Fileselector
20947 * Defines how a file selector widget is to layout its contents
20948 * (file system entries).
20950 typedef enum _Elm_Fileselector_Mode
20952 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
20953 ELM_FILESELECTOR_GRID, /**< layout as a grid */
20954 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
20955 } Elm_Fileselector_Mode;
20958 * Add a new file selector widget to the given parent Elementary
20959 * (container) object
20961 * @param parent The parent object
20962 * @return a new file selector widget handle or @c NULL, on errors
20964 * This function inserts a new file selector widget on the canvas.
20966 * @ingroup Fileselector
20968 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20971 * Enable/disable the file name entry box where the user can type
20972 * in a name for a file, in a given file selector widget
20974 * @param obj The file selector object
20975 * @param is_save @c EINA_TRUE to make the file selector a "saving
20976 * dialog", @c EINA_FALSE otherwise
20978 * Having the entry editable is useful on file saving dialogs on
20979 * applications, where one gives a file name to save contents to,
20980 * in a given directory in the system. This custom file name will
20981 * be reported on the @c "done" smart callback.
20983 * @see elm_fileselector_is_save_get()
20985 * @ingroup Fileselector
20987 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
20990 * Get whether the given file selector is in "saving dialog" mode
20992 * @param obj The file selector object
20993 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
20994 * mode, @c EINA_FALSE otherwise (and on errors)
20996 * @see elm_fileselector_is_save_set() for more details
20998 * @ingroup Fileselector
21000 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21003 * Enable/disable folder-only view for a given file selector widget
21005 * @param obj The file selector object
21006 * @param only @c EINA_TRUE to make @p obj only display
21007 * directories, @c EINA_FALSE to make files to be displayed in it
21010 * If enabled, the widget's view will only display folder items,
21013 * @see elm_fileselector_folder_only_get()
21015 * @ingroup Fileselector
21017 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
21020 * Get whether folder-only view is set for a given file selector
21023 * @param obj The file selector object
21024 * @return only @c EINA_TRUE if @p obj is only displaying
21025 * directories, @c EINA_FALSE if files are being displayed in it
21026 * too (and on errors)
21028 * @see elm_fileselector_folder_only_get()
21030 * @ingroup Fileselector
21032 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21035 * Enable/disable the "ok" and "cancel" buttons on a given file
21038 * @param obj The file selector object
21039 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
21041 * @note A file selector without those buttons will never emit the
21042 * @c "done" smart event, and is only usable if one is just hooking
21043 * to the other two events.
21045 * @see elm_fileselector_buttons_ok_cancel_get()
21047 * @ingroup Fileselector
21049 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
21052 * Get whether the "ok" and "cancel" buttons on a given file
21053 * selector widget are being shown.
21055 * @param obj The file selector object
21056 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
21057 * otherwise (and on errors)
21059 * @see elm_fileselector_buttons_ok_cancel_set() for more details
21061 * @ingroup Fileselector
21063 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21066 * Enable/disable a tree view in the given file selector widget,
21067 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
21069 * @param obj The file selector object
21070 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
21073 * In a tree view, arrows are created on the sides of directories,
21074 * allowing them to expand in place.
21076 * @note If it's in other mode, the changes made by this function
21077 * will only be visible when one switches back to "list" mode.
21079 * @see elm_fileselector_expandable_get()
21081 * @ingroup Fileselector
21083 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
21086 * Get whether tree view is enabled for the given file selector
21089 * @param obj The file selector object
21090 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
21091 * otherwise (and or errors)
21093 * @see elm_fileselector_expandable_set() for more details
21095 * @ingroup Fileselector
21097 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21100 * Set, programmatically, the @b directory that a given file
21101 * selector widget will display contents from
21103 * @param obj The file selector object
21104 * @param path The path to display in @p obj
21106 * This will change the @b directory that @p obj is displaying. It
21107 * will also clear the text entry area on the @p obj object, which
21108 * displays select files' names.
21110 * @see elm_fileselector_path_get()
21112 * @ingroup Fileselector
21114 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
21117 * Get the parent directory's path that a given file selector
21118 * widget is displaying
21120 * @param obj The file selector object
21121 * @return The (full) path of the directory the file selector is
21122 * displaying, a @b stringshared string
21124 * @see elm_fileselector_path_set()
21126 * @ingroup Fileselector
21128 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21131 * Set, programmatically, the currently selected file/directory in
21132 * the given file selector widget
21134 * @param obj The file selector object
21135 * @param path The (full) path to a file or directory
21136 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
21137 * latter case occurs if the directory or file pointed to do not
21140 * @see elm_fileselector_selected_get()
21142 * @ingroup Fileselector
21144 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
21147 * Get the currently selected item's (full) path, in the given file
21150 * @param obj The file selector object
21151 * @return The absolute path of the selected item, a @b
21152 * stringshared string
21154 * @note Custom editions on @p obj object's text entry, if made,
21155 * will appear on the return string of this function, naturally.
21157 * @see elm_fileselector_selected_set() for more details
21159 * @ingroup Fileselector
21161 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21164 * Set the mode in which a given file selector widget will display
21165 * (layout) file system entries in its view
21167 * @param obj The file selector object
21168 * @param mode The mode of the fileselector, being it one of
21169 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
21170 * first one, naturally, will display the files in a list. The
21171 * latter will make the widget to display its entries in a grid
21174 * @note By using elm_fileselector_expandable_set(), the user may
21175 * trigger a tree view for that list.
21177 * @note If Elementary is built with support of the Ethumb
21178 * thumbnailing library, the second form of view will display
21179 * preview thumbnails of files which it supports. You must have
21180 * elm_need_ethumb() called in your Elementary for thumbnailing to
21183 * @see elm_fileselector_expandable_set().
21184 * @see elm_fileselector_mode_get().
21186 * @ingroup Fileselector
21188 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
21191 * Get the mode in which a given file selector widget is displaying
21192 * (layouting) file system entries in its view
21194 * @param obj The fileselector object
21195 * @return The mode in which the fileselector is at
21197 * @see elm_fileselector_mode_set() for more details
21199 * @ingroup Fileselector
21201 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21208 * @defgroup Progressbar Progress bar
21210 * The progress bar is a widget for visually representing the
21211 * progress status of a given job/task.
21213 * A progress bar may be horizontal or vertical. It may display an
21214 * icon besides it, as well as primary and @b units labels. The
21215 * former is meant to label the widget as a whole, while the
21216 * latter, which is formatted with floating point values (and thus
21217 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
21218 * units"</c>), is meant to label the widget's <b>progress
21219 * value</b>. Label, icon and unit strings/objects are @b optional
21220 * for progress bars.
21222 * A progress bar may be @b inverted, in which state it gets its
21223 * values inverted, with high values being on the left or top and
21224 * low values on the right or bottom, as opposed to normally have
21225 * the low values on the former and high values on the latter,
21226 * respectively, for horizontal and vertical modes.
21228 * The @b span of the progress, as set by
21229 * elm_progressbar_span_size_set(), is its length (horizontally or
21230 * vertically), unless one puts size hints on the widget to expand
21231 * on desired directions, by any container. That length will be
21232 * scaled by the object or applications scaling factor. At any
21233 * point code can query the progress bar for its value with
21234 * elm_progressbar_value_get().
21236 * Available widget styles for progress bars:
21238 * - @c "wheel" (simple style, no text, no progression, only
21239 * "pulse" effect is available)
21241 * Default contents parts of the progressbar widget that you can use for are:
21242 * @li "icon" - A icon of the progressbar
21244 * Here is an example on its usage:
21245 * @li @ref progressbar_example
21249 * Add a new progress bar widget to the given parent Elementary
21250 * (container) object
21252 * @param parent The parent object
21253 * @return a new progress bar widget handle or @c NULL, on errors
21255 * This function inserts a new progress bar widget on the canvas.
21257 * @ingroup Progressbar
21259 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21262 * Set whether a given progress bar widget is at "pulsing mode" or
21265 * @param obj The progress bar object
21266 * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
21267 * @c EINA_FALSE to put it back to its default one
21269 * By default, progress bars will display values from the low to
21270 * high value boundaries. There are, though, contexts in which the
21271 * state of progression of a given task is @b unknown. For those,
21272 * one can set a progress bar widget to a "pulsing state", to give
21273 * the user an idea that some computation is being held, but
21274 * without exact progress values. In the default theme it will
21275 * animate its bar with the contents filling in constantly and back
21276 * to non-filled, in a loop. To start and stop this pulsing
21277 * animation, one has to explicitly call elm_progressbar_pulse().
21279 * @see elm_progressbar_pulse_get()
21280 * @see elm_progressbar_pulse()
21282 * @ingroup Progressbar
21284 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
21287 * Get whether a given progress bar widget is at "pulsing mode" or
21290 * @param obj The progress bar object
21291 * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
21292 * if it's in the default one (and on errors)
21294 * @ingroup Progressbar
21296 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21299 * Start/stop a given progress bar "pulsing" animation, if its
21302 * @param obj The progress bar object
21303 * @param state @c EINA_TRUE, to @b start the pulsing animation,
21304 * @c EINA_FALSE to @b stop it
21306 * @note This call won't do anything if @p obj is not under "pulsing mode".
21308 * @see elm_progressbar_pulse_set() for more details.
21310 * @ingroup Progressbar
21312 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
21315 * Set the progress value (in percentage) on a given progress bar
21318 * @param obj The progress bar object
21319 * @param val The progress value (@b must be between @c 0.0 and @c
21322 * Use this call to set progress bar levels.
21324 * @note If you passes a value out of the specified range for @p
21325 * val, it will be interpreted as the @b closest of the @b boundary
21326 * values in the range.
21328 * @ingroup Progressbar
21330 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21333 * Get the progress value (in percentage) on a given progress bar
21336 * @param obj The progress bar object
21337 * @return The value of the progressbar
21339 * @see elm_progressbar_value_set() for more details
21341 * @ingroup Progressbar
21343 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21346 * Set the label of a given progress bar widget
21348 * @param obj The progress bar object
21349 * @param label The text label string, in UTF-8
21351 * @ingroup Progressbar
21352 * @deprecated use elm_object_text_set() instead.
21354 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
21357 * Get the label of a given progress bar widget
21359 * @param obj The progressbar object
21360 * @return The text label string, in UTF-8
21362 * @ingroup Progressbar
21363 * @deprecated use elm_object_text_set() instead.
21365 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21368 * Set the icon object of a given progress bar widget
21370 * @param obj The progress bar object
21371 * @param icon The icon object
21373 * Use this call to decorate @p obj with an icon next to it.
21375 * @note Once the icon object is set, a previously set one will be
21376 * deleted. If you want to keep that old content object, use the
21377 * elm_progressbar_icon_unset() function.
21379 * @see elm_progressbar_icon_get()
21380 * @deprecated use elm_object_part_content_set() instead.
21382 * @ingroup Progressbar
21384 EINA_DEPRECATED EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
21387 * Retrieve the icon object set for a given progress bar widget
21389 * @param obj The progress bar object
21390 * @return The icon object's handle, if @p obj had one set, or @c NULL,
21391 * otherwise (and on errors)
21393 * @see elm_progressbar_icon_set() for more details
21394 * @deprecated use elm_object_part_content_get() instead.
21396 * @ingroup Progressbar
21398 EINA_DEPRECATED EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21401 * Unset an icon set on a given progress bar widget
21403 * @param obj The progress bar object
21404 * @return The icon object that was being used, if any was set, or
21405 * @c NULL, otherwise (and on errors)
21407 * This call will unparent and return the icon object which was set
21408 * for this widget, previously, on success.
21410 * @see elm_progressbar_icon_set() for more details
21411 * @deprecated use elm_object_part_content_unset() instead.
21413 * @ingroup Progressbar
21415 EINA_DEPRECATED EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
21418 * Set the (exact) length of the bar region of a given progress bar
21421 * @param obj The progress bar object
21422 * @param size The length of the progress bar's bar region
21424 * This sets the minimum width (when in horizontal mode) or height
21425 * (when in vertical mode) of the actual bar area of the progress
21426 * bar @p obj. This in turn affects the object's minimum size. Use
21427 * this when you're not setting other size hints expanding on the
21428 * given direction (like weight and alignment hints) and you would
21429 * like it to have a specific size.
21431 * @note Icon, label and unit text around @p obj will require their
21432 * own space, which will make @p obj to require more the @p size,
21435 * @see elm_progressbar_span_size_get()
21437 * @ingroup Progressbar
21439 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
21442 * Get the length set for the bar region of a given progress bar
21445 * @param obj The progress bar object
21446 * @return The length of the progress bar's bar region
21448 * If that size was not set previously, with
21449 * elm_progressbar_span_size_set(), this call will return @c 0.
21451 * @ingroup Progressbar
21453 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21456 * Set the format string for a given progress bar widget's units
21459 * @param obj The progress bar object
21460 * @param format The format string for @p obj's units label
21462 * If @c NULL is passed on @p format, it will make @p obj's units
21463 * area to be hidden completely. If not, it'll set the <b>format
21464 * string</b> for the units label's @b text. The units label is
21465 * provided a floating point value, so the units text is up display
21466 * at most one floating point falue. Note that the units label is
21467 * optional. Use a format string such as "%1.2f meters" for
21470 * @note The default format string for a progress bar is an integer
21471 * percentage, as in @c "%.0f %%".
21473 * @see elm_progressbar_unit_format_get()
21475 * @ingroup Progressbar
21477 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
21480 * Retrieve the format string set for a given progress bar widget's
21483 * @param obj The progress bar object
21484 * @return The format set string for @p obj's units label or
21485 * @c NULL, if none was set (and on errors)
21487 * @see elm_progressbar_unit_format_set() for more details
21489 * @ingroup Progressbar
21491 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21494 * Set the orientation of a given progress bar widget
21496 * @param obj The progress bar object
21497 * @param horizontal Use @c EINA_TRUE to make @p obj to be
21498 * @b horizontal, @c EINA_FALSE to make it @b vertical
21500 * Use this function to change how your progress bar is to be
21501 * disposed: vertically or horizontally.
21503 * @see elm_progressbar_horizontal_get()
21505 * @ingroup Progressbar
21507 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21510 * Retrieve the orientation of a given progress bar widget
21512 * @param obj The progress bar object
21513 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
21514 * @c EINA_FALSE if it's @b vertical (and on errors)
21516 * @see elm_progressbar_horizontal_set() for more details
21518 * @ingroup Progressbar
21520 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21523 * Invert a given progress bar widget's displaying values order
21525 * @param obj The progress bar object
21526 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
21527 * @c EINA_FALSE to bring it back to default, non-inverted values.
21529 * A progress bar may be @b inverted, in which state it gets its
21530 * values inverted, with high values being on the left or top and
21531 * low values on the right or bottom, as opposed to normally have
21532 * the low values on the former and high values on the latter,
21533 * respectively, for horizontal and vertical modes.
21535 * @see elm_progressbar_inverted_get()
21537 * @ingroup Progressbar
21539 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
21542 * Get whether a given progress bar widget's displaying values are
21545 * @param obj The progress bar object
21546 * @return @c EINA_TRUE, if @p obj has inverted values,
21547 * @c EINA_FALSE otherwise (and on errors)
21549 * @see elm_progressbar_inverted_set() for more details
21551 * @ingroup Progressbar
21553 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21556 * @defgroup Separator Separator
21558 * @brief Separator is a very thin object used to separate other objects.
21560 * A separator can be vertical or horizontal.
21562 * @ref tutorial_separator is a good example of how to use a separator.
21566 * @brief Add a separator object to @p parent
21568 * @param parent The parent object
21570 * @return The separator object, or NULL upon failure
21572 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21574 * @brief Set the horizontal mode of a separator object
21576 * @param obj The separator object
21577 * @param horizontal If true, the separator is horizontal
21579 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21581 * @brief Get the horizontal mode of a separator object
21583 * @param obj The separator object
21584 * @return If true, the separator is horizontal
21586 * @see elm_separator_horizontal_set()
21588 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21594 * @defgroup Spinner Spinner
21595 * @ingroup Elementary
21597 * @image html img/widget/spinner/preview-00.png
21598 * @image latex img/widget/spinner/preview-00.eps
21600 * A spinner is a widget which allows the user to increase or decrease
21601 * numeric values using arrow buttons, or edit values directly, clicking
21602 * over it and typing the new value.
21604 * By default the spinner will not wrap and has a label
21605 * of "%.0f" (just showing the integer value of the double).
21607 * A spinner has a label that is formatted with floating
21608 * point values and thus accepts a printf-style format string, like
21609 * ā%1.2f unitsā.
21611 * It also allows specific values to be replaced by pre-defined labels.
21613 * Smart callbacks one can register to:
21615 * - "changed" - Whenever the spinner value is changed.
21616 * - "delay,changed" - A short time after the value is changed by the user.
21617 * This will be called only when the user stops dragging for a very short
21618 * period or when they release their finger/mouse, so it avoids possibly
21619 * expensive reactions to the value change.
21621 * Available styles for it:
21623 * - @c "vertical": up/down buttons at the right side and text left aligned.
21625 * Here is an example on its usage:
21626 * @ref spinner_example
21630 * @addtogroup Spinner
21635 * Add a new spinner widget to the given parent Elementary
21636 * (container) object.
21638 * @param parent The parent object.
21639 * @return a new spinner widget handle or @c NULL, on errors.
21641 * This function inserts a new spinner widget on the canvas.
21646 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21649 * Set the format string of the displayed label.
21651 * @param obj The spinner object.
21652 * @param fmt The format string for the label display.
21654 * If @c NULL, this sets the format to "%.0f". If not it sets the format
21655 * string for the label text. The label text is provided a floating point
21656 * value, so the label text can display up to 1 floating point value.
21657 * Note that this is optional.
21659 * Use a format string such as "%1.2f meters" for example, and it will
21660 * display values like: "3.14 meters" for a value equal to 3.14159.
21662 * Default is "%0.f".
21664 * @see elm_spinner_label_format_get()
21668 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
21671 * Get the label format of the spinner.
21673 * @param obj The spinner object.
21674 * @return The text label format string in UTF-8.
21676 * @see elm_spinner_label_format_set() for details.
21680 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21683 * Set the minimum and maximum values for the spinner.
21685 * @param obj The spinner object.
21686 * @param min The minimum value.
21687 * @param max The maximum value.
21689 * Define the allowed range of values to be selected by the user.
21691 * If actual value is less than @p min, it will be updated to @p min. If it
21692 * is bigger then @p max, will be updated to @p max. Actual value can be
21693 * get with elm_spinner_value_get().
21695 * By default, min is equal to 0, and max is equal to 100.
21697 * @warning Maximum must be greater than minimum.
21699 * @see elm_spinner_min_max_get()
21703 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
21706 * Get the minimum and maximum values of the spinner.
21708 * @param obj The spinner object.
21709 * @param min Pointer where to store the minimum value.
21710 * @param max Pointer where to store the maximum value.
21712 * @note If only one value is needed, the other pointer can be passed
21715 * @see elm_spinner_min_max_set() for details.
21719 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
21722 * Set the step used to increment or decrement the spinner value.
21724 * @param obj The spinner object.
21725 * @param step The step value.
21727 * This value will be incremented or decremented to the displayed value.
21728 * It will be incremented while the user keep right or top arrow pressed,
21729 * and will be decremented while the user keep left or bottom arrow pressed.
21731 * The interval to increment / decrement can be set with
21732 * elm_spinner_interval_set().
21734 * By default step value is equal to 1.
21736 * @see elm_spinner_step_get()
21740 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
21743 * Get the step used to increment or decrement the spinner value.
21745 * @param obj The spinner object.
21746 * @return The step value.
21748 * @see elm_spinner_step_get() for more details.
21752 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21755 * Set the value the spinner displays.
21757 * @param obj The spinner object.
21758 * @param val The value to be displayed.
21760 * Value will be presented on the label following format specified with
21761 * elm_spinner_format_set().
21763 * @warning The value must to be between min and max values. This values
21764 * are set by elm_spinner_min_max_set().
21766 * @see elm_spinner_value_get().
21767 * @see elm_spinner_format_set().
21768 * @see elm_spinner_min_max_set().
21772 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21775 * Get the value displayed by the spinner.
21777 * @param obj The spinner object.
21778 * @return The value displayed.
21780 * @see elm_spinner_value_set() for details.
21784 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21787 * Set whether the spinner should wrap when it reaches its
21788 * minimum or maximum value.
21790 * @param obj The spinner object.
21791 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
21794 * Disabled by default. If disabled, when the user tries to increment the
21796 * but displayed value plus step value is bigger than maximum value,
21798 * won't allow it. The same happens when the user tries to decrement it,
21799 * but the value less step is less than minimum value.
21801 * When wrap is enabled, in such situations it will allow these changes,
21802 * but will get the value that would be less than minimum and subtracts
21803 * from maximum. Or add the value that would be more than maximum to
21807 * @li min value = 10
21808 * @li max value = 50
21809 * @li step value = 20
21810 * @li displayed value = 20
21812 * When the user decrement value (using left or bottom arrow), it will
21813 * displays @c 40, because max - (min - (displayed - step)) is
21814 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
21816 * @see elm_spinner_wrap_get().
21820 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
21823 * Get whether the spinner should wrap when it reaches its
21824 * minimum or maximum value.
21826 * @param obj The spinner object
21827 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
21828 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21830 * @see elm_spinner_wrap_set() for details.
21834 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21837 * Set whether the spinner can be directly edited by the user or not.
21839 * @param obj The spinner object.
21840 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
21841 * don't allow users to edit it directly.
21843 * Spinner objects can have edition @b disabled, in which state they will
21844 * be changed only by arrows.
21845 * Useful for contexts
21846 * where you don't want your users to interact with it writting the value.
21848 * when using special values, the user can see real value instead
21849 * of special label on edition.
21851 * It's enabled by default.
21853 * @see elm_spinner_editable_get()
21857 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
21860 * Get whether the spinner can be directly edited by the user or not.
21862 * @param obj The spinner object.
21863 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
21864 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21866 * @see elm_spinner_editable_set() for details.
21870 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21873 * Set a special string to display in the place of the numerical value.
21875 * @param obj The spinner object.
21876 * @param value The value to be replaced.
21877 * @param label The label to be used.
21879 * It's useful for cases when a user should select an item that is
21880 * better indicated by a label than a value. For example, weekdays or months.
21884 * sp = elm_spinner_add(win);
21885 * elm_spinner_min_max_set(sp, 1, 3);
21886 * elm_spinner_special_value_add(sp, 1, "January");
21887 * elm_spinner_special_value_add(sp, 2, "February");
21888 * elm_spinner_special_value_add(sp, 3, "March");
21889 * evas_object_show(sp);
21894 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
21897 * Set the interval on time updates for an user mouse button hold
21898 * on spinner widgets' arrows.
21900 * @param obj The spinner object.
21901 * @param interval The (first) interval value in seconds.
21903 * This interval value is @b decreased while the user holds the
21904 * mouse pointer either incrementing or decrementing spinner's value.
21906 * This helps the user to get to a given value distant from the
21907 * current one easier/faster, as it will start to change quicker and
21908 * quicker on mouse button holds.
21910 * The calculation for the next change interval value, starting from
21911 * the one set with this call, is the previous interval divided by
21912 * @c 1.05, so it decreases a little bit.
21914 * The default starting interval value for automatic changes is
21917 * @see elm_spinner_interval_get()
21921 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21924 * Get the interval on time updates for an user mouse button hold
21925 * on spinner widgets' arrows.
21927 * @param obj The spinner object.
21928 * @return The (first) interval value, in seconds, set on it.
21930 * @see elm_spinner_interval_set() for more details.
21934 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21941 * @defgroup Index Index
21943 * @image html img/widget/index/preview-00.png
21944 * @image latex img/widget/index/preview-00.eps
21946 * An index widget gives you an index for fast access to whichever
21947 * group of other UI items one might have. It's a list of text
21948 * items (usually letters, for alphabetically ordered access).
21950 * Index widgets are by default hidden and just appear when the
21951 * user clicks over it's reserved area in the canvas. In its
21952 * default theme, it's an area one @ref Fingers "finger" wide on
21953 * the right side of the index widget's container.
21955 * When items on the index are selected, smart callbacks get
21956 * called, so that its user can make other container objects to
21957 * show a given area or child object depending on the index item
21958 * selected. You'd probably be using an index together with @ref
21959 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
21962 * Smart events one can add callbacks for are:
21963 * - @c "changed" - When the selected index item changes. @c
21964 * event_info is the selected item's data pointer.
21965 * - @c "delay,changed" - When the selected index item changes, but
21966 * after a small idling period. @c event_info is the selected
21967 * item's data pointer.
21968 * - @c "selected" - When the user releases a mouse button and
21969 * selects an item. @c event_info is the selected item's data
21971 * - @c "level,up" - when the user moves a finger from the first
21972 * level to the second level
21973 * - @c "level,down" - when the user moves a finger from the second
21974 * level to the first level
21976 * The @c "delay,changed" event is so that it'll wait a small time
21977 * before actually reporting those events and, moreover, just the
21978 * last event happening on those time frames will actually be
21981 * Here are some examples on its usage:
21982 * @li @ref index_example_01
21983 * @li @ref index_example_02
21987 * @addtogroup Index
21991 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
21994 * Add a new index widget to the given parent Elementary
21995 * (container) object
21997 * @param parent The parent object
21998 * @return a new index widget handle or @c NULL, on errors
22000 * This function inserts a new index widget on the canvas.
22004 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22007 * Set whether a given index widget is or not visible,
22010 * @param obj The index object
22011 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
22013 * Not to be confused with visible as in @c evas_object_show() --
22014 * visible with regard to the widget's auto hiding feature.
22016 * @see elm_index_active_get()
22020 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
22023 * Get whether a given index widget is currently visible or not.
22025 * @param obj The index object
22026 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
22028 * @see elm_index_active_set() for more details
22032 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22035 * Set the items level for a given index widget.
22037 * @param obj The index object.
22038 * @param level @c 0 or @c 1, the currently implemented levels.
22040 * @see elm_index_item_level_get()
22044 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22047 * Get the items level set for a given index widget.
22049 * @param obj The index object.
22050 * @return @c 0 or @c 1, which are the levels @p obj might be at.
22052 * @see elm_index_item_level_set() for more information
22056 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22059 * Returns the last selected item's data, for a given index widget.
22061 * @param obj The index object.
22062 * @return The item @b data associated to the last selected item on
22063 * @p obj (or @c NULL, on errors).
22065 * @warning The returned value is @b not an #Elm_Index_Item item
22066 * handle, but the data associated to it (see the @c item parameter
22067 * in elm_index_item_append(), as an example).
22071 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22074 * Append a new item on a given index widget.
22076 * @param obj The index object.
22077 * @param letter Letter under which the item should be indexed
22078 * @param item The item data to set for the index's item
22080 * Despite the most common usage of the @p letter argument is for
22081 * single char strings, one could use arbitrary strings as index
22084 * @c item will be the pointer returned back on @c "changed", @c
22085 * "delay,changed" and @c "selected" smart events.
22089 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
22092 * Prepend a new item on a given index widget.
22094 * @param obj The index object.
22095 * @param letter Letter under which the item should be indexed
22096 * @param item The item data to set for the index's item
22098 * Despite the most common usage of the @p letter argument is for
22099 * single char strings, one could use arbitrary strings as index
22102 * @c item will be the pointer returned back on @c "changed", @c
22103 * "delay,changed" and @c "selected" smart events.
22107 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
22110 * Append a new item, on a given index widget, <b>after the item
22111 * having @p relative as data</b>.
22113 * @param obj The index object.
22114 * @param letter Letter under which the item should be indexed
22115 * @param item The item data to set for the index's item
22116 * @param relative The item data of the index item to be the
22117 * predecessor of this new one
22119 * Despite the most common usage of the @p letter argument is for
22120 * single char strings, one could use arbitrary strings as index
22123 * @c item will be the pointer returned back on @c "changed", @c
22124 * "delay,changed" and @c "selected" smart events.
22126 * @note If @p relative is @c NULL or if it's not found to be data
22127 * set on any previous item on @p obj, this function will behave as
22128 * elm_index_item_append().
22132 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
22135 * Prepend a new item, on a given index widget, <b>after the item
22136 * having @p relative as data</b>.
22138 * @param obj The index object.
22139 * @param letter Letter under which the item should be indexed
22140 * @param item The item data to set for the index's item
22141 * @param relative The item data of the index item to be the
22142 * successor of this new one
22144 * Despite the most common usage of the @p letter argument is for
22145 * single char strings, one could use arbitrary strings as index
22148 * @c item will be the pointer returned back on @c "changed", @c
22149 * "delay,changed" and @c "selected" smart events.
22151 * @note If @p relative is @c NULL or if it's not found to be data
22152 * set on any previous item on @p obj, this function will behave as
22153 * elm_index_item_prepend().
22157 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
22160 * Insert a new item into the given index widget, using @p cmp_func
22161 * function to sort items (by item handles).
22163 * @param obj The index object.
22164 * @param letter Letter under which the item should be indexed
22165 * @param item The item data to set for the index's item
22166 * @param cmp_func The comparing function to be used to sort index
22167 * items <b>by #Elm_Index_Item item handles</b>
22168 * @param cmp_data_func A @b fallback function to be called for the
22169 * sorting of index items <b>by item data</b>). It will be used
22170 * when @p cmp_func returns @c 0 (equality), which means an index
22171 * item with provided item data already exists. To decide which
22172 * data item should be pointed to by the index item in question, @p
22173 * cmp_data_func will be used. If @p cmp_data_func returns a
22174 * non-negative value, the previous index item data will be
22175 * replaced by the given @p item pointer. If the previous data need
22176 * to be freed, it should be done by the @p cmp_data_func function,
22177 * because all references to it will be lost. If this function is
22178 * not provided (@c NULL is given), index items will be @b
22179 * duplicated, if @p cmp_func returns @c 0.
22181 * Despite the most common usage of the @p letter argument is for
22182 * single char strings, one could use arbitrary strings as index
22185 * @c item will be the pointer returned back on @c "changed", @c
22186 * "delay,changed" and @c "selected" smart events.
22190 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);
22193 * Remove an item from a given index widget, <b>to be referenced by
22194 * it's data value</b>.
22196 * @param obj The index object
22197 * @param item The item's data pointer for the item to be removed
22200 * If a deletion callback is set, via elm_index_item_del_cb_set(),
22201 * that callback function will be called by this one.
22203 * @warning The item to be removed from @p obj will be found via
22204 * its item data pointer, and not by an #Elm_Index_Item handle.
22208 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22211 * Find a given index widget's item, <b>using item data</b>.
22213 * @param obj The index object
22214 * @param item The item data pointed to by the desired index item
22215 * @return The index item handle, if found, or @c NULL otherwise
22219 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22222 * Removes @b all items from a given index widget.
22224 * @param obj The index object.
22226 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
22227 * that callback function will be called for each item in @p obj.
22231 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22234 * Go to a given items level on a index widget
22236 * @param obj The index object
22237 * @param level The index level (one of @c 0 or @c 1)
22241 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22244 * Return the data associated with a given index widget item
22246 * @param it The index widget item handle
22247 * @return The data associated with @p it
22249 * @see elm_index_item_data_set()
22253 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22256 * Set the data associated with a given index widget item
22258 * @param it The index widget item handle
22259 * @param data The new data pointer to set to @p it
22261 * This sets new item data on @p it.
22263 * @warning The old data pointer won't be touched by this function, so
22264 * the user had better to free that old data himself/herself.
22268 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
22271 * Set the function to be called when a given index widget item is freed.
22273 * @param it The item to set the callback on
22274 * @param func The function to call on the item's deletion
22276 * When called, @p func will have both @c data and @c event_info
22277 * arguments with the @p it item's data value and, naturally, the
22278 * @c obj argument with a handle to the parent index widget.
22282 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
22285 * Get the letter (string) set on a given index widget item.
22287 * @param it The index item handle
22288 * @return The letter string set on @p it
22292 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22299 * @defgroup Photocam Photocam
22301 * @image html img/widget/photocam/preview-00.png
22302 * @image latex img/widget/photocam/preview-00.eps
22304 * This is a widget specifically for displaying high-resolution digital
22305 * camera photos giving speedy feedback (fast load), low memory footprint
22306 * and zooming and panning as well as fitting logic. It is entirely focused
22307 * on jpeg images, and takes advantage of properties of the jpeg format (via
22308 * evas loader features in the jpeg loader).
22310 * Signals that you can add callbacks for are:
22311 * @li "clicked" - This is called when a user has clicked the photo without
22313 * @li "press" - This is called when a user has pressed down on the photo.
22314 * @li "longpressed" - This is called when a user has pressed down on the
22315 * photo for a long time without dragging around.
22316 * @li "clicked,double" - This is called when a user has double-clicked the
22318 * @li "load" - Photo load begins.
22319 * @li "loaded" - This is called when the image file load is complete for the
22320 * first view (low resolution blurry version).
22321 * @li "load,detail" - Photo detailed data load begins.
22322 * @li "loaded,detail" - This is called when the image file load is complete
22323 * for the detailed image data (full resolution needed).
22324 * @li "zoom,start" - Zoom animation started.
22325 * @li "zoom,stop" - Zoom animation stopped.
22326 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
22327 * @li "scroll" - the content has been scrolled (moved)
22328 * @li "scroll,anim,start" - scrolling animation has started
22329 * @li "scroll,anim,stop" - scrolling animation has stopped
22330 * @li "scroll,drag,start" - dragging the contents around has started
22331 * @li "scroll,drag,stop" - dragging the contents around has stopped
22333 * @ref tutorial_photocam shows the API in action.
22337 * @brief Types of zoom available.
22339 typedef enum _Elm_Photocam_Zoom_Mode
22341 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
22342 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
22343 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
22344 ELM_PHOTOCAM_ZOOM_MODE_LAST
22345 } Elm_Photocam_Zoom_Mode;
22347 * @brief Add a new Photocam object
22349 * @param parent The parent object
22350 * @return The new object or NULL if it cannot be created
22352 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22354 * @brief Set the photo file to be shown
22356 * @param obj The photocam object
22357 * @param file The photo file
22358 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
22360 * This sets (and shows) the specified file (with a relative or absolute
22361 * path) and will return a load error (same error that
22362 * evas_object_image_load_error_get() will return). The image will change and
22363 * adjust its size at this point and begin a background load process for this
22364 * photo that at some time in the future will be displayed at the full
22367 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
22369 * @brief Returns the path of the current image file
22371 * @param obj The photocam object
22372 * @return Returns the path
22374 * @see elm_photocam_file_set()
22376 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22378 * @brief Set the zoom level of the photo
22380 * @param obj The photocam object
22381 * @param zoom The zoom level to set
22383 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
22384 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
22385 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
22386 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
22389 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
22391 * @brief Get the zoom level of the photo
22393 * @param obj The photocam object
22394 * @return The current zoom level
22396 * This returns the current zoom level of the photocam object. Note that if
22397 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
22398 * (which is the default), the zoom level may be changed at any time by the
22399 * photocam object itself to account for photo size and photocam viewpoer
22402 * @see elm_photocam_zoom_set()
22403 * @see elm_photocam_zoom_mode_set()
22405 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22407 * @brief Set the zoom mode
22409 * @param obj The photocam object
22410 * @param mode The desired mode
22412 * This sets the zoom mode to manual or one of several automatic levels.
22413 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
22414 * elm_photocam_zoom_set() and will stay at that level until changed by code
22415 * or until zoom mode is changed. This is the default mode. The Automatic
22416 * modes will allow the photocam object to automatically adjust zoom mode
22417 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
22418 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
22419 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
22420 * pixels within the frame are left unfilled.
22422 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22424 * @brief Get the zoom mode
22426 * @param obj The photocam object
22427 * @return The current zoom mode
22429 * This gets the current zoom mode of the photocam object.
22431 * @see elm_photocam_zoom_mode_set()
22433 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22435 * @brief Get the current image pixel width and height
22437 * @param obj The photocam object
22438 * @param w A pointer to the width return
22439 * @param h A pointer to the height return
22441 * This gets the current photo pixel width and height (for the original).
22442 * The size will be returned in the integers @p w and @p h that are pointed
22445 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
22447 * @brief Get the area of the image that is currently shown
22450 * @param x A pointer to the X-coordinate of region
22451 * @param y A pointer to the Y-coordinate of region
22452 * @param w A pointer to the width
22453 * @param h A pointer to the height
22455 * @see elm_photocam_image_region_show()
22456 * @see elm_photocam_image_region_bring_in()
22458 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
22460 * @brief Set the viewed portion of the image
22462 * @param obj The photocam object
22463 * @param x X-coordinate of region in image original pixels
22464 * @param y Y-coordinate of region in image original pixels
22465 * @param w Width of region in image original pixels
22466 * @param h Height of region in image original pixels
22468 * This shows the region of the image without using animation.
22470 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22472 * @brief Bring in the viewed portion of the image
22474 * @param obj The photocam object
22475 * @param x X-coordinate of region in image original pixels
22476 * @param y Y-coordinate of region in image original pixels
22477 * @param w Width of region in image original pixels
22478 * @param h Height of region in image original pixels
22480 * This shows the region of the image using animation.
22482 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22484 * @brief Set the paused state for photocam
22486 * @param obj The photocam object
22487 * @param paused The pause state to set
22489 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
22490 * photocam. The default is off. This will stop zooming using animation on
22491 * zoom levels changes and change instantly. This will stop any existing
22492 * animations that are running.
22494 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22496 * @brief Get the paused state for photocam
22498 * @param obj The photocam object
22499 * @return The current paused state
22501 * This gets the current paused state for the photocam object.
22503 * @see elm_photocam_paused_set()
22505 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22507 * @brief Get the internal low-res image used for photocam
22509 * @param obj The photocam object
22510 * @return The internal image object handle, or NULL if none exists
22512 * This gets the internal image object inside photocam. Do not modify it. It
22513 * is for inspection only, and hooking callbacks to. Nothing else. It may be
22514 * deleted at any time as well.
22516 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22518 * @brief Set the photocam scrolling bouncing.
22520 * @param obj The photocam object
22521 * @param h_bounce bouncing for horizontal
22522 * @param v_bounce bouncing for vertical
22524 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22526 * @brief Get the photocam scrolling bouncing.
22528 * @param obj The photocam object
22529 * @param h_bounce bouncing for horizontal
22530 * @param v_bounce bouncing for vertical
22532 * @see elm_photocam_bounce_set()
22534 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
22540 * @defgroup Map Map
22541 * @ingroup Elementary
22543 * @image html img/widget/map/preview-00.png
22544 * @image latex img/widget/map/preview-00.eps
22546 * This is a widget specifically for displaying a map. It uses basically
22547 * OpenStreetMap provider http://www.openstreetmap.org/,
22548 * but custom providers can be added.
22550 * It supports some basic but yet nice features:
22551 * @li zoom and scroll
22552 * @li markers with content to be displayed when user clicks over it
22553 * @li group of markers
22556 * Smart callbacks one can listen to:
22558 * - "clicked" - This is called when a user has clicked the map without
22560 * - "press" - This is called when a user has pressed down on the map.
22561 * - "longpressed" - This is called when a user has pressed down on the map
22562 * for a long time without dragging around.
22563 * - "clicked,double" - This is called when a user has double-clicked
22565 * - "load,detail" - Map detailed data load begins.
22566 * - "loaded,detail" - This is called when all currently visible parts of
22567 * the map are loaded.
22568 * - "zoom,start" - Zoom animation started.
22569 * - "zoom,stop" - Zoom animation stopped.
22570 * - "zoom,change" - Zoom changed when using an auto zoom mode.
22571 * - "scroll" - the content has been scrolled (moved).
22572 * - "scroll,anim,start" - scrolling animation has started.
22573 * - "scroll,anim,stop" - scrolling animation has stopped.
22574 * - "scroll,drag,start" - dragging the contents around has started.
22575 * - "scroll,drag,stop" - dragging the contents around has stopped.
22576 * - "downloaded" - This is called when all currently required map images
22578 * - "route,load" - This is called when route request begins.
22579 * - "route,loaded" - This is called when route request ends.
22580 * - "name,load" - This is called when name request begins.
22581 * - "name,loaded- This is called when name request ends.
22583 * Available style for map widget:
22586 * Available style for markers:
22591 * Available style for marker bubble:
22594 * List of examples:
22595 * @li @ref map_example_01
22596 * @li @ref map_example_02
22597 * @li @ref map_example_03
22606 * @enum _Elm_Map_Zoom_Mode
22607 * @typedef Elm_Map_Zoom_Mode
22609 * Set map's zoom behavior. It can be set to manual or automatic.
22611 * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
22613 * Values <b> don't </b> work as bitmask, only one can be choosen.
22615 * @note Valid sizes are 2^zoom, consequently the map may be smaller
22616 * than the scroller view.
22618 * @see elm_map_zoom_mode_set()
22619 * @see elm_map_zoom_mode_get()
22623 typedef enum _Elm_Map_Zoom_Mode
22625 ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
22626 ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
22627 ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
22628 ELM_MAP_ZOOM_MODE_LAST
22629 } Elm_Map_Zoom_Mode;
22632 * @enum _Elm_Map_Route_Sources
22633 * @typedef Elm_Map_Route_Sources
22635 * Set route service to be used. By default used source is
22636 * #ELM_MAP_ROUTE_SOURCE_YOURS.
22638 * @see elm_map_route_source_set()
22639 * @see elm_map_route_source_get()
22643 typedef enum _Elm_Map_Route_Sources
22645 ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
22646 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. */
22647 ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
22648 ELM_MAP_ROUTE_SOURCE_LAST
22649 } Elm_Map_Route_Sources;
22651 typedef enum _Elm_Map_Name_Sources
22653 ELM_MAP_NAME_SOURCE_NOMINATIM,
22654 ELM_MAP_NAME_SOURCE_LAST
22655 } Elm_Map_Name_Sources;
22658 * @enum _Elm_Map_Route_Type
22659 * @typedef Elm_Map_Route_Type
22661 * Set type of transport used on route.
22663 * @see elm_map_route_add()
22667 typedef enum _Elm_Map_Route_Type
22669 ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
22670 ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
22671 ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
22672 ELM_MAP_ROUTE_TYPE_LAST
22673 } Elm_Map_Route_Type;
22676 * @enum _Elm_Map_Route_Method
22677 * @typedef Elm_Map_Route_Method
22679 * Set the routing method, what should be priorized, time or distance.
22681 * @see elm_map_route_add()
22685 typedef enum _Elm_Map_Route_Method
22687 ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
22688 ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
22689 ELM_MAP_ROUTE_METHOD_LAST
22690 } Elm_Map_Route_Method;
22692 typedef enum _Elm_Map_Name_Method
22694 ELM_MAP_NAME_METHOD_SEARCH,
22695 ELM_MAP_NAME_METHOD_REVERSE,
22696 ELM_MAP_NAME_METHOD_LAST
22697 } Elm_Map_Name_Method;
22699 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(). */
22700 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(). */
22701 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(). */
22702 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(). */
22703 typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
22704 typedef struct _Elm_Map_Track Elm_Map_Track;
22706 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. */
22707 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
22708 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
22709 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
22711 typedef char *(*ElmMapModuleSourceFunc) (void);
22712 typedef int (*ElmMapModuleZoomMinFunc) (void);
22713 typedef int (*ElmMapModuleZoomMaxFunc) (void);
22714 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
22715 typedef int (*ElmMapModuleRouteSourceFunc) (void);
22716 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
22717 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
22718 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
22719 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
22722 * Add a new map widget to the given parent Elementary (container) object.
22724 * @param parent The parent object.
22725 * @return a new map widget handle or @c NULL, on errors.
22727 * This function inserts a new map widget on the canvas.
22731 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22734 * Set the zoom level of the map.
22736 * @param obj The map object.
22737 * @param zoom The zoom level to set.
22739 * This sets the zoom level.
22741 * It will respect limits defined by elm_map_source_zoom_min_set() and
22742 * elm_map_source_zoom_max_set().
22744 * By default these values are 0 (world map) and 18 (maximum zoom).
22746 * This function should be used when zoom mode is set to
22747 * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
22748 * with elm_map_zoom_mode_set().
22750 * @see elm_map_zoom_mode_set().
22751 * @see elm_map_zoom_get().
22755 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22758 * Get the zoom level of the map.
22760 * @param obj The map object.
22761 * @return The current zoom level.
22763 * This returns the current zoom level of the map object.
22765 * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
22766 * (which is the default), the zoom level may be changed at any time by the
22767 * map object itself to account for map size and map viewport size.
22769 * @see elm_map_zoom_set() for details.
22773 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22776 * Set the zoom mode used by the map object.
22778 * @param obj The map object.
22779 * @param mode The zoom mode of the map, being it one of
22780 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22781 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22783 * This sets the zoom mode to manual or one of the automatic levels.
22784 * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
22785 * elm_map_zoom_set() and will stay at that level until changed by code
22786 * or until zoom mode is changed. This is the default mode.
22788 * The Automatic modes will allow the map object to automatically
22789 * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
22790 * adjust zoom so the map fits inside the scroll frame with no pixels
22791 * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
22792 * ensure no pixels within the frame are left unfilled. Do not forget that
22793 * the valid sizes are 2^zoom, consequently the map may be smaller than
22794 * the scroller view.
22796 * @see elm_map_zoom_set()
22800 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22803 * Get the zoom mode used by the map object.
22805 * @param obj The map object.
22806 * @return The zoom mode of the map, being it one of
22807 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22808 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22810 * This function returns the current zoom mode used by the map object.
22812 * @see elm_map_zoom_mode_set() for more details.
22816 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22819 * Get the current coordinates of the map.
22821 * @param obj The map object.
22822 * @param lon Pointer where to store longitude.
22823 * @param lat Pointer where to store latitude.
22825 * This gets the current center coordinates of the map object. It can be
22826 * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
22828 * @see elm_map_geo_region_bring_in()
22829 * @see elm_map_geo_region_show()
22833 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
22836 * Animatedly bring in given coordinates to the center of the map.
22838 * @param obj The map object.
22839 * @param lon Longitude to center at.
22840 * @param lat Latitude to center at.
22842 * This causes map to jump to the given @p lat and @p lon coordinates
22843 * and show it (by scrolling) in the center of the viewport, if it is not
22844 * already centered. This will use animation to do so and take a period
22845 * of time to complete.
22847 * @see elm_map_geo_region_show() for a function to avoid animation.
22848 * @see elm_map_geo_region_get()
22852 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22855 * Show the given coordinates at the center of the map, @b immediately.
22857 * @param obj The map object.
22858 * @param lon Longitude to center at.
22859 * @param lat Latitude to center at.
22861 * This causes map to @b redraw its viewport's contents to the
22862 * region contining the given @p lat and @p lon, that will be moved to the
22863 * center of the map.
22865 * @see elm_map_geo_region_bring_in() for a function to move with animation.
22866 * @see elm_map_geo_region_get()
22870 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22873 * Pause or unpause the map.
22875 * @param obj The map object.
22876 * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
22879 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22882 * The default is off.
22884 * This will stop zooming using animation, changing zoom levels will
22885 * change instantly. This will stop any existing animations that are running.
22887 * @see elm_map_paused_get()
22891 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22894 * Get a value whether map is paused or not.
22896 * @param obj The map object.
22897 * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
22898 * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
22900 * This gets the current paused state for the map object.
22902 * @see elm_map_paused_set() for details.
22906 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22909 * Set to show markers during zoom level changes or not.
22911 * @param obj The map object.
22912 * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
22915 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22918 * The default is off.
22920 * This will stop zooming using animation, changing zoom levels will
22921 * change instantly. This will stop any existing animations that are running.
22923 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22926 * The default is off.
22928 * Enabling it will force the map to stop displaying the markers during
22929 * zoom level changes. Set to on if you have a large number of markers.
22931 * @see elm_map_paused_markers_get()
22935 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22938 * Get a value whether markers will be displayed on zoom level changes or not
22940 * @param obj The map object.
22941 * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
22942 * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
22944 * This gets the current markers paused state for the map object.
22946 * @see elm_map_paused_markers_set() for details.
22950 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22953 * Get the information of downloading status.
22955 * @param obj The map object.
22956 * @param try_num Pointer where to store number of tiles being downloaded.
22957 * @param finish_num Pointer where to store number of tiles successfully
22960 * This gets the current downloading status for the map object, the number
22961 * of tiles being downloaded and the number of tiles already downloaded.
22965 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
22968 * Convert a pixel coordinate (x,y) into a geographic coordinate
22969 * (longitude, latitude).
22971 * @param obj The map object.
22972 * @param x the coordinate.
22973 * @param y the coordinate.
22974 * @param size the size in pixels of the map.
22975 * The map is a square and generally his size is : pow(2.0, zoom)*256.
22976 * @param lon Pointer where to store the longitude that correspond to x.
22977 * @param lat Pointer where to store the latitude that correspond to y.
22979 * @note Origin pixel point is the top left corner of the viewport.
22980 * Map zoom and size are taken on account.
22982 * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
22986 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);
22989 * Convert a geographic coordinate (longitude, latitude) into a pixel
22990 * coordinate (x, y).
22992 * @param obj The map object.
22993 * @param lon the longitude.
22994 * @param lat the latitude.
22995 * @param size the size in pixels of the map. The map is a square
22996 * and generally his size is : pow(2.0, zoom)*256.
22997 * @param x Pointer where to store the horizontal pixel coordinate that
22998 * correspond to the longitude.
22999 * @param y Pointer where to store the vertical pixel coordinate that
23000 * correspond to the latitude.
23002 * @note Origin pixel point is the top left corner of the viewport.
23003 * Map zoom and size are taken on account.
23005 * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
23009 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);
23012 * Convert a geographic coordinate (longitude, latitude) into a name
23015 * @param obj The map object.
23016 * @param lon the longitude.
23017 * @param lat the latitude.
23018 * @return name A #Elm_Map_Name handle for this coordinate.
23020 * To get the string for this address, elm_map_name_address_get()
23023 * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
23027 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
23030 * Convert a name (address) into a geographic coordinate
23031 * (longitude, latitude).
23033 * @param obj The map object.
23034 * @param name The address.
23035 * @return name A #Elm_Map_Name handle for this address.
23037 * To get the longitude and latitude, elm_map_name_region_get()
23040 * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
23044 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
23047 * Convert a pixel coordinate into a rotated pixel coordinate.
23049 * @param obj The map object.
23050 * @param x horizontal coordinate of the point to rotate.
23051 * @param y vertical coordinate of the point to rotate.
23052 * @param cx rotation's center horizontal position.
23053 * @param cy rotation's center vertical position.
23054 * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
23055 * @param xx Pointer where to store rotated x.
23056 * @param yy Pointer where to store rotated y.
23060 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);
23063 * Add a new marker to the map object.
23065 * @param obj The map object.
23066 * @param lon The longitude of the marker.
23067 * @param lat The latitude of the marker.
23068 * @param clas The class, to use when marker @b isn't grouped to others.
23069 * @param clas_group The class group, to use when marker is grouped to others
23070 * @param data The data passed to the callbacks.
23072 * @return The created marker or @c NULL upon failure.
23074 * A marker will be created and shown in a specific point of the map, defined
23075 * by @p lon and @p lat.
23077 * It will be displayed using style defined by @p class when this marker
23078 * is displayed alone (not grouped). A new class can be created with
23079 * elm_map_marker_class_new().
23081 * If the marker is grouped to other markers, it will be displayed with
23082 * style defined by @p class_group. Markers with the same group are grouped
23083 * if they are close. A new group class can be created with
23084 * elm_map_marker_group_class_new().
23086 * Markers created with this method can be deleted with
23087 * elm_map_marker_remove().
23089 * A marker can have associated content to be displayed by a bubble,
23090 * when a user click over it, as well as an icon. These objects will
23091 * be fetch using class' callback functions.
23093 * @see elm_map_marker_class_new()
23094 * @see elm_map_marker_group_class_new()
23095 * @see elm_map_marker_remove()
23099 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);
23102 * Set the maximum numbers of markers' content to be displayed in a group.
23104 * @param obj The map object.
23105 * @param max The maximum numbers of items displayed in a bubble.
23107 * A bubble will be displayed when the user clicks over the group,
23108 * and will place the content of markers that belong to this group
23111 * A group can have a long list of markers, consequently the creation
23112 * of the content of the bubble can be very slow.
23114 * In order to avoid this, a maximum number of items is displayed
23117 * By default this number is 30.
23119 * Marker with the same group class are grouped if they are close.
23121 * @see elm_map_marker_add()
23125 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
23128 * Remove a marker from the map.
23130 * @param marker The marker to remove.
23132 * @see elm_map_marker_add()
23136 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23139 * Get the current coordinates of the marker.
23141 * @param marker marker.
23142 * @param lat Pointer where to store the marker's latitude.
23143 * @param lon Pointer where to store the marker's longitude.
23145 * These values are set when adding markers, with function
23146 * elm_map_marker_add().
23148 * @see elm_map_marker_add()
23152 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
23155 * Animatedly bring in given marker to the center of the map.
23157 * @param marker The marker to center at.
23159 * This causes map to jump to the given @p marker's coordinates
23160 * and show it (by scrolling) in the center of the viewport, if it is not
23161 * already centered. This will use animation to do so and take a period
23162 * of time to complete.
23164 * @see elm_map_marker_show() for a function to avoid animation.
23165 * @see elm_map_marker_region_get()
23169 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23172 * Show the given marker at the center of the map, @b immediately.
23174 * @param marker The marker to center at.
23176 * This causes map to @b redraw its viewport's contents to the
23177 * region contining the given @p marker's coordinates, that will be
23178 * moved to the center of the map.
23180 * @see elm_map_marker_bring_in() for a function to move with animation.
23181 * @see elm_map_markers_list_show() if more than one marker need to be
23183 * @see elm_map_marker_region_get()
23187 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23190 * Move and zoom the map to display a list of markers.
23192 * @param markers A list of #Elm_Map_Marker handles.
23194 * The map will be centered on the center point of the markers in the list.
23195 * Then the map will be zoomed in order to fit the markers using the maximum
23196 * zoom which allows display of all the markers.
23198 * @warning All the markers should belong to the same map object.
23200 * @see elm_map_marker_show() to show a single marker.
23201 * @see elm_map_marker_bring_in()
23205 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
23208 * Get the Evas object returned by the ElmMapMarkerGetFunc callback
23210 * @param marker The marker wich content should be returned.
23211 * @return Return the evas object if it exists, else @c NULL.
23213 * To set callback function #ElmMapMarkerGetFunc for the marker class,
23214 * elm_map_marker_class_get_cb_set() should be used.
23216 * This content is what will be inside the bubble that will be displayed
23217 * when an user clicks over the marker.
23219 * This returns the actual Evas object used to be placed inside
23220 * the bubble. This may be @c NULL, as it may
23221 * not have been created or may have been deleted, at any time, by
23222 * the map. <b>Do not modify this object</b> (move, resize,
23223 * show, hide, etc.), as the map is controlling it. This
23224 * function is for querying, emitting custom signals or hooking
23225 * lower level callbacks for events on that object. Do not delete
23226 * this object under any circumstances.
23230 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23233 * Update the marker
23235 * @param marker The marker to be updated.
23237 * If a content is set to this marker, it will call function to delete it,
23238 * #ElmMapMarkerDelFunc, and then will fetch the content again with
23239 * #ElmMapMarkerGetFunc.
23241 * These functions are set for the marker class with
23242 * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
23246 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23249 * Close all the bubbles opened by the user.
23251 * @param obj The map object.
23253 * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
23254 * when the user clicks on a marker.
23256 * This functions is set for the marker class with
23257 * elm_map_marker_class_get_cb_set().
23261 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
23264 * Create a new group class.
23266 * @param obj The map object.
23267 * @return Returns the new group class.
23269 * Each marker must be associated to a group class. Markers in the same
23270 * group are grouped if they are close.
23272 * The group class defines the style of the marker when a marker is grouped
23273 * to others markers. When it is alone, another class will be used.
23275 * A group class will need to be provided when creating a marker with
23276 * elm_map_marker_add().
23278 * Some properties and functions can be set by class, as:
23279 * - style, with elm_map_group_class_style_set()
23280 * - data - to be associated to the group class. It can be set using
23281 * elm_map_group_class_data_set().
23282 * - min zoom to display markers, set with
23283 * elm_map_group_class_zoom_displayed_set().
23284 * - max zoom to group markers, set using
23285 * elm_map_group_class_zoom_grouped_set().
23286 * - visibility - set if markers will be visible or not, set with
23287 * elm_map_group_class_hide_set().
23288 * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
23289 * It can be set using elm_map_group_class_icon_cb_set().
23291 * @see elm_map_marker_add()
23292 * @see elm_map_group_class_style_set()
23293 * @see elm_map_group_class_data_set()
23294 * @see elm_map_group_class_zoom_displayed_set()
23295 * @see elm_map_group_class_zoom_grouped_set()
23296 * @see elm_map_group_class_hide_set()
23297 * @see elm_map_group_class_icon_cb_set()
23301 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23304 * Set the marker's style of a group class.
23306 * @param clas The group class.
23307 * @param style The style to be used by markers.
23309 * Each marker must be associated to a group class, and will use the style
23310 * defined by such class when grouped to other markers.
23312 * The following styles are provided by default theme:
23313 * @li @c radio - blue circle
23314 * @li @c radio2 - green circle
23317 * @see elm_map_group_class_new() for more details.
23318 * @see elm_map_marker_add()
23322 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23325 * Set the icon callback function of a group class.
23327 * @param clas The group class.
23328 * @param icon_get The callback function that will return the icon.
23330 * Each marker must be associated to a group class, and it can display a
23331 * custom icon. The function @p icon_get must return this icon.
23333 * @see elm_map_group_class_new() for more details.
23334 * @see elm_map_marker_add()
23338 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23341 * Set the data associated to the group class.
23343 * @param clas The group class.
23344 * @param data The new user data.
23346 * This data will be passed for callback functions, like icon get callback,
23347 * that can be set with elm_map_group_class_icon_cb_set().
23349 * If a data was previously set, the object will lose the pointer for it,
23350 * so if needs to be freed, you must do it yourself.
23352 * @see elm_map_group_class_new() for more details.
23353 * @see elm_map_group_class_icon_cb_set()
23354 * @see elm_map_marker_add()
23358 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
23361 * Set the minimum zoom from where the markers are displayed.
23363 * @param clas The group class.
23364 * @param zoom The minimum zoom.
23366 * Markers only will be displayed when the map is displayed at @p zoom
23369 * @see elm_map_group_class_new() for more details.
23370 * @see elm_map_marker_add()
23374 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23377 * Set the zoom from where the markers are no more grouped.
23379 * @param clas The group class.
23380 * @param zoom The maximum zoom.
23382 * Markers only will be grouped when the map is displayed at
23383 * less than @p zoom.
23385 * @see elm_map_group_class_new() for more details.
23386 * @see elm_map_marker_add()
23390 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23393 * Set if the markers associated to the group class @clas are hidden or not.
23395 * @param clas The group class.
23396 * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
23399 * If @p hide is @c EINA_TRUE the markers will be hidden, but default
23404 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
23407 * Create a new marker class.
23409 * @param obj The map object.
23410 * @return Returns the new group class.
23412 * Each marker must be associated to a class.
23414 * The marker class defines the style of the marker when a marker is
23415 * displayed alone, i.e., not grouped to to others markers. When grouped
23416 * it will use group class style.
23418 * A marker class will need to be provided when creating a marker with
23419 * elm_map_marker_add().
23421 * Some properties and functions can be set by class, as:
23422 * - style, with elm_map_marker_class_style_set()
23423 * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
23424 * It can be set using elm_map_marker_class_icon_cb_set().
23425 * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
23426 * Set using elm_map_marker_class_get_cb_set().
23427 * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
23428 * Set using elm_map_marker_class_del_cb_set().
23430 * @see elm_map_marker_add()
23431 * @see elm_map_marker_class_style_set()
23432 * @see elm_map_marker_class_icon_cb_set()
23433 * @see elm_map_marker_class_get_cb_set()
23434 * @see elm_map_marker_class_del_cb_set()
23438 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23441 * Set the marker's style of a marker class.
23443 * @param clas The marker class.
23444 * @param style The style to be used by markers.
23446 * Each marker must be associated to a marker class, and will use the style
23447 * defined by such class when alone, i.e., @b not grouped to other markers.
23449 * The following styles are provided by default theme:
23454 * @see elm_map_marker_class_new() for more details.
23455 * @see elm_map_marker_add()
23459 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23462 * Set the icon callback function of a marker class.
23464 * @param clas The marker class.
23465 * @param icon_get The callback function that will return the icon.
23467 * Each marker must be associated to a marker class, and it can display a
23468 * custom icon. The function @p icon_get must return this icon.
23470 * @see elm_map_marker_class_new() for more details.
23471 * @see elm_map_marker_add()
23475 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23478 * Set the bubble content callback function of a marker class.
23480 * @param clas The marker class.
23481 * @param get The callback function that will return the content.
23483 * Each marker must be associated to a marker class, and it can display a
23484 * a content on a bubble that opens when the user click over the marker.
23485 * The function @p get must return this content object.
23487 * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
23490 * @see elm_map_marker_class_new() for more details.
23491 * @see elm_map_marker_class_del_cb_set()
23492 * @see elm_map_marker_add()
23496 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
23499 * Set the callback function used to delete bubble content of a marker class.
23501 * @param clas The marker class.
23502 * @param del The callback function that will delete the content.
23504 * Each marker must be associated to a marker class, and it can display a
23505 * a content on a bubble that opens when the user click over the marker.
23506 * The function to return such content can be set with
23507 * elm_map_marker_class_get_cb_set().
23509 * If this content must be freed, a callback function need to be
23510 * set for that task with this function.
23512 * If this callback is defined it will have to delete (or not) the
23513 * object inside, but if the callback is not defined the object will be
23514 * destroyed with evas_object_del().
23516 * @see elm_map_marker_class_new() for more details.
23517 * @see elm_map_marker_class_get_cb_set()
23518 * @see elm_map_marker_add()
23522 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
23525 * Get the list of available sources.
23527 * @param obj The map object.
23528 * @return The source names list.
23530 * It will provide a list with all available sources, that can be set as
23531 * current source with elm_map_source_name_set(), or get with
23532 * elm_map_source_name_get().
23534 * Available sources:
23540 * @see elm_map_source_name_set() for more details.
23541 * @see elm_map_source_name_get()
23545 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23548 * Set the source of the map.
23550 * @param obj The map object.
23551 * @param source The source to be used.
23553 * Map widget retrieves images that composes the map from a web service.
23554 * This web service can be set with this method.
23556 * A different service can return a different maps with different
23557 * information and it can use different zoom values.
23559 * The @p source_name need to match one of the names provided by
23560 * elm_map_source_names_get().
23562 * The current source can be get using elm_map_source_name_get().
23564 * @see elm_map_source_names_get()
23565 * @see elm_map_source_name_get()
23570 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
23573 * Get the name of currently used source.
23575 * @param obj The map object.
23576 * @return Returns the name of the source in use.
23578 * @see elm_map_source_name_set() for more details.
23582 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23585 * Set the source of the route service to be used by the map.
23587 * @param obj The map object.
23588 * @param source The route service to be used, being it one of
23589 * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
23590 * and #ELM_MAP_ROUTE_SOURCE_ORS.
23592 * Each one has its own algorithm, so the route retrieved may
23593 * differ depending on the source route. Now, only the default is working.
23595 * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
23596 * http://www.yournavigation.org/.
23598 * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
23599 * assumptions. Its routing core is based on Contraction Hierarchies.
23601 * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
23603 * @see elm_map_route_source_get().
23607 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
23610 * Get the current route source.
23612 * @param obj The map object.
23613 * @return The source of the route service used by the map.
23615 * @see elm_map_route_source_set() for details.
23619 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23622 * Set the minimum zoom of the source.
23624 * @param obj The map object.
23625 * @param zoom New minimum zoom value to be used.
23627 * By default, it's 0.
23631 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23634 * Get the minimum zoom of the source.
23636 * @param obj The map object.
23637 * @return Returns the minimum zoom of the source.
23639 * @see elm_map_source_zoom_min_set() for details.
23643 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23646 * Set the maximum zoom of the source.
23648 * @param obj The map object.
23649 * @param zoom New maximum zoom value to be used.
23651 * By default, it's 18.
23655 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23658 * Get the maximum zoom of the source.
23660 * @param obj The map object.
23661 * @return Returns the maximum zoom of the source.
23663 * @see elm_map_source_zoom_min_set() for details.
23667 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23670 * Set the user agent used by the map object to access routing services.
23672 * @param obj The map object.
23673 * @param user_agent The user agent to be used by the map.
23675 * User agent is a client application implementing a network protocol used
23676 * in communications within a clientāserver distributed computing system
23678 * The @p user_agent identification string will transmitted in a header
23679 * field @c User-Agent.
23681 * @see elm_map_user_agent_get()
23685 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
23688 * Get the user agent used by the map object.
23690 * @param obj The map object.
23691 * @return The user agent identification string used by the map.
23693 * @see elm_map_user_agent_set() for details.
23697 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23700 * Add a new route to the map object.
23702 * @param obj The map object.
23703 * @param type The type of transport to be considered when tracing a route.
23704 * @param method The routing method, what should be priorized.
23705 * @param flon The start longitude.
23706 * @param flat The start latitude.
23707 * @param tlon The destination longitude.
23708 * @param tlat The destination latitude.
23710 * @return The created route or @c NULL upon failure.
23712 * A route will be traced by point on coordinates (@p flat, @p flon)
23713 * to point on coordinates (@p tlat, @p tlon), using the route service
23714 * set with elm_map_route_source_set().
23716 * It will take @p type on consideration to define the route,
23717 * depending if the user will be walking or driving, the route may vary.
23718 * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
23719 * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
23721 * Another parameter is what the route should priorize, the minor distance
23722 * or the less time to be spend on the route. So @p method should be one
23723 * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
23725 * Routes created with this method can be deleted with
23726 * elm_map_route_remove(), colored with elm_map_route_color_set(),
23727 * and distance can be get with elm_map_route_distance_get().
23729 * @see elm_map_route_remove()
23730 * @see elm_map_route_color_set()
23731 * @see elm_map_route_distance_get()
23732 * @see elm_map_route_source_set()
23736 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);
23739 * Remove a route from the map.
23741 * @param route The route to remove.
23743 * @see elm_map_route_add()
23747 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23750 * Set the route color.
23752 * @param route The route object.
23753 * @param r Red channel value, from 0 to 255.
23754 * @param g Green channel value, from 0 to 255.
23755 * @param b Blue channel value, from 0 to 255.
23756 * @param a Alpha channel value, from 0 to 255.
23758 * It uses an additive color model, so each color channel represents
23759 * how much of each primary colors must to be used. 0 represents
23760 * ausence of this color, so if all of the three are set to 0,
23761 * the color will be black.
23763 * These component values should be integers in the range 0 to 255,
23764 * (single 8-bit byte).
23766 * This sets the color used for the route. By default, it is set to
23767 * solid red (r = 255, g = 0, b = 0, a = 255).
23769 * For alpha channel, 0 represents completely transparent, and 255, opaque.
23771 * @see elm_map_route_color_get()
23775 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
23778 * Get the route color.
23780 * @param route The route object.
23781 * @param r Pointer where to store the red channel value.
23782 * @param g Pointer where to store the green channel value.
23783 * @param b Pointer where to store the blue channel value.
23784 * @param a Pointer where to store the alpha channel value.
23786 * @see elm_map_route_color_set() for details.
23790 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
23793 * Get the route distance in kilometers.
23795 * @param route The route object.
23796 * @return The distance of route (unit : km).
23800 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23803 * Get the information of route nodes.
23805 * @param route The route object.
23806 * @return Returns a string with the nodes of route.
23810 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23813 * Get the information of route waypoint.
23815 * @param route the route object.
23816 * @return Returns a string with information about waypoint of route.
23820 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23823 * Get the address of the name.
23825 * @param name The name handle.
23826 * @return Returns the address string of @p name.
23828 * This gets the coordinates of the @p name, created with one of the
23829 * conversion functions.
23831 * @see elm_map_utils_convert_name_into_coord()
23832 * @see elm_map_utils_convert_coord_into_name()
23836 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23839 * Get the current coordinates of the name.
23841 * @param name The name handle.
23842 * @param lat Pointer where to store the latitude.
23843 * @param lon Pointer where to store The longitude.
23845 * This gets the coordinates of the @p name, created with one of the
23846 * conversion functions.
23848 * @see elm_map_utils_convert_name_into_coord()
23849 * @see elm_map_utils_convert_coord_into_name()
23853 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
23856 * Remove a name from the map.
23858 * @param name The name to remove.
23860 * Basically the struct handled by @p name will be freed, so convertions
23861 * between address and coordinates will be lost.
23863 * @see elm_map_utils_convert_name_into_coord()
23864 * @see elm_map_utils_convert_coord_into_name()
23868 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23873 * @param obj The map object.
23874 * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
23875 * @param cx Rotation's center horizontal position.
23876 * @param cy Rotation's center vertical position.
23878 * @see elm_map_rotate_get()
23882 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
23885 * Get the rotate degree of the map
23887 * @param obj The map object
23888 * @param degree Pointer where to store degrees from 0.0 to 360.0
23889 * to rotate arount Z axis.
23890 * @param cx Pointer where to store rotation's center horizontal position.
23891 * @param cy Pointer where to store rotation's center vertical position.
23893 * @see elm_map_rotate_set() to set map rotation.
23897 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);
23900 * Enable or disable mouse wheel to be used to zoom in / out the map.
23902 * @param obj The map object.
23903 * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
23906 * Mouse wheel can be used for the user to zoom in or zoom out the map.
23908 * It's disabled by default.
23910 * @see elm_map_wheel_disabled_get()
23914 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
23917 * Get a value whether mouse wheel is enabled or not.
23919 * @param obj The map object.
23920 * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
23921 * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23923 * Mouse wheel can be used for the user to zoom in or zoom out the map.
23925 * @see elm_map_wheel_disabled_set() for details.
23929 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23933 * Add a track on the map
23935 * @param obj The map object.
23936 * @param emap The emap route object.
23937 * @return The route object. This is an elm object of type Route.
23939 * @see elm_route_add() for details.
23943 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
23947 * Remove a track from the map
23949 * @param obj The map object.
23950 * @param route The track to remove.
23954 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
23961 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
23963 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
23965 EAPI double elm_route_lon_min_get(Evas_Object *obj);
23966 EAPI double elm_route_lat_min_get(Evas_Object *obj);
23967 EAPI double elm_route_lon_max_get(Evas_Object *obj);
23968 EAPI double elm_route_lat_max_get(Evas_Object *obj);
23972 * @defgroup Panel Panel
23974 * @image html img/widget/panel/preview-00.png
23975 * @image latex img/widget/panel/preview-00.eps
23977 * @brief A panel is a type of animated container that contains subobjects.
23978 * It can be expanded or contracted by clicking the button on it's edge.
23980 * Orientations are as follows:
23981 * @li ELM_PANEL_ORIENT_TOP
23982 * @li ELM_PANEL_ORIENT_LEFT
23983 * @li ELM_PANEL_ORIENT_RIGHT
23985 * Default contents parts of the panel widget that you can use for are:
23986 * @li "default" - A content of the panel
23988 * @ref tutorial_panel shows one way to use this widget.
23991 typedef enum _Elm_Panel_Orient
23993 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
23994 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
23995 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
23996 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
23997 } Elm_Panel_Orient;
23999 * @brief Adds a panel object
24001 * @param parent The parent object
24003 * @return The panel object, or NULL on failure
24005 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24007 * @brief Sets the orientation of the panel
24009 * @param parent The parent object
24010 * @param orient The panel orientation. Can be one of the following:
24011 * @li ELM_PANEL_ORIENT_TOP
24012 * @li ELM_PANEL_ORIENT_LEFT
24013 * @li ELM_PANEL_ORIENT_RIGHT
24015 * Sets from where the panel will (dis)appear.
24017 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
24019 * @brief Get the orientation of the panel.
24021 * @param obj The panel object
24022 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
24024 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24026 * @brief Set the content of the panel.
24028 * @param obj The panel object
24029 * @param content The panel content
24031 * Once the content object is set, a previously set one will be deleted.
24032 * If you want to keep that old content object, use the
24033 * elm_panel_content_unset() function.
24035 * @deprecated use elm_object_content_set() instead
24038 EINA_DEPRECATED EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24040 * @brief Get the content of the panel.
24042 * @param obj The panel object
24043 * @return The content that is being used
24045 * Return the content object which is set for this widget.
24047 * @see elm_panel_content_set()
24049 * @deprecated use elm_object_content_get() instead
24052 EINA_DEPRECATED EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24054 * @brief Unset the content of the panel.
24056 * @param obj The panel object
24057 * @return The content that was being used
24059 * Unparent and return the content object which was set for this widget.
24061 * @see elm_panel_content_set()
24063 * @deprecated use elm_object_content_unset() instead
24066 EINA_DEPRECATED EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24068 * @brief Set the state of the panel.
24070 * @param obj The panel object
24071 * @param hidden If true, the panel will run the animation to contract
24073 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
24075 * @brief Get the state of the panel.
24077 * @param obj The panel object
24078 * @param hidden If true, the panel is in the "hide" state
24080 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24082 * @brief Toggle the hidden state of the panel from code
24084 * @param obj The panel object
24086 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
24092 * @defgroup Panes Panes
24093 * @ingroup Elementary
24095 * @image html img/widget/panes/preview-00.png
24096 * @image latex img/widget/panes/preview-00.eps width=\textwidth
24098 * @image html img/panes.png
24099 * @image latex img/panes.eps width=\textwidth
24101 * The panes adds a dragable bar between two contents. When dragged
24102 * this bar will resize contents size.
24104 * Panes can be displayed vertically or horizontally, and contents
24105 * size proportion can be customized (homogeneous by default).
24107 * Smart callbacks one can listen to:
24108 * - "press" - The panes has been pressed (button wasn't released yet).
24109 * - "unpressed" - The panes was released after being pressed.
24110 * - "clicked" - The panes has been clicked>
24111 * - "clicked,double" - The panes has been double clicked
24113 * Available styles for it:
24116 * Default contents parts of the panes widget that you can use for are:
24117 * @li "left" - A leftside content of the panes
24118 * @li "right" - A rightside content of the panes
24120 * If panes is displayed vertically, left content will be displayed at
24123 * Here is an example on its usage:
24124 * @li @ref panes_example
24128 * @addtogroup Panes
24133 * Add a new panes widget to the given parent Elementary
24134 * (container) object.
24136 * @param parent The parent object.
24137 * @return a new panes widget handle or @c NULL, on errors.
24139 * This function inserts a new panes widget on the canvas.
24143 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24146 * Set the left content of the panes widget.
24148 * @param obj The panes object.
24149 * @param content The new left content object.
24151 * Once the content object is set, a previously set one will be deleted.
24152 * If you want to keep that old content object, use the
24153 * elm_panes_content_left_unset() function.
24155 * If panes is displayed vertically, left content will be displayed at
24158 * @see elm_panes_content_left_get()
24159 * @see elm_panes_content_right_set() to set content on the other side.
24161 * @deprecated use elm_object_part_content_set() instead
24165 EINA_DEPRECATED EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24168 * Set the right content of the panes widget.
24170 * @param obj The panes object.
24171 * @param content The new right content object.
24173 * Once the content object is set, a previously set one will be deleted.
24174 * If you want to keep that old content object, use the
24175 * elm_panes_content_right_unset() function.
24177 * If panes is displayed vertically, left content will be displayed at
24180 * @see elm_panes_content_right_get()
24181 * @see elm_panes_content_left_set() to set content on the other side.
24183 * @deprecated use elm_object_part_content_set() instead
24187 EINA_DEPRECATED EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24190 * Get the left content of the panes.
24192 * @param obj The panes object.
24193 * @return The left content object that is being used.
24195 * Return the left content object which is set for this widget.
24197 * @see elm_panes_content_left_set() for details.
24199 * @deprecated use elm_object_part_content_get() instead
24203 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24206 * Get the right content of the panes.
24208 * @param obj The panes object
24209 * @return The right content object that is being used
24211 * Return the right content object which is set for this widget.
24213 * @see elm_panes_content_right_set() for details.
24215 * @deprecated use elm_object_part_content_get() instead
24219 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24222 * Unset the left content used for the panes.
24224 * @param obj The panes object.
24225 * @return The left content object that was being used.
24227 * Unparent and return the left content object which was set for this widget.
24229 * @see elm_panes_content_left_set() for details.
24230 * @see elm_panes_content_left_get().
24232 * @deprecated use elm_object_part_content_unset() instead
24236 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24239 * Unset the right content used for the panes.
24241 * @param obj The panes object.
24242 * @return The right content object that was being used.
24244 * Unparent and return the right content object which was set for this
24247 * @see elm_panes_content_right_set() for details.
24248 * @see elm_panes_content_right_get().
24250 * @deprecated use elm_object_part_content_unset() instead
24254 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24257 * Get the size proportion of panes widget's left side.
24259 * @param obj The panes object.
24260 * @return float value between 0.0 and 1.0 representing size proportion
24263 * @see elm_panes_content_left_size_set() for more details.
24267 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24270 * Set the size proportion of panes widget's left side.
24272 * @param obj The panes object.
24273 * @param size Value between 0.0 and 1.0 representing size proportion
24276 * By default it's homogeneous, i.e., both sides have the same size.
24278 * If something different is required, it can be set with this function.
24279 * For example, if the left content should be displayed over
24280 * 75% of the panes size, @p size should be passed as @c 0.75.
24281 * This way, right content will be resized to 25% of panes size.
24283 * If displayed vertically, left content is displayed at top, and
24284 * right content at bottom.
24286 * @note This proportion will change when user drags the panes bar.
24288 * @see elm_panes_content_left_size_get()
24292 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
24295 * Set the orientation of a given panes widget.
24297 * @param obj The panes object.
24298 * @param horizontal Use @c EINA_TRUE to make @p obj to be
24299 * @b horizontal, @c EINA_FALSE to make it @b vertical.
24301 * Use this function to change how your panes is to be
24302 * disposed: vertically or horizontally.
24304 * By default it's displayed horizontally.
24306 * @see elm_panes_horizontal_get()
24310 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
24313 * Retrieve the orientation of a given panes widget.
24315 * @param obj The panes object.
24316 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
24317 * @c EINA_FALSE if it's @b vertical (and on errors).
24319 * @see elm_panes_horizontal_set() for more details.
24323 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24324 EAPI void elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
24325 EAPI Eina_Bool elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24332 * @defgroup Flip Flip
24334 * @image html img/widget/flip/preview-00.png
24335 * @image latex img/widget/flip/preview-00.eps
24337 * This widget holds 2 content objects(Evas_Object): one on the front and one
24338 * on the back. It allows you to flip from front to back and vice-versa using
24339 * various animations.
24341 * If either the front or back contents are not set the flip will treat that
24342 * as transparent. So if you wore to set the front content but not the back,
24343 * and then call elm_flip_go() you would see whatever is below the flip.
24345 * For a list of supported animations see elm_flip_go().
24347 * Signals that you can add callbacks for are:
24348 * "animate,begin" - when a flip animation was started
24349 * "animate,done" - when a flip animation is finished
24351 * @ref tutorial_flip show how to use most of the API.
24355 typedef enum _Elm_Flip_Mode
24357 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
24358 ELM_FLIP_ROTATE_X_CENTER_AXIS,
24359 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
24360 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
24361 ELM_FLIP_CUBE_LEFT,
24362 ELM_FLIP_CUBE_RIGHT,
24364 ELM_FLIP_CUBE_DOWN,
24365 ELM_FLIP_PAGE_LEFT,
24366 ELM_FLIP_PAGE_RIGHT,
24370 typedef enum _Elm_Flip_Interaction
24372 ELM_FLIP_INTERACTION_NONE,
24373 ELM_FLIP_INTERACTION_ROTATE,
24374 ELM_FLIP_INTERACTION_CUBE,
24375 ELM_FLIP_INTERACTION_PAGE
24376 } Elm_Flip_Interaction;
24377 typedef enum _Elm_Flip_Direction
24379 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
24380 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
24381 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
24382 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
24383 } Elm_Flip_Direction;
24385 * @brief Add a new flip to the parent
24387 * @param parent The parent object
24388 * @return The new object or NULL if it cannot be created
24390 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24392 * @brief Set the front content of the flip widget.
24394 * @param obj The flip object
24395 * @param content The new front content object
24397 * Once the content object is set, a previously set one will be deleted.
24398 * If you want to keep that old content object, use the
24399 * elm_flip_content_front_unset() function.
24401 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24403 * @brief Set the back content of the flip widget.
24405 * @param obj The flip object
24406 * @param content The new back content object
24408 * Once the content object is set, a previously set one will be deleted.
24409 * If you want to keep that old content object, use the
24410 * elm_flip_content_back_unset() function.
24412 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24414 * @brief Get the front content used for the flip
24416 * @param obj The flip object
24417 * @return The front content object that is being used
24419 * Return the front content object which is set for this widget.
24421 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24423 * @brief Get the back content used for the flip
24425 * @param obj The flip object
24426 * @return The back content object that is being used
24428 * Return the back content object which is set for this widget.
24430 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24432 * @brief Unset the front content used for the flip
24434 * @param obj The flip object
24435 * @return The front content object that was being used
24437 * Unparent and return the front content object which was set for this widget.
24439 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24441 * @brief Unset the back content used for the flip
24443 * @param obj The flip object
24444 * @return The back content object that was being used
24446 * Unparent and return the back content object which was set for this widget.
24448 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24450 * @brief Get flip front visibility state
24452 * @param obj The flip objct
24453 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
24456 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24458 * @brief Set flip perspective
24460 * @param obj The flip object
24461 * @param foc The coordinate to set the focus on
24462 * @param x The X coordinate
24463 * @param y The Y coordinate
24465 * @warning This function currently does nothing.
24467 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
24469 * @brief Runs the flip animation
24471 * @param obj The flip object
24472 * @param mode The mode type
24474 * Flips the front and back contents using the @p mode animation. This
24475 * efectively hides the currently visible content and shows the hidden one.
24477 * There a number of possible animations to use for the flipping:
24478 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
24479 * around a horizontal axis in the middle of its height, the other content
24480 * is shown as the other side of the flip.
24481 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
24482 * around a vertical axis in the middle of its width, the other content is
24483 * shown as the other side of the flip.
24484 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
24485 * around a diagonal axis in the middle of its width, the other content is
24486 * shown as the other side of the flip.
24487 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
24488 * around a diagonal axis in the middle of its height, the other content is
24489 * shown as the other side of the flip.
24490 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
24491 * as if the flip was a cube, the other content is show as the right face of
24493 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
24494 * right as if the flip was a cube, the other content is show as the left
24495 * face of the cube.
24496 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
24497 * flip was a cube, the other content is show as the bottom face of the cube.
24498 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
24499 * the flip was a cube, the other content is show as the upper face of the
24501 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
24502 * if the flip was a book, the other content is shown as the page below that.
24503 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
24504 * as if the flip was a book, the other content is shown as the page below
24506 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
24507 * flip was a book, the other content is shown as the page below that.
24508 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
24509 * flip was a book, the other content is shown as the page below that.
24511 * @image html elm_flip.png
24512 * @image latex elm_flip.eps width=\textwidth
24514 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
24516 * @brief Set the interactive flip mode
24518 * @param obj The flip object
24519 * @param mode The interactive flip mode to use
24521 * This sets if the flip should be interactive (allow user to click and
24522 * drag a side of the flip to reveal the back page and cause it to flip).
24523 * By default a flip is not interactive. You may also need to set which
24524 * sides of the flip are "active" for flipping and how much space they use
24525 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
24526 * and elm_flip_interacton_direction_hitsize_set()
24528 * The four avilable mode of interaction are:
24529 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
24530 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
24531 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
24532 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
24534 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
24535 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
24536 * happen, those can only be acheived with elm_flip_go();
24538 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
24540 * @brief Get the interactive flip mode
24542 * @param obj The flip object
24543 * @return The interactive flip mode
24545 * Returns the interactive flip mode set by elm_flip_interaction_set()
24547 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
24549 * @brief Set which directions of the flip respond to interactive flip
24551 * @param obj The flip object
24552 * @param dir The direction to change
24553 * @param enabled If that direction is enabled or not
24555 * By default all directions are disabled, so you may want to enable the
24556 * desired directions for flipping if you need interactive flipping. You must
24557 * call this function once for each direction that should be enabled.
24559 * @see elm_flip_interaction_set()
24561 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
24563 * @brief Get the enabled state of that flip direction
24565 * @param obj The flip object
24566 * @param dir The direction to check
24567 * @return If that direction is enabled or not
24569 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
24571 * @see elm_flip_interaction_set()
24573 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
24575 * @brief Set the amount of the flip that is sensitive to interactive flip
24577 * @param obj The flip object
24578 * @param dir The direction to modify
24579 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
24581 * Set the amount of the flip that is sensitive to interactive flip, with 0
24582 * representing no area in the flip and 1 representing the entire flip. There
24583 * is however a consideration to be made in that the area will never be
24584 * smaller than the finger size set(as set in your Elementary configuration).
24586 * @see elm_flip_interaction_set()
24588 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
24590 * @brief Get the amount of the flip that is sensitive to interactive flip
24592 * @param obj The flip object
24593 * @param dir The direction to check
24594 * @return The size set for that direction
24596 * Returns the amount os sensitive area set by
24597 * elm_flip_interacton_direction_hitsize_set().
24599 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
24604 /* scrolledentry */
24605 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24606 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
24607 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24608 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
24609 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24610 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24611 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24612 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24613 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24614 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24615 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24616 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
24617 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
24618 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24619 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
24620 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
24621 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24622 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24623 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
24624 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
24625 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24626 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24627 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24628 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24629 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
24630 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
24631 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24632 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24633 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24634 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24635 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24636 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
24637 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
24638 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
24639 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24640 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);
24641 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24642 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24643 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);
24644 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24645 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);
24646 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
24647 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24648 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24649 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24650 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
24651 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24652 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24653 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24654 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);
24655 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);
24656 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);
24657 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);
24658 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);
24659 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);
24660 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
24661 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
24662 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
24663 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
24664 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24665 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
24666 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
24669 * @defgroup Conformant Conformant
24670 * @ingroup Elementary
24672 * @image html img/widget/conformant/preview-00.png
24673 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
24675 * @image html img/conformant.png
24676 * @image latex img/conformant.eps width=\textwidth
24678 * The aim is to provide a widget that can be used in elementary apps to
24679 * account for space taken up by the indicator, virtual keypad & softkey
24680 * windows when running the illume2 module of E17.
24682 * So conformant content will be sized and positioned considering the
24683 * space required for such stuff, and when they popup, as a keyboard
24684 * shows when an entry is selected, conformant content won't change.
24686 * Available styles for it:
24689 * Default contents parts of the conformant widget that you can use for are:
24690 * @li "default" - A content of the conformant
24692 * See how to use this widget in this example:
24693 * @ref conformant_example
24697 * @addtogroup Conformant
24702 * Add a new conformant widget to the given parent Elementary
24703 * (container) object.
24705 * @param parent The parent object.
24706 * @return A new conformant widget handle or @c NULL, on errors.
24708 * This function inserts a new conformant widget on the canvas.
24710 * @ingroup Conformant
24712 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24715 * Set the content of the conformant widget.
24717 * @param obj The conformant object.
24718 * @param content The content to be displayed by the conformant.
24720 * Content will be sized and positioned considering the space required
24721 * to display a virtual keyboard. So it won't fill all the conformant
24722 * size. This way is possible to be sure that content won't resize
24723 * or be re-positioned after the keyboard is displayed.
24725 * Once the content object is set, a previously set one will be deleted.
24726 * If you want to keep that old content object, use the
24727 * elm_object_content_unset() function.
24729 * @see elm_object_content_unset()
24730 * @see elm_object_content_get()
24732 * @deprecated use elm_object_content_set() instead
24734 * @ingroup Conformant
24736 EINA_DEPRECATED EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24739 * Get the content of the conformant widget.
24741 * @param obj The conformant object.
24742 * @return The content that is being used.
24744 * Return the content object which is set for this widget.
24745 * It won't be unparent from conformant. For that, use
24746 * elm_object_content_unset().
24748 * @see elm_object_content_set().
24749 * @see elm_object_content_unset()
24751 * @deprecated use elm_object_content_get() instead
24753 * @ingroup Conformant
24755 EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24758 * Unset the content of the conformant widget.
24760 * @param obj The conformant object.
24761 * @return The content that was being used.
24763 * Unparent and return the content object which was set for this widget.
24765 * @see elm_object_content_set().
24767 * @deprecated use elm_object_content_unset() instead
24769 * @ingroup Conformant
24771 EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24774 * Returns the Evas_Object that represents the content area.
24776 * @param obj The conformant object.
24777 * @return The content area of the widget.
24779 * @ingroup Conformant
24781 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24788 * @defgroup Mapbuf Mapbuf
24789 * @ingroup Elementary
24791 * @image html img/widget/mapbuf/preview-00.png
24792 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
24794 * This holds one content object and uses an Evas Map of transformation
24795 * points to be later used with this content. So the content will be
24796 * moved, resized, etc as a single image. So it will improve performance
24797 * when you have a complex interafce, with a lot of elements, and will
24798 * need to resize or move it frequently (the content object and its
24801 * Default contents parts of the mapbuf widget that you can use for are:
24802 * @li "default" - A content of the mapbuf
24804 * To enable map, elm_mapbuf_enabled_set() should be used.
24806 * See how to use this widget in this example:
24807 * @ref mapbuf_example
24811 * @addtogroup Mapbuf
24816 * Add a new mapbuf widget to the given parent Elementary
24817 * (container) object.
24819 * @param parent The parent object.
24820 * @return A new mapbuf widget handle or @c NULL, on errors.
24822 * This function inserts a new mapbuf widget on the canvas.
24826 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24829 * Set the content of the mapbuf.
24831 * @param obj The mapbuf object.
24832 * @param content The content that will be filled in this mapbuf object.
24834 * Once the content object is set, a previously set one will be deleted.
24835 * If you want to keep that old content object, use the
24836 * elm_mapbuf_content_unset() function.
24838 * To enable map, elm_mapbuf_enabled_set() should be used.
24840 * @deprecated use elm_object_content_set() instead
24844 EINA_DEPRECATED EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24847 * Get the content of the mapbuf.
24849 * @param obj The mapbuf object.
24850 * @return The content that is being used.
24852 * Return the content object which is set for this widget.
24854 * @see elm_mapbuf_content_set() for details.
24856 * @deprecated use elm_object_content_get() instead
24860 EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24863 * Unset the content of the mapbuf.
24865 * @param obj The mapbuf object.
24866 * @return The content that was being used.
24868 * Unparent and return the content object which was set for this widget.
24870 * @see elm_mapbuf_content_set() for details.
24872 * @deprecated use elm_object_content_unset() instead
24876 EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24879 * Enable or disable the map.
24881 * @param obj The mapbuf object.
24882 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
24884 * This enables the map that is set or disables it. On enable, the object
24885 * geometry will be saved, and the new geometry will change (position and
24886 * size) to reflect the map geometry set.
24888 * Also, when enabled, alpha and smooth states will be used, so if the
24889 * content isn't solid, alpha should be enabled, for example, otherwise
24890 * a black retangle will fill the content.
24892 * When disabled, the stored map will be freed and geometry prior to
24893 * enabling the map will be restored.
24895 * It's disabled by default.
24897 * @see elm_mapbuf_alpha_set()
24898 * @see elm_mapbuf_smooth_set()
24902 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
24905 * Get a value whether map is enabled or not.
24907 * @param obj The mapbuf object.
24908 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
24909 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24911 * @see elm_mapbuf_enabled_set() for details.
24915 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24918 * Enable or disable smooth map rendering.
24920 * @param obj The mapbuf object.
24921 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
24924 * This sets smoothing for map rendering. If the object is a type that has
24925 * its own smoothing settings, then both the smooth settings for this object
24926 * and the map must be turned off.
24928 * By default smooth maps are enabled.
24932 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
24935 * Get a value whether smooth map rendering is enabled or not.
24937 * @param obj The mapbuf object.
24938 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
24939 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24941 * @see elm_mapbuf_smooth_set() for details.
24945 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24948 * Set or unset alpha flag for map rendering.
24950 * @param obj The mapbuf object.
24951 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
24954 * This sets alpha flag for map rendering. If the object is a type that has
24955 * its own alpha settings, then this will take precedence. Only image objects
24956 * have this currently. It stops alpha blending of the map area, and is
24957 * useful if you know the object and/or all sub-objects is 100% solid.
24959 * Alpha is enabled by default.
24963 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
24966 * Get a value whether alpha blending is enabled or not.
24968 * @param obj The mapbuf object.
24969 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
24970 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24972 * @see elm_mapbuf_alpha_set() for details.
24976 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24983 * @defgroup Flipselector Flip Selector
24985 * @image html img/widget/flipselector/preview-00.png
24986 * @image latex img/widget/flipselector/preview-00.eps
24988 * A flip selector is a widget to show a set of @b text items, one
24989 * at a time, with the same sheet switching style as the @ref Clock
24990 * "clock" widget, when one changes the current displaying sheet
24991 * (thus, the "flip" in the name).
24993 * User clicks to flip sheets which are @b held for some time will
24994 * make the flip selector to flip continuosly and automatically for
24995 * the user. The interval between flips will keep growing in time,
24996 * so that it helps the user to reach an item which is distant from
24997 * the current selection.
24999 * Smart callbacks one can register to:
25000 * - @c "selected" - when the widget's selected text item is changed
25001 * - @c "overflowed" - when the widget's current selection is changed
25002 * from the first item in its list to the last
25003 * - @c "underflowed" - when the widget's current selection is changed
25004 * from the last item in its list to the first
25006 * Available styles for it:
25009 * To set/get the label of the flipselector item, you can use
25010 * elm_object_item_text_set/get APIs.
25011 * Once the text is set, a previously set one will be deleted.
25013 * Here is an example on its usage:
25014 * @li @ref flipselector_example
25018 * @addtogroup Flipselector
25023 * Add a new flip selector widget to the given parent Elementary
25024 * (container) widget
25026 * @param parent The parent object
25027 * @return a new flip selector widget handle or @c NULL, on errors
25029 * This function inserts a new flip selector widget on the canvas.
25031 * @ingroup Flipselector
25033 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25036 * Programmatically select the next item of a flip selector widget
25038 * @param obj The flipselector object
25040 * @note The selection will be animated. Also, if it reaches the
25041 * end of its list of member items, it will continue with the first
25044 * @ingroup Flipselector
25046 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
25049 * Programmatically select the previous item of a flip selector
25052 * @param obj The flipselector object
25054 * @note The selection will be animated. Also, if it reaches the
25055 * beginning of its list of member items, it will continue with the
25056 * last one backwards.
25058 * @ingroup Flipselector
25060 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
25063 * Append a (text) item to a flip selector widget
25065 * @param obj The flipselector object
25066 * @param label The (text) label of the new item
25067 * @param func Convenience callback function to take place when
25069 * @param data Data passed to @p func, above
25070 * @return A handle to the item added or @c NULL, on errors
25072 * The widget's list of labels to show will be appended with the
25073 * given value. If the user wishes so, a callback function pointer
25074 * can be passed, which will get called when this same item is
25077 * @note The current selection @b won't be modified by appending an
25078 * element to the list.
25080 * @note The maximum length of the text label is going to be
25081 * determined <b>by the widget's theme</b>. Strings larger than
25082 * that value are going to be @b truncated.
25084 * @ingroup Flipselector
25086 EAPI Elm_Object_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
25089 * Prepend a (text) item to a flip selector widget
25091 * @param obj The flipselector object
25092 * @param label The (text) label of the new item
25093 * @param func Convenience callback function to take place when
25095 * @param data Data passed to @p func, above
25096 * @return A handle to the item added or @c NULL, on errors
25098 * The widget's list of labels to show will be prepended with the
25099 * given value. If the user wishes so, a callback function pointer
25100 * can be passed, which will get called when this same item is
25103 * @note The current selection @b won't be modified by prepending
25104 * an element to the list.
25106 * @note The maximum length of the text label is going to be
25107 * determined <b>by the widget's theme</b>. Strings larger than
25108 * that value are going to be @b truncated.
25110 * @ingroup Flipselector
25112 EAPI Elm_Object_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
25115 * Get the internal list of items in a given flip selector widget.
25117 * @param obj The flipselector object
25118 * @return The list of items (#Elm_Object_Item as data) or
25119 * @c NULL on errors.
25121 * This list is @b not to be modified in any way and must not be
25122 * freed. Use the list members with functions like
25123 * elm_object_item_text_set(),
25124 * elm_object_item_text_get(),
25125 * elm_flipselector_item_del(),
25126 * elm_flipselector_item_selected_get(),
25127 * elm_flipselector_item_selected_set().
25129 * @warning This list is only valid until @p obj object's internal
25130 * items list is changed. It should be fetched again with another
25131 * call to this function when changes happen.
25133 * @ingroup Flipselector
25135 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25138 * Get the first item in the given flip selector widget's list of
25141 * @param obj The flipselector object
25142 * @return The first item or @c NULL, if it has no items (and on
25145 * @see elm_flipselector_item_append()
25146 * @see elm_flipselector_last_item_get()
25148 * @ingroup Flipselector
25150 EAPI Elm_Object_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25153 * Get the last item in the given flip selector widget's list of
25156 * @param obj The flipselector object
25157 * @return The last item or @c NULL, if it has no items (and on
25160 * @see elm_flipselector_item_prepend()
25161 * @see elm_flipselector_first_item_get()
25163 * @ingroup Flipselector
25165 EAPI Elm_Object_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25168 * Get the currently selected item in a flip selector widget.
25170 * @param obj The flipselector object
25171 * @return The selected item or @c NULL, if the widget has no items
25174 * @ingroup Flipselector
25176 EAPI Elm_Object_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25179 * Set whether a given flip selector widget's item should be the
25180 * currently selected one.
25182 * @param it The flip selector item
25183 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
25185 * This sets whether @p item is or not the selected (thus, under
25186 * display) one. If @p item is different than one under display,
25187 * the latter will be unselected. If the @p item is set to be
25188 * unselected, on the other hand, the @b first item in the widget's
25189 * internal members list will be the new selected one.
25191 * @see elm_flipselector_item_selected_get()
25193 * @ingroup Flipselector
25195 EAPI void elm_flipselector_item_selected_set(Elm_Object_Item *it, Eina_Bool selected) EINA_ARG_NONNULL(1);
25198 * Get whether a given flip selector widget's item is the currently
25201 * @param it The flip selector item
25202 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
25205 * @see elm_flipselector_item_selected_set()
25207 * @ingroup Flipselector
25209 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25212 * Delete a given item from a flip selector widget.
25214 * @param it The item to delete
25216 * @ingroup Flipselector
25218 EAPI void elm_flipselector_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25221 * Get the label of a given flip selector widget's item.
25223 * @param it The item to get label from
25224 * @return The text label of @p item or @c NULL, on errors
25226 * @see elm_object_item_text_set()
25228 * @deprecated see elm_object_item_text_get() instead
25229 * @ingroup Flipselector
25231 EINA_DEPRECATED EAPI const char *elm_flipselector_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25234 * Set the label of a given flip selector widget's item.
25236 * @param it The item to set label on
25237 * @param label The text label string, in UTF-8 encoding
25239 * @see elm_object_item_text_get()
25241 * @deprecated see elm_object_item_text_set() instead
25242 * @ingroup Flipselector
25244 EINA_DEPRECATED EAPI void elm_flipselector_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
25247 * Gets the item before @p item in a flip selector widget's
25248 * internal list of items.
25250 * @param it The item to fetch previous from
25251 * @return The item before the @p item, in its parent's list. If
25252 * there is no previous item for @p item or there's an
25253 * error, @c NULL is returned.
25255 * @see elm_flipselector_item_next_get()
25257 * @ingroup Flipselector
25259 EAPI Elm_Object_Item *elm_flipselector_item_prev_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25262 * Gets the item after @p item in a flip selector widget's
25263 * internal list of items.
25265 * @param it The item to fetch next from
25266 * @return The item after the @p item, in its parent's list. If
25267 * there is no next item for @p item or there's an
25268 * error, @c NULL is returned.
25270 * @see elm_flipselector_item_next_get()
25272 * @ingroup Flipselector
25274 EAPI Elm_Object_Item *elm_flipselector_item_next_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25277 * Set the interval on time updates for an user mouse button hold
25278 * on a flip selector widget.
25280 * @param obj The flip selector object
25281 * @param interval The (first) interval value in seconds
25283 * This interval value is @b decreased while the user holds the
25284 * mouse pointer either flipping up or flipping doww a given flip
25287 * This helps the user to get to a given item distant from the
25288 * current one easier/faster, as it will start to flip quicker and
25289 * quicker on mouse button holds.
25291 * The calculation for the next flip interval value, starting from
25292 * the one set with this call, is the previous interval divided by
25293 * 1.05, so it decreases a little bit.
25295 * The default starting interval value for automatic flips is
25298 * @see elm_flipselector_interval_get()
25300 * @ingroup Flipselector
25302 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25305 * Get the interval on time updates for an user mouse button hold
25306 * on a flip selector widget.
25308 * @param obj The flip selector object
25309 * @return The (first) interval value, in seconds, set on it
25311 * @see elm_flipselector_interval_set() for more details
25313 * @ingroup Flipselector
25315 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25321 * @addtogroup Calendar
25326 * @enum _Elm_Calendar_Mark_Repeat
25327 * @typedef Elm_Calendar_Mark_Repeat
25329 * Event periodicity, used to define if a mark should be repeated
25330 * @b beyond event's day. It's set when a mark is added.
25332 * So, for a mark added to 13th May with periodicity set to WEEKLY,
25333 * there will be marks every week after this date. Marks will be displayed
25334 * at 13th, 20th, 27th, 3rd June ...
25336 * Values don't work as bitmask, only one can be choosen.
25338 * @see elm_calendar_mark_add()
25340 * @ingroup Calendar
25342 typedef enum _Elm_Calendar_Mark_Repeat
25344 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
25345 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
25346 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
25347 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*/
25348 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. */
25349 } Elm_Calendar_Mark_Repeat;
25351 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(). */
25354 * Add a new calendar widget to the given parent Elementary
25355 * (container) object.
25357 * @param parent The parent object.
25358 * @return a new calendar widget handle or @c NULL, on errors.
25360 * This function inserts a new calendar widget on the canvas.
25362 * @ref calendar_example_01
25364 * @ingroup Calendar
25366 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25369 * Get weekdays names displayed by the calendar.
25371 * @param obj The calendar object.
25372 * @return Array of seven strings to be used as weekday names.
25374 * By default, weekdays abbreviations get from system are displayed:
25375 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25376 * The first string is related to Sunday, the second to Monday...
25378 * @see elm_calendar_weekdays_name_set()
25380 * @ref calendar_example_05
25382 * @ingroup Calendar
25384 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25387 * Set weekdays names to be displayed by the calendar.
25389 * @param obj The calendar object.
25390 * @param weekdays Array of seven strings to be used as weekday names.
25391 * @warning It must have 7 elements, or it will access invalid memory.
25392 * @warning The strings must be NULL terminated ('@\0').
25394 * By default, weekdays abbreviations get from system are displayed:
25395 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25397 * The first string should be related to Sunday, the second to Monday...
25399 * The usage should be like this:
25401 * const char *weekdays[] =
25403 * "Sunday", "Monday", "Tuesday", "Wednesday",
25404 * "Thursday", "Friday", "Saturday"
25406 * elm_calendar_weekdays_names_set(calendar, weekdays);
25409 * @see elm_calendar_weekdays_name_get()
25411 * @ref calendar_example_02
25413 * @ingroup Calendar
25415 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
25418 * Set the minimum and maximum values for the year
25420 * @param obj The calendar object
25421 * @param min The minimum year, greater than 1901;
25422 * @param max The maximum year;
25424 * Maximum must be greater than minimum, except if you don't wan't to set
25426 * Default values are 1902 and -1.
25428 * If the maximum year is a negative value, it will be limited depending
25429 * on the platform architecture (year 2037 for 32 bits);
25431 * @see elm_calendar_min_max_year_get()
25433 * @ref calendar_example_03
25435 * @ingroup Calendar
25437 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
25440 * Get the minimum and maximum values for the year
25442 * @param obj The calendar object.
25443 * @param min The minimum year.
25444 * @param max The maximum year.
25446 * Default values are 1902 and -1.
25448 * @see elm_calendar_min_max_year_get() for more details.
25450 * @ref calendar_example_05
25452 * @ingroup Calendar
25454 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
25457 * Enable or disable day selection
25459 * @param obj The calendar object.
25460 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
25463 * Enabled by default. If disabled, the user still can select months,
25464 * but not days. Selected days are highlighted on calendar.
25465 * It should be used if you won't need such selection for the widget usage.
25467 * When a day is selected, or month is changed, smart callbacks for
25468 * signal "changed" will be called.
25470 * @see elm_calendar_day_selection_enable_get()
25472 * @ref calendar_example_04
25474 * @ingroup Calendar
25476 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25479 * Get a value whether day selection is enabled or not.
25481 * @see elm_calendar_day_selection_enable_set() for details.
25483 * @param obj The calendar object.
25484 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
25485 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
25487 * @ref calendar_example_05
25489 * @ingroup Calendar
25491 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25495 * Set selected date to be highlighted on calendar.
25497 * @param obj The calendar object.
25498 * @param selected_time A @b tm struct to represent the selected date.
25500 * Set the selected date, changing the displayed month if needed.
25501 * Selected date changes when the user goes to next/previous month or
25502 * select a day pressing over it on calendar.
25504 * @see elm_calendar_selected_time_get()
25506 * @ref calendar_example_04
25508 * @ingroup Calendar
25510 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
25513 * Get selected date.
25515 * @param obj The calendar object
25516 * @param selected_time A @b tm struct to point to selected date
25517 * @return EINA_FALSE means an error ocurred and returned time shouldn't
25520 * Get date selected by the user or set by function
25521 * elm_calendar_selected_time_set().
25522 * Selected date changes when the user goes to next/previous month or
25523 * select a day pressing over it on calendar.
25525 * @see elm_calendar_selected_time_get()
25527 * @ref calendar_example_05
25529 * @ingroup Calendar
25531 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
25534 * Set a function to format the string that will be used to display
25537 * @param obj The calendar object
25538 * @param format_function Function to set the month-year string given
25539 * the selected date
25541 * By default it uses strftime with "%B %Y" format string.
25542 * It should allocate the memory that will be used by the string,
25543 * that will be freed by the widget after usage.
25544 * A pointer to the string and a pointer to the time struct will be provided.
25549 * _format_month_year(struct tm *selected_time)
25552 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
25553 * return strdup(buf);
25556 * elm_calendar_format_function_set(calendar, _format_month_year);
25559 * @ref calendar_example_02
25561 * @ingroup Calendar
25563 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
25566 * Add a new mark to the calendar
25568 * @param obj The calendar object
25569 * @param mark_type A string used to define the type of mark. It will be
25570 * emitted to the theme, that should display a related modification on these
25571 * days representation.
25572 * @param mark_time A time struct to represent the date of inclusion of the
25573 * mark. For marks that repeats it will just be displayed after the inclusion
25574 * date in the calendar.
25575 * @param repeat Repeat the event following this periodicity. Can be a unique
25576 * mark (that don't repeat), daily, weekly, monthly or annually.
25577 * @return The created mark or @p NULL upon failure.
25579 * Add a mark that will be drawn in the calendar respecting the insertion
25580 * time and periodicity. It will emit the type as signal to the widget theme.
25581 * Default theme supports "holiday" and "checked", but it can be extended.
25583 * It won't immediately update the calendar, drawing the marks.
25584 * For this, call elm_calendar_marks_draw(). However, when user selects
25585 * next or previous month calendar forces marks drawn.
25587 * Marks created with this method can be deleted with
25588 * elm_calendar_mark_del().
25592 * struct tm selected_time;
25593 * time_t current_time;
25595 * current_time = time(NULL) + 5 * 84600;
25596 * localtime_r(¤t_time, &selected_time);
25597 * elm_calendar_mark_add(cal, "holiday", selected_time,
25598 * ELM_CALENDAR_ANNUALLY);
25600 * current_time = time(NULL) + 1 * 84600;
25601 * localtime_r(¤t_time, &selected_time);
25602 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
25604 * elm_calendar_marks_draw(cal);
25607 * @see elm_calendar_marks_draw()
25608 * @see elm_calendar_mark_del()
25610 * @ref calendar_example_06
25612 * @ingroup Calendar
25614 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);
25617 * Delete mark from the calendar.
25619 * @param mark The mark to be deleted.
25621 * If deleting all calendar marks is required, elm_calendar_marks_clear()
25622 * should be used instead of getting marks list and deleting each one.
25624 * @see elm_calendar_mark_add()
25626 * @ref calendar_example_06
25628 * @ingroup Calendar
25630 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
25633 * Remove all calendar's marks
25635 * @param obj The calendar object.
25637 * @see elm_calendar_mark_add()
25638 * @see elm_calendar_mark_del()
25640 * @ingroup Calendar
25642 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25646 * Get a list of all the calendar marks.
25648 * @param obj The calendar object.
25649 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
25651 * @see elm_calendar_mark_add()
25652 * @see elm_calendar_mark_del()
25653 * @see elm_calendar_marks_clear()
25655 * @ingroup Calendar
25657 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25660 * Draw calendar marks.
25662 * @param obj The calendar object.
25664 * Should be used after adding, removing or clearing marks.
25665 * It will go through the entire marks list updating the calendar.
25666 * If lots of marks will be added, add all the marks and then call
25669 * When the month is changed, i.e. user selects next or previous month,
25670 * marks will be drawed.
25672 * @see elm_calendar_mark_add()
25673 * @see elm_calendar_mark_del()
25674 * @see elm_calendar_marks_clear()
25676 * @ref calendar_example_06
25678 * @ingroup Calendar
25680 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
25683 * Set a day text color to the same that represents Saturdays.
25685 * @param obj The calendar object.
25686 * @param pos The text position. Position is the cell counter, from left
25687 * to right, up to down. It starts on 0 and ends on 41.
25689 * @deprecated use elm_calendar_mark_add() instead like:
25692 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
25693 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25696 * @see elm_calendar_mark_add()
25698 * @ingroup Calendar
25700 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25703 * Set a day text color to the same that represents Sundays.
25705 * @param obj The calendar object.
25706 * @param pos The text position. Position is the cell counter, from left
25707 * to right, up to down. It starts on 0 and ends on 41.
25709 * @deprecated use elm_calendar_mark_add() instead like:
25712 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
25713 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25716 * @see elm_calendar_mark_add()
25718 * @ingroup Calendar
25720 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25723 * Set a day text color to the same that represents Weekdays.
25725 * @param obj The calendar object
25726 * @param pos The text position. Position is the cell counter, from left
25727 * to right, up to down. It starts on 0 and ends on 41.
25729 * @deprecated use elm_calendar_mark_add() instead like:
25732 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
25734 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
25735 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25736 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
25737 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25738 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
25739 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25740 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
25741 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25742 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
25745 * @see elm_calendar_mark_add()
25747 * @ingroup Calendar
25749 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25752 * Set the interval on time updates for an user mouse button hold
25753 * on calendar widgets' month selection.
25755 * @param obj The calendar object
25756 * @param interval The (first) interval value in seconds
25758 * This interval value is @b decreased while the user holds the
25759 * mouse pointer either selecting next or previous month.
25761 * This helps the user to get to a given month distant from the
25762 * current one easier/faster, as it will start to change quicker and
25763 * quicker on mouse button holds.
25765 * The calculation for the next change interval value, starting from
25766 * the one set with this call, is the previous interval divided by
25767 * 1.05, so it decreases a little bit.
25769 * The default starting interval value for automatic changes is
25772 * @see elm_calendar_interval_get()
25774 * @ingroup Calendar
25776 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25779 * Get the interval on time updates for an user mouse button hold
25780 * on calendar widgets' month selection.
25782 * @param obj The calendar object
25783 * @return The (first) interval value, in seconds, set on it
25785 * @see elm_calendar_interval_set() for more details
25787 * @ingroup Calendar
25789 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25796 * @defgroup Diskselector Diskselector
25797 * @ingroup Elementary
25799 * @image html img/widget/diskselector/preview-00.png
25800 * @image latex img/widget/diskselector/preview-00.eps
25802 * A diskselector is a kind of list widget. It scrolls horizontally,
25803 * and can contain label and icon objects. Three items are displayed
25804 * with the selected one in the middle.
25806 * It can act like a circular list with round mode and labels can be
25807 * reduced for a defined length for side items.
25809 * Smart callbacks one can listen to:
25810 * - "selected" - when item is selected, i.e. scroller stops.
25812 * Available styles for it:
25815 * List of examples:
25816 * @li @ref diskselector_example_01
25817 * @li @ref diskselector_example_02
25821 * @addtogroup Diskselector
25825 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(). */
25828 * Add a new diskselector widget to the given parent Elementary
25829 * (container) object.
25831 * @param parent The parent object.
25832 * @return a new diskselector widget handle or @c NULL, on errors.
25834 * This function inserts a new diskselector widget on the canvas.
25836 * @ingroup Diskselector
25838 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25841 * Enable or disable round mode.
25843 * @param obj The diskselector object.
25844 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
25847 * Disabled by default. If round mode is enabled the items list will
25848 * work like a circle list, so when the user reaches the last item,
25849 * the first one will popup.
25851 * @see elm_diskselector_round_get()
25853 * @ingroup Diskselector
25855 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
25858 * Get a value whether round mode is enabled or not.
25860 * @see elm_diskselector_round_set() for details.
25862 * @param obj The diskselector object.
25863 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
25864 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25866 * @ingroup Diskselector
25868 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25871 * Get the side labels max length.
25873 * @deprecated use elm_diskselector_side_label_length_get() instead:
25875 * @param obj The diskselector object.
25876 * @return The max length defined for side labels, or 0 if not a valid
25879 * @ingroup Diskselector
25881 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25884 * Set the side labels max length.
25886 * @deprecated use elm_diskselector_side_label_length_set() instead:
25888 * @param obj The diskselector object.
25889 * @param len The max length defined for side labels.
25891 * @ingroup Diskselector
25893 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25896 * Get the side labels max length.
25898 * @see elm_diskselector_side_label_length_set() for details.
25900 * @param obj The diskselector object.
25901 * @return The max length defined for side labels, or 0 if not a valid
25904 * @ingroup Diskselector
25906 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25909 * Set the side labels max length.
25911 * @param obj The diskselector object.
25912 * @param len The max length defined for side labels.
25914 * Length is the number of characters of items' label that will be
25915 * visible when it's set on side positions. It will just crop
25916 * the string after defined size. E.g.:
25918 * An item with label "January" would be displayed on side position as
25919 * "Jan" if max length is set to 3, or "Janu", if this property
25922 * When it's selected, the entire label will be displayed, except for
25923 * width restrictions. In this case label will be cropped and "..."
25924 * will be concatenated.
25926 * Default side label max length is 3.
25928 * This property will be applyed over all items, included before or
25929 * later this function call.
25931 * @ingroup Diskselector
25933 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25936 * Set the number of items to be displayed.
25938 * @param obj The diskselector object.
25939 * @param num The number of items the diskselector will display.
25941 * Default value is 3, and also it's the minimun. If @p num is less
25942 * than 3, it will be set to 3.
25944 * Also, it can be set on theme, using data item @c display_item_num
25945 * on group "elm/diskselector/item/X", where X is style set.
25948 * group { name: "elm/diskselector/item/X";
25950 * item: "display_item_num" "5";
25953 * @ingroup Diskselector
25955 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
25958 * Get the number of items in the diskselector object.
25960 * @param obj The diskselector object.
25962 * @ingroup Diskselector
25964 EAPI int elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25967 * Set bouncing behaviour when the scrolled content reaches an edge.
25969 * Tell the internal scroller object whether it should bounce or not
25970 * when it reaches the respective edges for each axis.
25972 * @param obj The diskselector object.
25973 * @param h_bounce Whether to bounce or not in the horizontal axis.
25974 * @param v_bounce Whether to bounce or not in the vertical axis.
25976 * @see elm_scroller_bounce_set()
25978 * @ingroup Diskselector
25980 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
25983 * Get the bouncing behaviour of the internal scroller.
25985 * Get whether the internal scroller should bounce when the edge of each
25986 * axis is reached scrolling.
25988 * @param obj The diskselector object.
25989 * @param h_bounce Pointer where to store the bounce state of the horizontal
25991 * @param v_bounce Pointer where to store the bounce state of the vertical
25994 * @see elm_scroller_bounce_get()
25995 * @see elm_diskselector_bounce_set()
25997 * @ingroup Diskselector
25999 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
26002 * Get the scrollbar policy.
26004 * @see elm_diskselector_scroller_policy_get() for details.
26006 * @param obj The diskselector object.
26007 * @param policy_h Pointer where to store horizontal scrollbar policy.
26008 * @param policy_v Pointer where to store vertical scrollbar policy.
26010 * @ingroup Diskselector
26012 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);
26015 * Set the scrollbar policy.
26017 * @param obj The diskselector object.
26018 * @param policy_h Horizontal scrollbar policy.
26019 * @param policy_v Vertical scrollbar policy.
26021 * This sets the scrollbar visibility policy for the given scroller.
26022 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
26023 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
26024 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
26025 * This applies respectively for the horizontal and vertical scrollbars.
26027 * The both are disabled by default, i.e., are set to
26028 * #ELM_SCROLLER_POLICY_OFF.
26030 * @ingroup Diskselector
26032 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
26035 * Remove all diskselector's items.
26037 * @param obj The diskselector object.
26039 * @see elm_diskselector_item_del()
26040 * @see elm_diskselector_item_append()
26042 * @ingroup Diskselector
26044 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26047 * Get a list of all the diskselector items.
26049 * @param obj The diskselector object.
26050 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
26051 * or @c NULL on failure.
26053 * @see elm_diskselector_item_append()
26054 * @see elm_diskselector_item_del()
26055 * @see elm_diskselector_clear()
26057 * @ingroup Diskselector
26059 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26062 * Appends a new item to the diskselector object.
26064 * @param obj The diskselector object.
26065 * @param label The label of the diskselector item.
26066 * @param icon The icon object to use at left side of the item. An
26067 * icon can be any Evas object, but usually it is an icon created
26068 * with elm_icon_add().
26069 * @param func The function to call when the item is selected.
26070 * @param data The data to associate with the item for related callbacks.
26072 * @return The created item or @c NULL upon failure.
26074 * A new item will be created and appended to the diskselector, i.e., will
26075 * be set as last item. Also, if there is no selected item, it will
26076 * be selected. This will always happens for the first appended item.
26078 * If no icon is set, label will be centered on item position, otherwise
26079 * the icon will be placed at left of the label, that will be shifted
26082 * Items created with this method can be deleted with
26083 * elm_diskselector_item_del().
26085 * Associated @p data can be properly freed when item is deleted if a
26086 * callback function is set with elm_diskselector_item_del_cb_set().
26088 * If a function is passed as argument, it will be called everytime this item
26089 * is selected, i.e., the user stops the diskselector with this
26090 * item on center position. If such function isn't needed, just passing
26091 * @c NULL as @p func is enough. The same should be done for @p data.
26093 * Simple example (with no function callback or data associated):
26095 * disk = elm_diskselector_add(win);
26096 * ic = elm_icon_add(win);
26097 * elm_icon_file_set(ic, "path/to/image", NULL);
26098 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
26099 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
26102 * @see elm_diskselector_item_del()
26103 * @see elm_diskselector_item_del_cb_set()
26104 * @see elm_diskselector_clear()
26105 * @see elm_icon_add()
26107 * @ingroup Diskselector
26109 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);
26113 * Delete them item from the diskselector.
26115 * @param it The item of diskselector to be deleted.
26117 * If deleting all diskselector items is required, elm_diskselector_clear()
26118 * should be used instead of getting items list and deleting each one.
26120 * @see elm_diskselector_clear()
26121 * @see elm_diskselector_item_append()
26122 * @see elm_diskselector_item_del_cb_set()
26124 * @ingroup Diskselector
26126 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26129 * Set the function called when a diskselector item is freed.
26131 * @param it The item to set the callback on
26132 * @param func The function called
26134 * If there is a @p func, then it will be called prior item's memory release.
26135 * That will be called with the following arguments:
26137 * @li item's Evas object;
26140 * This way, a data associated to a diskselector item could be properly
26143 * @ingroup Diskselector
26145 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
26148 * Get the data associated to the item.
26150 * @param it The diskselector item
26151 * @return The data associated to @p it
26153 * The return value is a pointer to data associated to @p item when it was
26154 * created, with function elm_diskselector_item_append(). If no data
26155 * was passed as argument, it will return @c NULL.
26157 * @see elm_diskselector_item_append()
26159 * @ingroup Diskselector
26161 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26164 * Set the icon associated to the item.
26166 * @param it The diskselector item
26167 * @param icon The icon object to associate with @p it
26169 * The icon object to use at left side of the item. An
26170 * icon can be any Evas object, but usually it is an icon created
26171 * with elm_icon_add().
26173 * Once the icon object is set, a previously set one will be deleted.
26174 * @warning Setting the same icon for two items will cause the icon to
26175 * dissapear from the first item.
26177 * If an icon was passed as argument on item creation, with function
26178 * elm_diskselector_item_append(), it will be already
26179 * associated to the item.
26181 * @see elm_diskselector_item_append()
26182 * @see elm_diskselector_item_icon_get()
26184 * @ingroup Diskselector
26186 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
26189 * Get the icon associated to the item.
26191 * @param it The diskselector item
26192 * @return The icon associated to @p it
26194 * The return value is a pointer to the icon associated to @p item when it was
26195 * created, with function elm_diskselector_item_append(), or later
26196 * with function elm_diskselector_item_icon_set. If no icon
26197 * was passed as argument, it will return @c NULL.
26199 * @see elm_diskselector_item_append()
26200 * @see elm_diskselector_item_icon_set()
26202 * @ingroup Diskselector
26204 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26207 * Set the label of item.
26209 * @param it The item of diskselector.
26210 * @param label The label of item.
26212 * The label to be displayed by the item.
26214 * If no icon is set, label will be centered on item position, otherwise
26215 * the icon will be placed at left of the label, that will be shifted
26218 * An item with label "January" would be displayed on side position as
26219 * "Jan" if max length is set to 3 with function
26220 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
26223 * When this @p item is selected, the entire label will be displayed,
26224 * except for width restrictions.
26225 * In this case label will be cropped and "..." will be concatenated,
26226 * but only for display purposes. It will keep the entire string, so
26227 * if diskselector is resized the remaining characters will be displayed.
26229 * If a label was passed as argument on item creation, with function
26230 * elm_diskselector_item_append(), it will be already
26231 * displayed by the item.
26233 * @see elm_diskselector_side_label_lenght_set()
26234 * @see elm_diskselector_item_label_get()
26235 * @see elm_diskselector_item_append()
26237 * @ingroup Diskselector
26239 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
26242 * Get the label of item.
26244 * @param it The item of diskselector.
26245 * @return The label of item.
26247 * The return value is a pointer to the label associated to @p item when it was
26248 * created, with function elm_diskselector_item_append(), or later
26249 * with function elm_diskselector_item_label_set. If no label
26250 * was passed as argument, it will return @c NULL.
26252 * @see elm_diskselector_item_label_set() for more details.
26253 * @see elm_diskselector_item_append()
26255 * @ingroup Diskselector
26257 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26260 * Get the selected item.
26262 * @param obj The diskselector object.
26263 * @return The selected diskselector item.
26265 * The selected item can be unselected with function
26266 * elm_diskselector_item_selected_set(), and the first item of
26267 * diskselector will be selected.
26269 * The selected item always will be centered on diskselector, with
26270 * full label displayed, i.e., max lenght set to side labels won't
26271 * apply on the selected item. More details on
26272 * elm_diskselector_side_label_length_set().
26274 * @ingroup Diskselector
26276 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26279 * Set the selected state of an item.
26281 * @param it The diskselector item
26282 * @param selected The selected state
26284 * This sets the selected state of the given item @p it.
26285 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
26287 * If a new item is selected the previosly selected will be unselected.
26288 * Previoulsy selected item can be get with function
26289 * elm_diskselector_selected_item_get().
26291 * If the item @p it is unselected, the first item of diskselector will
26294 * Selected items will be visible on center position of diskselector.
26295 * So if it was on another position before selected, or was invisible,
26296 * diskselector will animate items until the selected item reaches center
26299 * @see elm_diskselector_item_selected_get()
26300 * @see elm_diskselector_selected_item_get()
26302 * @ingroup Diskselector
26304 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
26307 * Get whether the @p item is selected or not.
26309 * @param it The diskselector item.
26310 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
26311 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
26313 * @see elm_diskselector_selected_item_set() for details.
26314 * @see elm_diskselector_item_selected_get()
26316 * @ingroup Diskselector
26318 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26321 * Get the first item of the diskselector.
26323 * @param obj The diskselector object.
26324 * @return The first item, or @c NULL if none.
26326 * The list of items follows append order. So it will return the first
26327 * item appended to the widget that wasn't deleted.
26329 * @see elm_diskselector_item_append()
26330 * @see elm_diskselector_items_get()
26332 * @ingroup Diskselector
26334 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26337 * Get the last item of the diskselector.
26339 * @param obj The diskselector object.
26340 * @return The last item, or @c NULL if none.
26342 * The list of items follows append order. So it will return last first
26343 * item appended to the widget that wasn't deleted.
26345 * @see elm_diskselector_item_append()
26346 * @see elm_diskselector_items_get()
26348 * @ingroup Diskselector
26350 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26353 * Get the item before @p item in diskselector.
26355 * @param it The diskselector item.
26356 * @return The item before @p item, or @c NULL if none or on failure.
26358 * The list of items follows append order. So it will return item appended
26359 * just before @p item and that wasn't deleted.
26361 * If it is the first item, @c NULL will be returned.
26362 * First item can be get by elm_diskselector_first_item_get().
26364 * @see elm_diskselector_item_append()
26365 * @see elm_diskselector_items_get()
26367 * @ingroup Diskselector
26369 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26372 * Get the item after @p item in diskselector.
26374 * @param it The diskselector item.
26375 * @return The item after @p item, or @c NULL if none or on failure.
26377 * The list of items follows append order. So it will return item appended
26378 * just after @p item and that wasn't deleted.
26380 * If it is the last item, @c NULL will be returned.
26381 * Last item can be get by elm_diskselector_last_item_get().
26383 * @see elm_diskselector_item_append()
26384 * @see elm_diskselector_items_get()
26386 * @ingroup Diskselector
26388 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26391 * Set the text to be shown in the diskselector item.
26393 * @param item Target item
26394 * @param text The text to set in the content
26396 * Setup the text as tooltip to object. The item can have only one tooltip,
26397 * so any previous tooltip data is removed.
26399 * @see elm_object_tooltip_text_set() for more details.
26401 * @ingroup Diskselector
26403 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
26406 * Set the content to be shown in the tooltip item.
26408 * Setup the tooltip to item. The item can have only one tooltip,
26409 * so any previous tooltip data is removed. @p func(with @p data) will
26410 * be called every time that need show the tooltip and it should
26411 * return a valid Evas_Object. This object is then managed fully by
26412 * tooltip system and is deleted when the tooltip is gone.
26414 * @param item the diskselector item being attached a tooltip.
26415 * @param func the function used to create the tooltip contents.
26416 * @param data what to provide to @a func as callback data/context.
26417 * @param del_cb called when data is not needed anymore, either when
26418 * another callback replaces @p func, the tooltip is unset with
26419 * elm_diskselector_item_tooltip_unset() or the owner @a item
26420 * dies. This callback receives as the first parameter the
26421 * given @a data, and @c event_info is the item.
26423 * @see elm_object_tooltip_content_cb_set() for more details.
26425 * @ingroup Diskselector
26427 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);
26430 * Unset tooltip from item.
26432 * @param item diskselector item to remove previously set tooltip.
26434 * Remove tooltip from item. The callback provided as del_cb to
26435 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
26436 * it is not used anymore.
26438 * @see elm_object_tooltip_unset() for more details.
26439 * @see elm_diskselector_item_tooltip_content_cb_set()
26441 * @ingroup Diskselector
26443 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26447 * Sets a different style for this item tooltip.
26449 * @note before you set a style you should define a tooltip with
26450 * elm_diskselector_item_tooltip_content_cb_set() or
26451 * elm_diskselector_item_tooltip_text_set()
26453 * @param item diskselector item with tooltip already set.
26454 * @param style the theme style to use (default, transparent, ...)
26456 * @see elm_object_tooltip_style_set() for more details.
26458 * @ingroup Diskselector
26460 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26463 * Get the style for this item tooltip.
26465 * @param item diskselector item with tooltip already set.
26466 * @return style the theme style in use, defaults to "default". If the
26467 * object does not have a tooltip set, then NULL is returned.
26469 * @see elm_object_tooltip_style_get() for more details.
26470 * @see elm_diskselector_item_tooltip_style_set()
26472 * @ingroup Diskselector
26474 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26477 * Set the cursor to be shown when mouse is over the diskselector item
26479 * @param item Target item
26480 * @param cursor the cursor name to be used.
26482 * @see elm_object_cursor_set() for more details.
26484 * @ingroup Diskselector
26486 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
26489 * Get the cursor to be shown when mouse is over the diskselector item
26491 * @param item diskselector item with cursor already set.
26492 * @return the cursor name.
26494 * @see elm_object_cursor_get() for more details.
26495 * @see elm_diskselector_cursor_set()
26497 * @ingroup Diskselector
26499 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26503 * Unset the cursor to be shown when mouse is over the diskselector item
26505 * @param item Target item
26507 * @see elm_object_cursor_unset() for more details.
26508 * @see elm_diskselector_cursor_set()
26510 * @ingroup Diskselector
26512 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26515 * Sets a different style for this item cursor.
26517 * @note before you set a style you should define a cursor with
26518 * elm_diskselector_item_cursor_set()
26520 * @param item diskselector item with cursor already set.
26521 * @param style the theme style to use (default, transparent, ...)
26523 * @see elm_object_cursor_style_set() for more details.
26525 * @ingroup Diskselector
26527 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26531 * Get the style for this item cursor.
26533 * @param item diskselector item with cursor already set.
26534 * @return style the theme style in use, defaults to "default". If the
26535 * object does not have a cursor set, then @c NULL is returned.
26537 * @see elm_object_cursor_style_get() for more details.
26538 * @see elm_diskselector_item_cursor_style_set()
26540 * @ingroup Diskselector
26542 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26546 * Set if the cursor set should be searched on the theme or should use
26547 * the provided by the engine, only.
26549 * @note before you set if should look on theme you should define a cursor
26550 * with elm_diskselector_item_cursor_set().
26551 * By default it will only look for cursors provided by the engine.
26553 * @param item widget item with cursor already set.
26554 * @param engine_only boolean to define if cursors set with
26555 * elm_diskselector_item_cursor_set() should be searched only
26556 * between cursors provided by the engine or searched on widget's
26559 * @see elm_object_cursor_engine_only_set() for more details.
26561 * @ingroup Diskselector
26563 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
26566 * Get the cursor engine only usage for this item cursor.
26568 * @param item widget item with cursor already set.
26569 * @return engine_only boolean to define it cursors should be looked only
26570 * between the provided by the engine or searched on widget's theme as well.
26571 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
26573 * @see elm_object_cursor_engine_only_get() for more details.
26574 * @see elm_diskselector_item_cursor_engine_only_set()
26576 * @ingroup Diskselector
26578 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26585 * @defgroup Colorselector Colorselector
26589 * @image html img/widget/colorselector/preview-00.png
26590 * @image latex img/widget/colorselector/preview-00.eps
26592 * @brief Widget for user to select a color.
26594 * Signals that you can add callbacks for are:
26595 * "changed" - When the color value changes(event_info is NULL).
26597 * See @ref tutorial_colorselector.
26600 * @brief Add a new colorselector to the parent
26602 * @param parent The parent object
26603 * @return The new object or NULL if it cannot be created
26605 * @ingroup Colorselector
26607 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26609 * Set a color for the colorselector
26611 * @param obj Colorselector object
26612 * @param r r-value of color
26613 * @param g g-value of color
26614 * @param b b-value of color
26615 * @param a a-value of color
26617 * @ingroup Colorselector
26619 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
26621 * Get a color from the colorselector
26623 * @param obj Colorselector object
26624 * @param r integer pointer for r-value of color
26625 * @param g integer pointer for g-value of color
26626 * @param b integer pointer for b-value of color
26627 * @param a integer pointer for a-value of color
26629 * @ingroup Colorselector
26631 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
26637 * @defgroup Ctxpopup Ctxpopup
26639 * @image html img/widget/ctxpopup/preview-00.png
26640 * @image latex img/widget/ctxpopup/preview-00.eps
26642 * @brief Context popup widet.
26644 * A ctxpopup is a widget that, when shown, pops up a list of items.
26645 * It automatically chooses an area inside its parent object's view
26646 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
26647 * optimally fit into it. In the default theme, it will also point an
26648 * arrow to it's top left position at the time one shows it. Ctxpopup
26649 * items have a label and/or an icon. It is intended for a small
26650 * number of items (hence the use of list, not genlist).
26652 * @note Ctxpopup is a especialization of @ref Hover.
26654 * Signals that you can add callbacks for are:
26655 * "dismissed" - the ctxpopup was dismissed
26657 * Default contents parts of the ctxpopup widget that you can use for are:
26658 * @li "default" - A content of the ctxpopup
26660 * Default contents parts of the naviframe items that you can use for are:
26661 * @li "icon" - A icon in the title area
26663 * Default text parts of the naviframe items that you can use for are:
26664 * @li "default" - Title label in the title area
26666 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
26669 typedef enum _Elm_Ctxpopup_Direction
26671 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
26673 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
26674 the clicked area */
26675 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
26676 the clicked area */
26677 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
26679 ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
26680 } Elm_Ctxpopup_Direction;
26683 * @brief Add a new Ctxpopup object to the parent.
26685 * @param parent Parent object
26686 * @return New object or @c NULL, if it cannot be created
26688 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26690 * @brief Set the Ctxpopup's parent
26692 * @param obj The ctxpopup object
26693 * @param area The parent to use
26695 * Set the parent object.
26697 * @note elm_ctxpopup_add() will automatically call this function
26698 * with its @c parent argument.
26700 * @see elm_ctxpopup_add()
26701 * @see elm_hover_parent_set()
26703 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
26705 * @brief Get the Ctxpopup's parent
26707 * @param obj The ctxpopup object
26709 * @see elm_ctxpopup_hover_parent_set() for more information
26711 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26713 * @brief Clear all items in the given ctxpopup object.
26715 * @param obj Ctxpopup object
26717 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26719 * @brief Change the ctxpopup's orientation to horizontal or vertical.
26721 * @param obj Ctxpopup object
26722 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
26724 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
26726 * @brief Get the value of current ctxpopup object's orientation.
26728 * @param obj Ctxpopup object
26729 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
26731 * @see elm_ctxpopup_horizontal_set()
26733 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26735 * @brief Add a new item to a ctxpopup object.
26737 * @param obj Ctxpopup object
26738 * @param icon Icon to be set on new item
26739 * @param label The Label of the new item
26740 * @param func Convenience function called when item selected
26741 * @param data Data passed to @p func
26742 * @return A handle to the item added or @c NULL, on errors
26744 * @warning Ctxpopup can't hold both an item list and a content at the same
26745 * time. When an item is added, any previous content will be removed.
26747 * @see elm_ctxpopup_content_set()
26749 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);
26751 * @brief Delete the given item in a ctxpopup object.
26753 * @param it Ctxpopup item to be deleted
26755 * @see elm_ctxpopup_item_append()
26757 EAPI void elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26759 * @brief Set the ctxpopup item's state as disabled or enabled.
26761 * @param it Ctxpopup item to be enabled/disabled
26762 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
26764 * When disabled the item is greyed out to indicate it's state.
26765 * @deprecated use elm_object_item_disabled_set() instead
26767 EINA_DEPRECATED EAPI void elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
26769 * @brief Get the ctxpopup item's disabled/enabled state.
26771 * @param it Ctxpopup item to be enabled/disabled
26772 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
26774 * @see elm_ctxpopup_item_disabled_set()
26775 * @deprecated use elm_object_item_disabled_get() instead
26777 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26779 * @brief Get the icon object for the given ctxpopup item.
26781 * @param it Ctxpopup item
26782 * @return icon object or @c NULL, if the item does not have icon or an error
26785 * @see elm_ctxpopup_item_append()
26786 * @see elm_ctxpopup_item_icon_set()
26788 * @deprecated use elm_object_item_part_content_get() instead
26790 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26792 * @brief Sets the side icon associated with the ctxpopup item
26794 * @param it Ctxpopup item
26795 * @param icon Icon object to be set
26797 * Once the icon object is set, a previously set one will be deleted.
26798 * @warning Setting the same icon for two items will cause the icon to
26799 * dissapear from the first item.
26801 * @see elm_ctxpopup_item_append()
26803 * @deprecated use elm_object_item_part_content_set() instead
26806 EINA_DEPRECATED EAPI void elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26808 * @brief Get the label for the given ctxpopup item.
26810 * @param it Ctxpopup item
26811 * @return label string or @c NULL, if the item does not have label or an
26814 * @see elm_ctxpopup_item_append()
26815 * @see elm_ctxpopup_item_label_set()
26817 * @deprecated use elm_object_item_text_get() instead
26819 EINA_DEPRECATED EAPI const char *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26821 * @brief (Re)set the label on the given ctxpopup item.
26823 * @param it Ctxpopup item
26824 * @param label String to set as label
26826 * @deprecated use elm_object_item_text_set() instead
26828 EINA_DEPRECATED EAPI void elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26830 * @brief Set an elm widget as the content of the ctxpopup.
26832 * @param obj Ctxpopup object
26833 * @param content Content to be swallowed
26835 * If the content object is already set, a previous one will bedeleted. If
26836 * you want to keep that old content object, use the
26837 * elm_ctxpopup_content_unset() function.
26839 * @warning Ctxpopup can't hold both a item list and a content at the same
26840 * time. When a content is set, any previous items will be removed.
26842 * @deprecated use elm_object_content_set() instead
26845 EINA_DEPRECATED EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
26847 * @brief Unset the ctxpopup content
26849 * @param obj Ctxpopup object
26850 * @return The content that was being used
26852 * Unparent and return the content object which was set for this widget.
26854 * @deprecated use elm_object_content_unset()
26856 * @see elm_ctxpopup_content_set()
26858 * @deprecated use elm_object_content_unset() instead
26861 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
26863 * @brief Set the direction priority of a ctxpopup.
26865 * @param obj Ctxpopup object
26866 * @param first 1st priority of direction
26867 * @param second 2nd priority of direction
26868 * @param third 3th priority of direction
26869 * @param fourth 4th priority of direction
26871 * This functions gives a chance to user to set the priority of ctxpopup
26872 * showing direction. This doesn't guarantee the ctxpopup will appear in the
26873 * requested direction.
26875 * @see Elm_Ctxpopup_Direction
26877 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);
26879 * @brief Get the direction priority of a ctxpopup.
26881 * @param obj Ctxpopup object
26882 * @param first 1st priority of direction to be returned
26883 * @param second 2nd priority of direction to be returned
26884 * @param third 3th priority of direction to be returned
26885 * @param fourth 4th priority of direction to be returned
26887 * @see elm_ctxpopup_direction_priority_set() for more information.
26889 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);
26892 * @brief Get the current direction of a ctxpopup.
26894 * @param obj Ctxpopup object
26895 * @return current direction of a ctxpopup
26897 * @warning Once the ctxpopup showed up, the direction would be determined
26899 EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26908 * @defgroup Transit Transit
26909 * @ingroup Elementary
26911 * Transit is designed to apply various animated transition effects to @c
26912 * Evas_Object, such like translation, rotation, etc. For using these
26913 * effects, create an @ref Elm_Transit and add the desired transition effects.
26915 * Once the effects are added into transit, they will be automatically
26916 * managed (their callback will be called until the duration is ended, and
26917 * they will be deleted on completion).
26921 * Elm_Transit *trans = elm_transit_add();
26922 * elm_transit_object_add(trans, obj);
26923 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
26924 * elm_transit_duration_set(transit, 1);
26925 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
26926 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
26927 * elm_transit_repeat_times_set(transit, 3);
26930 * Some transition effects are used to change the properties of objects. They
26932 * @li @ref elm_transit_effect_translation_add
26933 * @li @ref elm_transit_effect_color_add
26934 * @li @ref elm_transit_effect_rotation_add
26935 * @li @ref elm_transit_effect_wipe_add
26936 * @li @ref elm_transit_effect_zoom_add
26937 * @li @ref elm_transit_effect_resizing_add
26939 * Other transition effects are used to make one object disappear and another
26940 * object appear on its old place. These effects are:
26942 * @li @ref elm_transit_effect_flip_add
26943 * @li @ref elm_transit_effect_resizable_flip_add
26944 * @li @ref elm_transit_effect_fade_add
26945 * @li @ref elm_transit_effect_blend_add
26947 * It's also possible to make a transition chain with @ref
26948 * elm_transit_chain_transit_add.
26950 * @warning We strongly recommend to use elm_transit just when edje can not do
26951 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
26952 * animations can be manipulated inside the theme.
26954 * List of examples:
26955 * @li @ref transit_example_01_explained
26956 * @li @ref transit_example_02_explained
26957 * @li @ref transit_example_03_c
26958 * @li @ref transit_example_04_c
26964 * @enum Elm_Transit_Tween_Mode
26966 * The type of acceleration used in the transition.
26970 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
26971 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
26972 over time, then decrease again
26974 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
26976 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
26978 } Elm_Transit_Tween_Mode;
26981 * @enum Elm_Transit_Effect_Flip_Axis
26983 * The axis where flip effect should be applied.
26987 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
26988 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
26989 } Elm_Transit_Effect_Flip_Axis;
26991 * @enum Elm_Transit_Effect_Wipe_Dir
26993 * The direction where the wipe effect should occur.
26997 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
26998 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
26999 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
27000 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
27001 } Elm_Transit_Effect_Wipe_Dir;
27002 /** @enum Elm_Transit_Effect_Wipe_Type
27004 * Whether the wipe effect should show or hide the object.
27008 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
27010 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
27012 } Elm_Transit_Effect_Wipe_Type;
27015 * @typedef Elm_Transit
27017 * The Transit created with elm_transit_add(). This type has the information
27018 * about the objects which the transition will be applied, and the
27019 * transition effects that will be used. It also contains info about
27020 * duration, number of repetitions, auto-reverse, etc.
27022 typedef struct _Elm_Transit Elm_Transit;
27023 typedef void Elm_Transit_Effect;
27025 * @typedef Elm_Transit_Effect_Transition_Cb
27027 * Transition callback called for this effect on each transition iteration.
27029 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
27031 * Elm_Transit_Effect_End_Cb
27033 * Transition callback called for this effect when the transition is over.
27035 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
27038 * Elm_Transit_Del_Cb
27040 * A callback called when the transit is deleted.
27042 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
27047 * @note Is not necessary to delete the transit object, it will be deleted at
27048 * the end of its operation.
27049 * @note The transit will start playing when the program enter in the main loop, is not
27050 * necessary to give a start to the transit.
27052 * @return The transit object.
27056 EAPI Elm_Transit *elm_transit_add(void);
27059 * Stops the animation and delete the @p transit object.
27061 * Call this function if you wants to stop the animation before the duration
27062 * time. Make sure the @p transit object is still alive with
27063 * elm_transit_del_cb_set() function.
27064 * All added effects will be deleted, calling its repective data_free_cb
27065 * functions. The function setted by elm_transit_del_cb_set() will be called.
27067 * @see elm_transit_del_cb_set()
27069 * @param transit The transit object to be deleted.
27072 * @warning Just call this function if you are sure the transit is alive.
27074 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27077 * Add a new effect to the transit.
27079 * @note The cb function and the data are the key to the effect. If you try to
27080 * add an already added effect, nothing is done.
27081 * @note After the first addition of an effect in @p transit, if its
27082 * effect list become empty again, the @p transit will be killed by
27083 * elm_transit_del(transit) function.
27087 * Elm_Transit *transit = elm_transit_add();
27088 * elm_transit_effect_add(transit,
27089 * elm_transit_effect_blend_op,
27090 * elm_transit_effect_blend_context_new(),
27091 * elm_transit_effect_blend_context_free);
27094 * @param transit The transit object.
27095 * @param transition_cb The operation function. It is called when the
27096 * animation begins, it is the function that actually performs the animation.
27097 * It is called with the @p data, @p transit and the time progression of the
27098 * animation (a double value between 0.0 and 1.0).
27099 * @param effect The context data of the effect.
27100 * @param end_cb The function to free the context data, it will be called
27101 * at the end of the effect, it must finalize the animation and free the
27105 * @warning The transit free the context data at the and of the transition with
27106 * the data_free_cb function, do not use the context data in another transit.
27108 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);
27111 * Delete an added effect.
27113 * This function will remove the effect from the @p transit, calling the
27114 * data_free_cb to free the @p data.
27116 * @see elm_transit_effect_add()
27118 * @note If the effect is not found, nothing is done.
27119 * @note If the effect list become empty, this function will call
27120 * elm_transit_del(transit), that is, it will kill the @p transit.
27122 * @param transit The transit object.
27123 * @param transition_cb The operation function.
27124 * @param effect The context data of the effect.
27128 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);
27131 * Add new object to apply the effects.
27133 * @note After the first addition of an object in @p transit, if its
27134 * object list become empty again, the @p transit will be killed by
27135 * elm_transit_del(transit) function.
27136 * @note If the @p obj belongs to another transit, the @p obj will be
27137 * removed from it and it will only belong to the @p transit. If the old
27138 * transit stays without objects, it will die.
27139 * @note When you add an object into the @p transit, its state from
27140 * evas_object_pass_events_get(obj) is saved, and it is applied when the
27141 * transit ends, if you change this state whith evas_object_pass_events_set()
27142 * after add the object, this state will change again when @p transit stops to
27145 * @param transit The transit object.
27146 * @param obj Object to be animated.
27149 * @warning It is not allowed to add a new object after transit begins to go.
27151 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
27154 * Removes an added object from the transit.
27156 * @note If the @p obj is not in the @p transit, nothing is done.
27157 * @note If the list become empty, this function will call
27158 * elm_transit_del(transit), that is, it will kill the @p transit.
27160 * @param transit The transit object.
27161 * @param obj Object to be removed from @p transit.
27164 * @warning It is not allowed to remove objects after transit begins to go.
27166 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
27169 * Get the objects of the transit.
27171 * @param transit The transit object.
27172 * @return a Eina_List with the objects from the transit.
27176 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27179 * Enable/disable keeping up the objects states.
27180 * If it is not kept, the objects states will be reset when transition ends.
27182 * @note @p transit can not be NULL.
27183 * @note One state includes geometry, color, map data.
27185 * @param transit The transit object.
27186 * @param state_keep Keeping or Non Keeping.
27190 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
27193 * Get a value whether the objects states will be reset or not.
27195 * @note @p transit can not be NULL
27197 * @see elm_transit_objects_final_state_keep_set()
27199 * @param transit The transit object.
27200 * @return EINA_TRUE means the states of the objects will be reset.
27201 * If @p transit is NULL, EINA_FALSE is returned
27205 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27208 * Set the event enabled when transit is operating.
27210 * If @p enabled is EINA_TRUE, the objects of the transit will receives
27211 * events from mouse and keyboard during the animation.
27212 * @note When you add an object with elm_transit_object_add(), its state from
27213 * evas_object_pass_events_get(obj) is saved, and it is applied when the
27214 * transit ends, if you change this state with evas_object_pass_events_set()
27215 * after adding the object, this state will change again when @p transit stops
27218 * @param transit The transit object.
27219 * @param enabled Events are received when enabled is @c EINA_TRUE, and
27220 * ignored otherwise.
27224 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
27227 * Get the value of event enabled status.
27229 * @see elm_transit_event_enabled_set()
27231 * @param transit The Transit object
27232 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
27233 * EINA_FALSE is returned
27237 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27240 * Set the user-callback function when the transit is deleted.
27242 * @note Using this function twice will overwrite the first function setted.
27243 * @note the @p transit object will be deleted after call @p cb function.
27245 * @param transit The transit object.
27246 * @param cb Callback function pointer. This function will be called before
27247 * the deletion of the transit.
27248 * @param data Callback funtion user data. It is the @p op parameter.
27252 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
27255 * Set reverse effect automatically.
27257 * If auto reverse is setted, after running the effects with the progress
27258 * parameter from 0 to 1, it will call the effecs again with the progress
27259 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
27260 * where the duration was setted with the function elm_transit_add and
27261 * the repeat with the function elm_transit_repeat_times_set().
27263 * @param transit The transit object.
27264 * @param reverse EINA_TRUE means the auto_reverse is on.
27268 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
27271 * Get if the auto reverse is on.
27273 * @see elm_transit_auto_reverse_set()
27275 * @param transit The transit object.
27276 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
27277 * EINA_FALSE is returned
27281 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27284 * Set the transit repeat count. Effect will be repeated by repeat count.
27286 * This function sets the number of repetition the transit will run after
27287 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
27288 * If the @p repeat is a negative number, it will repeat infinite times.
27290 * @note If this function is called during the transit execution, the transit
27291 * will run @p repeat times, ignoring the times it already performed.
27293 * @param transit The transit object
27294 * @param repeat Repeat count
27298 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
27301 * Get the transit repeat count.
27303 * @see elm_transit_repeat_times_set()
27305 * @param transit The Transit object.
27306 * @return The repeat count. If @p transit is NULL
27311 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27314 * Set the transit animation acceleration type.
27316 * This function sets the tween mode of the transit that can be:
27317 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
27318 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
27319 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
27320 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
27322 * @param transit The transit object.
27323 * @param tween_mode The tween type.
27327 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
27330 * Get the transit animation acceleration type.
27332 * @note @p transit can not be NULL
27334 * @param transit The transit object.
27335 * @return The tween type. If @p transit is NULL
27336 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
27340 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27343 * Set the transit animation time
27345 * @note @p transit can not be NULL
27347 * @param transit The transit object.
27348 * @param duration The animation time.
27352 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
27355 * Get the transit animation time
27357 * @note @p transit can not be NULL
27359 * @param transit The transit object.
27361 * @return The transit animation time.
27365 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27368 * Starts the transition.
27369 * Once this API is called, the transit begins to measure the time.
27371 * @note @p transit can not be NULL
27373 * @param transit The transit object.
27377 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27380 * Pause/Resume the transition.
27382 * If you call elm_transit_go again, the transit will be started from the
27383 * beginning, and will be unpaused.
27385 * @note @p transit can not be NULL
27387 * @param transit The transit object.
27388 * @param paused Whether the transition should be paused or not.
27392 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
27395 * Get the value of paused status.
27397 * @see elm_transit_paused_set()
27399 * @note @p transit can not be NULL
27401 * @param transit The transit object.
27402 * @return EINA_TRUE means transition is paused. If @p transit is NULL
27403 * EINA_FALSE is returned
27407 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27410 * Get the time progression of the animation (a double value between 0.0 and 1.0).
27412 * The value returned is a fraction (current time / total time). It
27413 * represents the progression position relative to the total.
27415 * @note @p transit can not be NULL
27417 * @param transit The transit object.
27419 * @return The time progression value. If @p transit is NULL
27424 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27427 * Makes the chain relationship between two transits.
27429 * @note @p transit can not be NULL. Transit would have multiple chain transits.
27430 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
27432 * @param transit The transit object.
27433 * @param chain_transit The chain transit object. This transit will be operated
27434 * after transit is done.
27436 * This function adds @p chain_transit transition to a chain after the @p
27437 * transit, and will be started as soon as @p transit ends. See @ref
27438 * transit_example_02_explained for a full example.
27442 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
27445 * Cut off the chain relationship between two transits.
27447 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
27448 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
27450 * @param transit The transit object.
27451 * @param chain_transit The chain transit object.
27453 * This function remove the @p chain_transit transition from the @p transit.
27457 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
27460 * Get the current chain transit list.
27462 * @note @p transit can not be NULL.
27464 * @param transit The transit object.
27465 * @return chain transit list.
27469 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
27472 * Add the Resizing Effect to Elm_Transit.
27474 * @note This API is one of the facades. It creates resizing 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 from_w Object width size when effect begins.
27481 * @param from_h Object height size when effect begins.
27482 * @param to_w Object width size when effect ends.
27483 * @param to_h Object height size when effect ends.
27484 * @return Resizing effect context data.
27488 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);
27491 * Add the Translation Effect to Elm_Transit.
27493 * @note This API is one of the facades. It creates translation effect context
27494 * and add it's required APIs to elm_transit_effect_add.
27496 * @see elm_transit_effect_add()
27498 * @param transit Transit object.
27499 * @param from_dx X Position variation when effect begins.
27500 * @param from_dy Y Position variation when effect begins.
27501 * @param to_dx X Position variation when effect ends.
27502 * @param to_dy Y Position variation when effect ends.
27503 * @return Translation effect context data.
27506 * @warning It is highly recommended just create a transit with this effect when
27507 * the window that the objects of the transit belongs has already been created.
27508 * This is because this effect needs the geometry information about the objects,
27509 * and if the window was not created yet, it can get a wrong information.
27511 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);
27514 * Add the Zoom Effect to Elm_Transit.
27516 * @note This API is one of the facades. It creates zoom effect context
27517 * and add it's required APIs to elm_transit_effect_add.
27519 * @see elm_transit_effect_add()
27521 * @param transit Transit object.
27522 * @param from_rate Scale rate when effect begins (1 is current rate).
27523 * @param to_rate Scale rate when effect ends.
27524 * @return Zoom effect context data.
27527 * @warning It is highly recommended just create a transit with this effect when
27528 * the window that the objects of the transit belongs has already been created.
27529 * This is because this effect needs the geometry information about the objects,
27530 * and if the window was not created yet, it can get a wrong information.
27532 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
27535 * Add the Flip Effect to Elm_Transit.
27537 * @note This API is one of the facades. It creates flip effect context
27538 * and add it's required APIs to elm_transit_effect_add.
27539 * @note This effect is applied to each pair of objects in the order they are listed
27540 * in the transit list of objects. The first object in the pair will be the
27541 * "front" object and the second will be the "back" object.
27543 * @see elm_transit_effect_add()
27545 * @param transit Transit object.
27546 * @param axis Flipping Axis(X or Y).
27547 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27548 * @return Flip effect context data.
27551 * @warning It is highly recommended just create a transit with this effect when
27552 * the window that the objects of the transit belongs has already been created.
27553 * This is because this effect needs the geometry information about the objects,
27554 * and if the window was not created yet, it can get a wrong information.
27556 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27559 * Add the Resizable Flip Effect to Elm_Transit.
27561 * @note This API is one of the facades. It creates resizable flip effect context
27562 * and add it's required APIs to elm_transit_effect_add.
27563 * @note This effect is applied to each pair of objects in the order they are listed
27564 * in the transit list of objects. The first object in the pair will be the
27565 * "front" object and the second will be the "back" object.
27567 * @see elm_transit_effect_add()
27569 * @param transit Transit object.
27570 * @param axis Flipping Axis(X or Y).
27571 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27572 * @return Resizable flip effect context data.
27575 * @warning It is highly recommended just create a transit with this effect when
27576 * the window that the objects of the transit belongs has already been created.
27577 * This is because this effect needs the geometry information about the objects,
27578 * and if the window was not created yet, it can get a wrong information.
27580 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27583 * Add the Wipe Effect to Elm_Transit.
27585 * @note This API is one of the facades. It creates wipe effect context
27586 * and add it's required APIs to elm_transit_effect_add.
27588 * @see elm_transit_effect_add()
27590 * @param transit Transit object.
27591 * @param type Wipe type. Hide or show.
27592 * @param dir Wipe Direction.
27593 * @return Wipe effect context data.
27596 * @warning It is highly recommended just create a transit with this effect when
27597 * the window that the objects of the transit belongs has already been created.
27598 * This is because this effect needs the geometry information about the objects,
27599 * and if the window was not created yet, it can get a wrong information.
27601 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
27604 * Add the Color Effect to Elm_Transit.
27606 * @note This API is one of the facades. It creates color effect context
27607 * and add it's required APIs to elm_transit_effect_add.
27609 * @see elm_transit_effect_add()
27611 * @param transit Transit object.
27612 * @param from_r RGB R when effect begins.
27613 * @param from_g RGB G when effect begins.
27614 * @param from_b RGB B when effect begins.
27615 * @param from_a RGB A when effect begins.
27616 * @param to_r RGB R when effect ends.
27617 * @param to_g RGB G when effect ends.
27618 * @param to_b RGB B when effect ends.
27619 * @param to_a RGB A when effect ends.
27620 * @return Color effect context data.
27624 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);
27627 * Add the Fade Effect to Elm_Transit.
27629 * @note This API is one of the facades. It creates fade effect context
27630 * and add it's required APIs to elm_transit_effect_add.
27631 * @note This effect is applied to each pair of objects in the order they are listed
27632 * in the transit list of objects. The first object in the pair will be the
27633 * "before" object and the second will be the "after" object.
27635 * @see elm_transit_effect_add()
27637 * @param transit Transit object.
27638 * @return Fade effect context data.
27641 * @warning It is highly recommended just create a transit with this effect when
27642 * the window that the objects of the transit belongs has already been created.
27643 * This is because this effect needs the color information about the objects,
27644 * and if the window was not created yet, it can get a wrong information.
27646 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
27649 * Add the Blend Effect to Elm_Transit.
27651 * @note This API is one of the facades. It creates blend effect context
27652 * and add it's required APIs to elm_transit_effect_add.
27653 * @note This effect is applied to each pair of objects in the order they are listed
27654 * in the transit list of objects. The first object in the pair will be the
27655 * "before" object and the second will be the "after" object.
27657 * @see elm_transit_effect_add()
27659 * @param transit Transit object.
27660 * @return Blend effect context data.
27663 * @warning It is highly recommended just create a transit with this effect when
27664 * the window that the objects of the transit belongs has already been created.
27665 * This is because this effect needs the color information about the objects,
27666 * and if the window was not created yet, it can get a wrong information.
27668 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
27671 * Add the Rotation Effect to Elm_Transit.
27673 * @note This API is one of the facades. It creates rotation effect context
27674 * and add it's required APIs to elm_transit_effect_add.
27676 * @see elm_transit_effect_add()
27678 * @param transit Transit object.
27679 * @param from_degree Degree when effect begins.
27680 * @param to_degree Degree when effect is ends.
27681 * @return Rotation effect context data.
27684 * @warning It is highly recommended just create a transit with this effect when
27685 * the window that the objects of the transit belongs has already been created.
27686 * This is because this effect needs the geometry information about the objects,
27687 * and if the window was not created yet, it can get a wrong information.
27689 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
27692 * Add the ImageAnimation Effect to Elm_Transit.
27694 * @note This API is one of the facades. It creates image animation effect context
27695 * and add it's required APIs to elm_transit_effect_add.
27696 * The @p images parameter is a list images paths. This list and
27697 * its contents will be deleted at the end of the effect by
27698 * elm_transit_effect_image_animation_context_free() function.
27702 * char buf[PATH_MAX];
27703 * Eina_List *images = NULL;
27704 * Elm_Transit *transi = elm_transit_add();
27706 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
27707 * images = eina_list_append(images, eina_stringshare_add(buf));
27709 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
27710 * images = eina_list_append(images, eina_stringshare_add(buf));
27711 * elm_transit_effect_image_animation_add(transi, images);
27715 * @see elm_transit_effect_add()
27717 * @param transit Transit object.
27718 * @param images Eina_List of images file paths. This list and
27719 * its contents will be deleted at the end of the effect by
27720 * elm_transit_effect_image_animation_context_free() function.
27721 * @return Image Animation effect context data.
27725 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
27730 typedef struct _Elm_Store Elm_Store;
27731 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
27732 typedef struct _Elm_Store_Item Elm_Store_Item;
27733 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
27734 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
27735 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
27736 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
27737 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
27738 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
27739 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
27740 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
27742 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
27743 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
27744 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
27745 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
27749 ELM_STORE_ITEM_MAPPING_NONE = 0,
27750 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
27751 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
27752 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
27753 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
27754 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
27755 // can add more here as needed by common apps
27756 ELM_STORE_ITEM_MAPPING_LAST
27757 } Elm_Store_Item_Mapping_Type;
27759 struct _Elm_Store_Item_Mapping_Icon
27761 // FIXME: allow edje file icons
27763 Elm_Icon_Lookup_Order lookup_order;
27764 Eina_Bool standard_name : 1;
27765 Eina_Bool no_scale : 1;
27766 Eina_Bool smooth : 1;
27767 Eina_Bool scale_up : 1;
27768 Eina_Bool scale_down : 1;
27771 struct _Elm_Store_Item_Mapping_Empty
27776 struct _Elm_Store_Item_Mapping_Photo
27781 struct _Elm_Store_Item_Mapping_Custom
27783 Elm_Store_Item_Mapping_Cb func;
27786 struct _Elm_Store_Item_Mapping
27788 Elm_Store_Item_Mapping_Type type;
27793 Elm_Store_Item_Mapping_Empty empty;
27794 Elm_Store_Item_Mapping_Icon icon;
27795 Elm_Store_Item_Mapping_Photo photo;
27796 Elm_Store_Item_Mapping_Custom custom;
27797 // add more types here
27801 struct _Elm_Store_Item_Info
27803 Elm_Genlist_Item_Class *item_class;
27804 const Elm_Store_Item_Mapping *mapping;
27809 struct _Elm_Store_Item_Info_Filesystem
27811 Elm_Store_Item_Info base;
27815 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
27816 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
27818 EAPI void elm_store_free(Elm_Store *st);
27820 EAPI Elm_Store *elm_store_filesystem_new(void);
27821 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
27822 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27823 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27825 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
27827 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
27828 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27829 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27830 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27831 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
27832 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27834 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27835 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
27836 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27837 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
27838 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27839 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27840 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27843 * @defgroup SegmentControl SegmentControl
27844 * @ingroup Elementary
27846 * @image html img/widget/segment_control/preview-00.png
27847 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
27849 * @image html img/segment_control.png
27850 * @image latex img/segment_control.eps width=\textwidth
27852 * Segment control widget is a horizontal control made of multiple segment
27853 * items, each segment item functioning similar to discrete two state button.
27854 * A segment control groups the items together and provides compact
27855 * single button with multiple equal size segments.
27857 * Segment item size is determined by base widget
27858 * size and the number of items added.
27859 * Only one segment item can be at selected state. A segment item can display
27860 * combination of Text and any Evas_Object like Images or other widget.
27862 * Smart callbacks one can listen to:
27863 * - "changed" - When the user clicks on a segment item which is not
27864 * previously selected and get selected. The event_info parameter is the
27865 * segment item pointer.
27867 * Available styles for it:
27870 * Here is an example on its usage:
27871 * @li @ref segment_control_example
27875 * @addtogroup SegmentControl
27879 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
27882 * Add a new segment control widget to the given parent Elementary
27883 * (container) object.
27885 * @param parent The parent object.
27886 * @return a new segment control widget handle or @c NULL, on errors.
27888 * This function inserts a new segment control widget on the canvas.
27890 * @ingroup SegmentControl
27892 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27895 * Append a new item to the segment control object.
27897 * @param obj The segment control object.
27898 * @param icon The icon object to use for the left side of the item. An
27899 * icon can be any Evas object, but usually it is an icon created
27900 * with elm_icon_add().
27901 * @param label The label of the item.
27902 * Note that, NULL is different from empty string "".
27903 * @return The created item or @c NULL upon failure.
27905 * A new item will be created and appended to the segment control, i.e., will
27906 * be set as @b last item.
27908 * If it should be inserted at another position,
27909 * elm_segment_control_item_insert_at() should be used instead.
27911 * Items created with this function can be deleted with function
27912 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27914 * @note @p label set to @c NULL is different from empty string "".
27916 * only has icon, it will be displayed bigger and centered. If it has
27917 * icon and label, even that an empty string, icon will be smaller and
27918 * positioned at left.
27922 * sc = elm_segment_control_add(win);
27923 * ic = elm_icon_add(win);
27924 * elm_icon_file_set(ic, "path/to/image", NULL);
27925 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
27926 * elm_segment_control_item_add(sc, ic, "label");
27927 * evas_object_show(sc);
27930 * @see elm_segment_control_item_insert_at()
27931 * @see elm_segment_control_item_del()
27933 * @ingroup SegmentControl
27935 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
27938 * Insert a new item to the segment control object at specified position.
27940 * @param obj The segment control object.
27941 * @param icon The icon object to use for the left side of the item. An
27942 * icon can be any Evas object, but usually it is an icon created
27943 * with elm_icon_add().
27944 * @param label The label of the item.
27945 * @param index Item position. Value should be between 0 and items count.
27946 * @return The created item or @c NULL upon failure.
27948 * Index values must be between @c 0, when item will be prepended to
27949 * segment control, and items count, that can be get with
27950 * elm_segment_control_item_count_get(), case when item will be appended
27951 * to segment control, just like elm_segment_control_item_add().
27953 * Items created with this function can be deleted with function
27954 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27956 * @note @p label set to @c NULL is different from empty string "".
27958 * only has icon, it will be displayed bigger and centered. If it has
27959 * icon and label, even that an empty string, icon will be smaller and
27960 * positioned at left.
27962 * @see elm_segment_control_item_add()
27963 * @see elm_segment_control_item_count_get()
27964 * @see elm_segment_control_item_del()
27966 * @ingroup SegmentControl
27968 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);
27971 * Remove a segment control item from its parent, deleting it.
27973 * @param it The item to be removed.
27975 * Items can be added with elm_segment_control_item_add() or
27976 * elm_segment_control_item_insert_at().
27978 * @ingroup SegmentControl
27980 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27983 * Remove a segment control item at given index from its parent,
27986 * @param obj The segment control object.
27987 * @param index The position of the segment control item to be deleted.
27989 * Items can be added with elm_segment_control_item_add() or
27990 * elm_segment_control_item_insert_at().
27992 * @ingroup SegmentControl
27994 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27997 * Get the Segment items count from segment control.
27999 * @param obj The segment control object.
28000 * @return Segment items count.
28002 * It will just return the number of items added to segment control @p obj.
28004 * @ingroup SegmentControl
28006 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28009 * Get the item placed at specified index.
28011 * @param obj The segment control object.
28012 * @param index The index of the segment item.
28013 * @return The segment control item or @c NULL on failure.
28015 * Index is the position of an item in segment control widget. Its
28016 * range is from @c 0 to <tt> count - 1 </tt>.
28017 * Count is the number of items, that can be get with
28018 * elm_segment_control_item_count_get().
28020 * @ingroup SegmentControl
28022 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28025 * Get the label of item.
28027 * @param obj The segment control object.
28028 * @param index The index of the segment item.
28029 * @return The label of the item at @p index.
28031 * The return value is a pointer to the label associated to the item when
28032 * it was created, with function elm_segment_control_item_add(), or later
28033 * with function elm_segment_control_item_label_set. If no label
28034 * was passed as argument, it will return @c NULL.
28036 * @see elm_segment_control_item_label_set() for more details.
28037 * @see elm_segment_control_item_add()
28039 * @ingroup SegmentControl
28041 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28044 * Set the label of item.
28046 * @param it The item of segment control.
28047 * @param text The label of item.
28049 * The label to be displayed by the item.
28050 * Label will be at right of the icon (if set).
28052 * If a label was passed as argument on item creation, with function
28053 * elm_control_segment_item_add(), it will be already
28054 * displayed by the item.
28056 * @see elm_segment_control_item_label_get()
28057 * @see elm_segment_control_item_add()
28059 * @ingroup SegmentControl
28061 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
28064 * Get the icon associated to the item.
28066 * @param obj The segment control object.
28067 * @param index The index of the segment item.
28068 * @return The left side icon associated to the item at @p index.
28070 * The return value is a pointer to the icon associated to the item when
28071 * it was created, with function elm_segment_control_item_add(), or later
28072 * with function elm_segment_control_item_icon_set(). If no icon
28073 * was passed as argument, it will return @c NULL.
28075 * @see elm_segment_control_item_add()
28076 * @see elm_segment_control_item_icon_set()
28078 * @ingroup SegmentControl
28080 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28083 * Set the icon associated to the item.
28085 * @param it The segment control item.
28086 * @param icon The icon object to associate with @p it.
28088 * The icon object to use at left side of the item. An
28089 * icon can be any Evas object, but usually it is an icon created
28090 * with elm_icon_add().
28092 * Once the icon object is set, a previously set one will be deleted.
28093 * @warning Setting the same icon for two items will cause the icon to
28094 * dissapear from the first item.
28096 * If an icon was passed as argument on item creation, with function
28097 * elm_segment_control_item_add(), it will be already
28098 * associated to the item.
28100 * @see elm_segment_control_item_add()
28101 * @see elm_segment_control_item_icon_get()
28103 * @ingroup SegmentControl
28105 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
28108 * Get the index of an item.
28110 * @param it The segment control item.
28111 * @return The position of item in segment control widget.
28113 * Index is the position of an item in segment control widget. Its
28114 * range is from @c 0 to <tt> count - 1 </tt>.
28115 * Count is the number of items, that can be get with
28116 * elm_segment_control_item_count_get().
28118 * @ingroup SegmentControl
28120 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28123 * Get the base object of the item.
28125 * @param it The segment control item.
28126 * @return The base object associated with @p it.
28128 * Base object is the @c Evas_Object that represents that item.
28130 * @ingroup SegmentControl
28132 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28135 * Get the selected item.
28137 * @param obj The segment control object.
28138 * @return The selected item or @c NULL if none of segment items is
28141 * The selected item can be unselected with function
28142 * elm_segment_control_item_selected_set().
28144 * The selected item always will be highlighted on segment control.
28146 * @ingroup SegmentControl
28148 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28151 * Set the selected state of an item.
28153 * @param it The segment control item
28154 * @param select The selected state
28156 * This sets the selected state of the given item @p it.
28157 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
28159 * If a new item is selected the previosly selected will be unselected.
28160 * Previoulsy selected item can be get with function
28161 * elm_segment_control_item_selected_get().
28163 * The selected item always will be highlighted on segment control.
28165 * @see elm_segment_control_item_selected_get()
28167 * @ingroup SegmentControl
28169 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
28176 * @defgroup Grid Grid
28178 * The grid is a grid layout widget that lays out a series of children as a
28179 * fixed "grid" of widgets using a given percentage of the grid width and
28180 * height each using the child object.
28182 * The Grid uses a "Virtual resolution" that is stretched to fill the grid
28183 * widgets size itself. The default is 100 x 100, so that means the
28184 * position and sizes of children will effectively be percentages (0 to 100)
28185 * of the width or height of the grid widget
28191 * Add a new grid to the parent
28193 * @param parent The parent object
28194 * @return The new object or NULL if it cannot be created
28198 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
28201 * Set the virtual size of the grid
28203 * @param obj The grid object
28204 * @param w The virtual width of the grid
28205 * @param h The virtual height of the grid
28209 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
28212 * Get the virtual size of the grid
28214 * @param obj The grid object
28215 * @param w Pointer to integer to store the virtual width of the grid
28216 * @param h Pointer to integer to store the virtual height of the grid
28220 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
28223 * Pack child at given position and size
28225 * @param obj The grid object
28226 * @param subobj The child to pack
28227 * @param x The virtual x coord at which to pack it
28228 * @param y The virtual y coord at which to pack it
28229 * @param w The virtual width at which to pack it
28230 * @param h The virtual height at which to pack it
28234 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
28237 * Unpack a child from a grid object
28239 * @param obj The grid object
28240 * @param subobj The child to unpack
28244 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
28247 * Faster way to remove all child objects from a grid object.
28249 * @param obj The grid object
28250 * @param clear If true, it will delete just removed children
28254 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
28257 * Set packing of an existing child at to position and size
28259 * @param subobj The child to set packing of
28260 * @param x The virtual x coord at which to pack it
28261 * @param y The virtual y coord at which to pack it
28262 * @param w The virtual width at which to pack it
28263 * @param h The virtual height at which to pack it
28267 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
28270 * get packing of a child
28272 * @param subobj The child to query
28273 * @param x Pointer to integer to store the virtual x coord
28274 * @param y Pointer to integer to store the virtual y coord
28275 * @param w Pointer to integer to store the virtual width
28276 * @param h Pointer to integer to store the virtual height
28280 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
28286 EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
28287 EINA_DEPRECATED EAPI void elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
28288 EINA_DEPRECATED EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
28289 EAPI void elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
28290 EAPI Eina_Bool elm_factory_maxmin_mode_get(const Evas_Object *obj);
28291 EAPI void elm_factory_maxmin_reset_set(Evas_Object *obj);
28294 * @defgroup Video Video
28296 * @addtogroup Video
28299 * Elementary comes with two object that help design application that need
28300 * to display video. The main one, Elm_Video, display a video by using Emotion.
28301 * It does embedded the video inside an Edje object, so you can do some
28302 * animation depending on the video state change. It does also implement a
28303 * ressource management policy to remove this burden from the application writer.
28305 * The second one, Elm_Player is a video player that need to be linked with and Elm_Video.
28306 * It take care of updating its content according to Emotion event and provide a
28307 * way to theme itself. It also does automatically raise the priority of the
28308 * linked Elm_Video so it will use the video decoder if available. It also does
28309 * activate the remember function on the linked Elm_Video object.
28311 * Signals that you can add callback for are :
28313 * "forward,clicked" - the user clicked the forward button.
28314 * "info,clicked" - the user clicked the info button.
28315 * "next,clicked" - the user clicked the next button.
28316 * "pause,clicked" - the user clicked the pause button.
28317 * "play,clicked" - the user clicked the play button.
28318 * "prev,clicked" - the user clicked the prev button.
28319 * "rewind,clicked" - the user clicked the rewind button.
28320 * "stop,clicked" - the user clicked the stop button.
28322 * Default contents parts of the player widget that you can use for are:
28323 * @li "video" - A video of the player
28328 * @brief Add a new Elm_Player object to the given parent Elementary (container) object.
28330 * @param parent The parent object
28331 * @return a new player widget handle or @c NULL, on errors.
28333 * This function inserts a new player widget on the canvas.
28335 * @see elm_object_part_content_set()
28339 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
28342 * @brief Link a Elm_Payer with an Elm_Video object.
28344 * @param player the Elm_Player object.
28345 * @param video The Elm_Video object.
28347 * This mean that action on the player widget will affect the
28348 * video object and the state of the video will be reflected in
28349 * the player itself.
28351 * @see elm_player_add()
28352 * @see elm_video_add()
28353 * @deprecated use elm_object_part_content_set() instead
28357 EINA_DEPRECATED EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
28360 * @brief Add a new Elm_Video object to the given parent Elementary (container) object.
28362 * @param parent The parent object
28363 * @return a new video widget handle or @c NULL, on errors.
28365 * This function inserts a new video widget on the canvas.
28367 * @seeelm_video_file_set()
28368 * @see elm_video_uri_set()
28372 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
28375 * @brief Define the file that will be the video source.
28377 * @param video The video object to define the file for.
28378 * @param filename The file to target.
28380 * This function will explicitly define a filename as a source
28381 * for the video of the Elm_Video object.
28383 * @see elm_video_uri_set()
28384 * @see elm_video_add()
28385 * @see elm_player_add()
28389 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
28392 * @brief Define the uri that will be the video source.
28394 * @param video The video object to define the file for.
28395 * @param uri The uri to target.
28397 * This function will define an uri as a source for the video of the
28398 * Elm_Video object. URI could be remote source of video, like http:// or local source
28399 * like for example WebCam who are most of the time v4l2:// (but that depend and
28400 * you should use Emotion API to request and list the available Webcam on your system).
28402 * @see elm_video_file_set()
28403 * @see elm_video_add()
28404 * @see elm_player_add()
28408 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
28411 * @brief Get the underlying Emotion object.
28413 * @param video The video object to proceed the request on.
28414 * @return the underlying Emotion object.
28418 EAPI Evas_Object *elm_video_emotion_get(const Evas_Object *video);
28421 * @brief Start to play the video
28423 * @param video The video object to proceed the request on.
28425 * Start to play the video and cancel all suspend state.
28429 EAPI void elm_video_play(Evas_Object *video);
28432 * @brief Pause the video
28434 * @param video The video object to proceed the request on.
28436 * Pause the video and start a timer to trigger suspend mode.
28440 EAPI void elm_video_pause(Evas_Object *video);
28443 * @brief Stop the video
28445 * @param video The video object to proceed the request on.
28447 * Stop the video and put the emotion in deep sleep mode.
28451 EAPI void elm_video_stop(Evas_Object *video);
28454 * @brief Is the video actually playing.
28456 * @param video The video object to proceed the request on.
28457 * @return EINA_TRUE if the video is actually playing.
28459 * You should consider watching event on the object instead of polling
28460 * the object state.
28464 EAPI Eina_Bool elm_video_is_playing(const Evas_Object *video);
28467 * @brief Is it possible to seek inside the video.
28469 * @param video The video object to proceed the request on.
28470 * @return EINA_TRUE if is possible to seek inside the video.
28474 EAPI Eina_Bool elm_video_is_seekable(const Evas_Object *video);
28477 * @brief Is the audio muted.
28479 * @param video The video object to proceed the request on.
28480 * @return EINA_TRUE if the audio is muted.
28484 EAPI Eina_Bool elm_video_audio_mute_get(const Evas_Object *video);
28487 * @brief Change the mute state of the Elm_Video object.
28489 * @param video The video object to proceed the request on.
28490 * @param mute The new mute state.
28494 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
28497 * @brief Get the audio level of the current video.
28499 * @param video The video object to proceed the request on.
28500 * @return the current audio level.
28504 EAPI double elm_video_audio_level_get(const Evas_Object *video);
28507 * @brief Set the audio level of anElm_Video object.
28509 * @param video The video object to proceed the request on.
28510 * @param volume The new audio volume.
28514 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
28516 EAPI double elm_video_play_position_get(const Evas_Object *video);
28517 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
28518 EAPI double elm_video_play_length_get(const Evas_Object *video);
28519 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
28520 EAPI Eina_Bool elm_video_remember_position_get(const Evas_Object *video);
28521 EAPI const char *elm_video_title_get(const Evas_Object *video);
28527 * @defgroup Naviframe Naviframe
28528 * @ingroup Elementary
28530 * @brief Naviframe is a kind of view manager for the applications.
28532 * Naviframe provides functions to switch different pages with stack
28533 * mechanism. It means if one page(item) needs to be changed to the new one,
28534 * then naviframe would push the new page to it's internal stack. Of course,
28535 * it can be back to the previous page by popping the top page. Naviframe
28536 * provides some transition effect while the pages are switching (same as
28539 * Since each item could keep the different styles, users could keep the
28540 * same look & feel for the pages or different styles for the items in it's
28543 * Signals that you can add callback for are:
28544 * @li "transition,finished" - When the transition is finished in changing
28546 * @li "title,clicked" - User clicked title area
28548 * Default contents parts of the naviframe items that you can use for are:
28549 * @li "default" - A main content of the page
28550 * @li "icon" - A icon in the title area
28551 * @li "prev_btn" - A button to go to the previous page
28552 * @li "next_btn" - A button to go to the next page
28554 * Default text parts of the naviframe items that you can use for are:
28555 * @li "default" - Title label in the title area
28556 * @li "subtitle" - Sub-title label in the title area
28558 * @ref tutorial_naviframe gives a good overview of the usage of the API.
28562 * @addtogroup Naviframe
28567 * @brief Add a new Naviframe object to the parent.
28569 * @param parent Parent object
28570 * @return New object or @c NULL, if it cannot be created
28572 * @ingroup Naviframe
28574 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28576 * @brief Push a new item to the top of the naviframe stack (and show it).
28578 * @param obj The naviframe object
28579 * @param title_label The label in the title area. The name of the title
28580 * label part is "elm.text.title"
28581 * @param prev_btn The button to go to the previous item. If it is NULL,
28582 * then naviframe will create a back button automatically. The name of
28583 * the prev_btn part is "elm.swallow.prev_btn"
28584 * @param next_btn The button to go to the next item. Or It could be just an
28585 * extra function button. The name of the next_btn part is
28586 * "elm.swallow.next_btn"
28587 * @param content The main content object. The name of content part is
28588 * "elm.swallow.content"
28589 * @param item_style The current item style name. @c NULL would be default.
28590 * @return The created item or @c NULL upon failure.
28592 * The item pushed becomes one page of the naviframe, this item will be
28593 * deleted when it is popped.
28595 * @see also elm_naviframe_item_style_set()
28596 * @see also elm_naviframe_item_insert_before()
28597 * @see also elm_naviframe_item_insert_after()
28599 * The following styles are available for this item:
28602 * @ingroup Naviframe
28604 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);
28606 * @brief Insert a new item into the naviframe before item @p before.
28608 * @param before The naviframe item to insert before.
28609 * @param title_label The label in the title area. The name of the title
28610 * label part is "elm.text.title"
28611 * @param prev_btn The button to go to the previous item. If it is NULL,
28612 * then naviframe will create a back button automatically. The name of
28613 * the prev_btn part is "elm.swallow.prev_btn"
28614 * @param next_btn The button to go to the next item. Or It could be just an
28615 * extra function button. The name of the next_btn part is
28616 * "elm.swallow.next_btn"
28617 * @param content The main content object. The name of content part is
28618 * "elm.swallow.content"
28619 * @param item_style The current item style name. @c NULL would be default.
28620 * @return The created item or @c NULL upon failure.
28622 * The item is inserted into the naviframe straight away without any
28623 * transition operations. This item will be deleted when it is popped.
28625 * @see also elm_naviframe_item_style_set()
28626 * @see also elm_naviframe_item_push()
28627 * @see also elm_naviframe_item_insert_after()
28629 * The following styles are available for this item:
28632 * @ingroup Naviframe
28634 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);
28636 * @brief Insert a new item into the naviframe after item @p after.
28638 * @param after The naviframe item to insert after.
28639 * @param title_label The label in the title area. The name of the title
28640 * label part is "elm.text.title"
28641 * @param prev_btn The button to go to the previous item. If it is NULL,
28642 * then naviframe will create a back button automatically. The name of
28643 * the prev_btn part is "elm.swallow.prev_btn"
28644 * @param next_btn The button to go to the next item. Or It could be just an
28645 * extra function button. The name of the next_btn part is
28646 * "elm.swallow.next_btn"
28647 * @param content The main content object. The name of content part is
28648 * "elm.swallow.content"
28649 * @param item_style The current item style name. @c NULL would be default.
28650 * @return The created item or @c NULL upon failure.
28652 * The item is inserted into the naviframe straight away without any
28653 * transition operations. This item will be deleted when it is popped.
28655 * @see also elm_naviframe_item_style_set()
28656 * @see also elm_naviframe_item_push()
28657 * @see also elm_naviframe_item_insert_before()
28659 * The following styles are available for this item:
28662 * @ingroup Naviframe
28664 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);
28666 * @brief Pop an item that is on top of the stack
28668 * @param obj The naviframe object
28669 * @return @c NULL or the content object(if the
28670 * elm_naviframe_content_preserve_on_pop_get is true).
28672 * This pops an item that is on the top(visible) of the naviframe, makes it
28673 * disappear, then deletes the item. The item that was underneath it on the
28674 * stack will become visible.
28676 * @see also elm_naviframe_content_preserve_on_pop_get()
28678 * @ingroup Naviframe
28680 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
28682 * @brief Pop the items between the top and the above one on the given item.
28684 * @param it The naviframe item
28686 * @ingroup Naviframe
28688 EAPI void elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28690 * Promote an item already in the naviframe stack to the top of the stack
28692 * @param it The naviframe item
28694 * This will take the indicated item and promote it to the top of the stack
28695 * as if it had been pushed there. The item must already be inside the
28696 * naviframe stack to work.
28699 EAPI void elm_naviframe_item_promote(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28701 * @brief Delete the given item instantly.
28703 * @param it The naviframe item
28705 * This just deletes the given item from the naviframe item list instantly.
28706 * So this would not emit any signals for view transitions but just change
28707 * the current view if the given item is a top one.
28709 * @ingroup Naviframe
28711 EAPI void elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28713 * @brief preserve the content objects when items are popped.
28715 * @param obj The naviframe object
28716 * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
28718 * @see also elm_naviframe_content_preserve_on_pop_get()
28720 * @ingroup Naviframe
28722 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
28724 * @brief Get a value whether preserve mode is enabled or not.
28726 * @param obj The naviframe object
28727 * @return If @c EINA_TRUE, preserve mode is enabled
28729 * @see also elm_naviframe_content_preserve_on_pop_set()
28731 * @ingroup Naviframe
28733 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28735 * @brief Get a top item on the naviframe stack
28737 * @param obj The naviframe object
28738 * @return The top item on the naviframe stack or @c NULL, if the stack is
28741 * @ingroup Naviframe
28743 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28745 * @brief Get a bottom item on the naviframe stack
28747 * @param obj The naviframe object
28748 * @return The bottom item on the naviframe stack or @c NULL, if the stack is
28751 * @ingroup Naviframe
28753 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28755 * @brief Set an item style
28757 * @param obj The naviframe item
28758 * @param item_style The current item style name. @c NULL would be default
28760 * The following styles are available for this item:
28763 * @see also elm_naviframe_item_style_get()
28765 * @ingroup Naviframe
28767 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
28769 * @brief Get an item style
28771 * @param obj The naviframe item
28772 * @return The current item style name
28774 * @see also elm_naviframe_item_style_set()
28776 * @ingroup Naviframe
28778 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28780 * @brief Show/Hide the title area
28782 * @param it The naviframe item
28783 * @param visible If @c EINA_TRUE, title area will be visible, hidden
28786 * When the title area is invisible, then the controls would be hidden so as * to expand the content area to full-size.
28788 * @see also elm_naviframe_item_title_visible_get()
28790 * @ingroup Naviframe
28792 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
28794 * @brief Get a value whether title area is visible or not.
28796 * @param it The naviframe item
28797 * @return If @c EINA_TRUE, title area is visible
28799 * @see also elm_naviframe_item_title_visible_set()
28801 * @ingroup Naviframe
28803 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28806 * @brief Set creating prev button automatically or not
28808 * @param obj The naviframe object
28809 * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
28810 * be created internally when you pass the @c NULL to the prev_btn
28811 * parameter in elm_naviframe_item_push
28813 * @see also elm_naviframe_item_push()
28815 EAPI void elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
28817 * @brief Get a value whether prev button(back button) will be auto pushed or
28820 * @param obj The naviframe object
28821 * @return If @c EINA_TRUE, prev button will be auto pushed.
28823 * @see also elm_naviframe_item_push()
28824 * elm_naviframe_prev_btn_auto_pushed_set()
28826 EAPI Eina_Bool elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28828 * @brief Get a list of all the naviframe items.
28830 * @param obj The naviframe object
28831 * @return An Eina_Inlist* of naviframe items, #Elm_Object_Item,
28832 * or @c NULL on failure.
28834 EAPI Eina_Inlist *elm_naviframe_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);